Taint: fix ACL "spam" condition, to permit tainted name arguments
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.94"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2020
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part_prefix_v$&"
1403 .vindex "&$local_part$&"
1404 .vindex "&$local_part_suffix$&"
1405 .vindex "&$local_part_suffix_v$&"
1406 .cindex affix "router precondition"
1407 If the &%local_parts%& option is set, the local part of the address must be in
1408 the set of local parts that it defines. If &%local_part_prefix%& or
1409 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1410 part before this check. If you want to do precondition tests on local parts
1411 that include affixes, you can do so by using a &%condition%& option (see below)
1412 that uses the variables &$local_part$&, &$local_part_prefix$&,
1413 &$local_part_prefix_v$&, &$local_part_suffix$&
1414 and &$local_part_suffix_v$& as necessary.
1415 .next
1416 .vindex "&$local_user_uid$&"
1417 .vindex "&$local_user_gid$&"
1418 .vindex "&$home$&"
1419 If the &%check_local_user%& option is set, the local part must be the name of
1420 an account on the local host. If this check succeeds, the uid and gid of the
1421 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1422 user's home directory is placed in &$home$&; these values can be used in the
1423 remaining preconditions.
1424 .next
1425 If the &%router_home_directory%& option is set, it is expanded at this point,
1426 because it overrides the value of &$home$&. If this expansion were left till
1427 later, the value of &$home$& as set by &%check_local_user%& would be used in
1428 subsequent tests. Having two different values of &$home$& in the same router
1429 could lead to confusion.
1430 .next
1431 If the &%senders%& option is set, the envelope sender address must be in the
1432 set of addresses that it defines.
1433 .next
1434 If the &%require_files%& option is set, the existence or non-existence of
1435 specified files is tested.
1436 .next
1437 .cindex "customizing" "precondition"
1438 If the &%condition%& option is set, it is evaluated and tested. This option
1439 uses an expanded string to allow you to set up your own custom preconditions.
1440 Expanded strings are described in chapter &<<CHAPexpand>>&.
1441 .endlist
1442
1443
1444 Note that &%require_files%& comes near the end of the list, so you cannot use
1445 it to check for the existence of a file in which to lookup up a domain, local
1446 part, or sender. However, as these options are all expanded, you can use the
1447 &%exists%& expansion condition to make such tests within each condition. The
1448 &%require_files%& option is intended for checking files that the router may be
1449 going to use internally, or which are needed by a specific transport (for
1450 example, &_.procmailrc_&).
1451
1452
1453
1454 .section "Delivery in detail" "SECID18"
1455 .cindex "delivery" "in detail"
1456 When a message is to be delivered, the sequence of events is as follows:
1457
1458 .ilist
1459 If a system-wide filter file is specified, the message is passed to it. The
1460 filter may add recipients to the message, replace the recipients, discard the
1461 message, cause a new message to be generated, or cause the message delivery to
1462 fail. The format of the system filter file is the same as for Exim user filter
1463 files, described in the separate document entitled &'Exim's interfaces to mail
1464 filtering'&.
1465 .cindex "Sieve filter" "not available for system filter"
1466 (&*Note*&: Sieve cannot be used for system filter files.)
1467
1468 Some additional features are available in system filters &-- see chapter
1469 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1470 filter only once per delivery attempt, however many recipients it has. However,
1471 if there are several delivery attempts because one or more addresses could not
1472 be immediately delivered, the system filter is run each time. The filter
1473 condition &%first_delivery%& can be used to detect the first run of the system
1474 filter.
1475 .next
1476 Each recipient address is offered to each configured router, in turn, subject to
1477 its preconditions, until one is able to handle it. If no router can handle the
1478 address, that is, if they all decline, the address is failed. Because routers
1479 can be targeted at particular domains, several locally handled domains can be
1480 processed entirely independently of each other.
1481 .next
1482 .cindex "routing" "loops in"
1483 .cindex "loop" "while routing"
1484 A router that accepts an address may assign it to a local or a remote
1485 transport. However, the transport is not run at this time. Instead, the address
1486 is placed on a list for the particular transport, which will be run later.
1487 Alternatively, the router may generate one or more new addresses (typically
1488 from alias, forward, or filter files). New addresses are fed back into this
1489 process from the top, but in order to avoid loops, a router ignores any address
1490 which has an identically-named ancestor that was processed by itself.
1491 .next
1492 When all the routing has been done, addresses that have been successfully
1493 handled are passed to their assigned transports. When local transports are
1494 doing real local deliveries, they handle only one address at a time, but if a
1495 local transport is being used as a pseudo-remote transport (for example, to
1496 collect batched SMTP messages for transmission by some other means) multiple
1497 addresses can be handled. Remote transports can always handle more than one
1498 address at a time, but can be configured not to do so, or to restrict multiple
1499 addresses to the same domain.
1500 .next
1501 Each local delivery to a file or a pipe runs in a separate process under a
1502 non-privileged uid, and these deliveries are run one at a time. Remote
1503 deliveries also run in separate processes, normally under a uid that is private
1504 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1505 run in parallel. The maximum number of simultaneous remote deliveries for any
1506 one message is set by the &%remote_max_parallel%& option.
1507 The order in which deliveries are done is not defined, except that all local
1508 deliveries happen before any remote deliveries.
1509 .next
1510 .cindex "queue runner"
1511 When it encounters a local delivery during a queue run, Exim checks its retry
1512 database to see if there has been a previous temporary delivery failure for the
1513 address before running the local transport. If there was a previous failure,
1514 Exim does not attempt a new delivery until the retry time for the address is
1515 reached. However, this happens only for delivery attempts that are part of a
1516 queue run. Local deliveries are always attempted when delivery immediately
1517 follows message reception, even if retry times are set for them. This makes for
1518 better behaviour if one particular message is causing problems (for example,
1519 causing quota overflow, or provoking an error in a filter file).
1520 .next
1521 .cindex "delivery" "retry in remote transports"
1522 Remote transports do their own retry handling, since an address may be
1523 deliverable to one of a number of hosts, each of which may have a different
1524 retry time. If there have been previous temporary failures and no host has
1525 reached its retry time, no delivery is attempted, whether in a queue run or
1526 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1527 .next
1528 If there were any permanent errors, a bounce message is returned to an
1529 appropriate address (the sender in the common case), with details of the error
1530 for each failing address. Exim can be configured to send copies of bounce
1531 messages to other addresses.
1532 .next
1533 .cindex "delivery" "deferral"
1534 If one or more addresses suffered a temporary failure, the message is left on
1535 the queue, to be tried again later. Delivery of these addresses is said to be
1536 &'deferred'&.
1537 .next
1538 When all the recipient addresses have either been delivered or bounced,
1539 handling of the message is complete. The spool files and message log are
1540 deleted, though the message log can optionally be preserved if required.
1541 .endlist
1542
1543
1544
1545
1546 .section "Retry mechanism" "SECID19"
1547 .cindex "delivery" "retry mechanism"
1548 .cindex "retry" "description of mechanism"
1549 .cindex "queue runner"
1550 Exim's mechanism for retrying messages that fail to get delivered at the first
1551 attempt is the queue runner process. You must either run an Exim daemon that
1552 uses the &%-q%& option with a time interval to start queue runners at regular
1553 intervals or use some other means (such as &'cron'&) to start them. If you do
1554 not arrange for queue runners to be run, messages that fail temporarily at the
1555 first attempt will remain in your queue forever. A queue runner process works
1556 its way through the queue, one message at a time, trying each delivery that has
1557 passed its retry time.
1558 You can run several queue runners at once.
1559
1560 Exim uses a set of configured rules to determine when next to retry the failing
1561 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1562 should give up trying to deliver to the address, at which point it generates a
1563 bounce message. If no retry rules are set for a particular host, address, and
1564 error combination, no retries are attempted, and temporary errors are treated
1565 as permanent.
1566
1567
1568
1569 .section "Temporary delivery failure" "SECID20"
1570 .cindex "delivery" "temporary failure"
1571 There are many reasons why a message may not be immediately deliverable to a
1572 particular address. Failure to connect to a remote machine (because it, or the
1573 connection to it, is down) is one of the most common. Temporary failures may be
1574 detected during routing as well as during the transport stage of delivery.
1575 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1576 is on a file system where the user is over quota. Exim can be configured to
1577 impose its own quotas on local mailboxes; where system quotas are set they will
1578 also apply.
1579
1580 If a host is unreachable for a period of time, a number of messages may be
1581 waiting for it by the time it recovers, and sending them in a single SMTP
1582 connection is clearly beneficial. Whenever a delivery to a remote host is
1583 deferred,
1584 .cindex "hints database" "deferred deliveries"
1585 Exim makes a note in its hints database, and whenever a successful
1586 SMTP delivery has happened, it looks to see if any other messages are waiting
1587 for the same host. If any are found, they are sent over the same SMTP
1588 connection, subject to a configuration limit as to the maximum number in any
1589 one connection.
1590
1591
1592
1593 .section "Permanent delivery failure" "SECID21"
1594 .cindex "delivery" "permanent failure"
1595 .cindex "bounce message" "when generated"
1596 When a message cannot be delivered to some or all of its intended recipients, a
1597 bounce message is generated. Temporary delivery failures turn into permanent
1598 errors when their timeout expires. All the addresses that fail in a given
1599 delivery attempt are listed in a single message. If the original message has
1600 many recipients, it is possible for some addresses to fail in one delivery
1601 attempt and others to fail subsequently, giving rise to more than one bounce
1602 message. The wording of bounce messages can be customized by the administrator.
1603 See chapter &<<CHAPemsgcust>>& for details.
1604
1605 .cindex "&'X-Failed-Recipients:'& header line"
1606 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1607 failed addresses, for the benefit of programs that try to analyse such messages
1608 automatically.
1609
1610 .cindex "bounce message" "recipient of"
1611 A bounce message is normally sent to the sender of the original message, as
1612 obtained from the message's envelope. For incoming SMTP messages, this is the
1613 address given in the MAIL command. However, when an address is expanded via a
1614 forward or alias file, an alternative address can be specified for delivery
1615 failures of the generated addresses. For a mailing list expansion (see section
1616 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1617 of the list.
1618
1619
1620
1621 .section "Failures to deliver bounce messages" "SECID22"
1622 .cindex "bounce message" "failure to deliver"
1623 If a bounce message (either locally generated or received from a remote host)
1624 itself suffers a permanent delivery failure, the message is left in the queue,
1625 but it is frozen, awaiting the attention of an administrator. There are options
1626 that can be used to make Exim discard such failed messages, or to keep them
1627 for only a short time (see &%timeout_frozen_after%& and
1628 &%ignore_bounce_errors_after%&).
1629
1630
1631
1632
1633
1634 . ////////////////////////////////////////////////////////////////////////////
1635 . ////////////////////////////////////////////////////////////////////////////
1636
1637 .chapter "Building and installing Exim" "CHID3"
1638 .scindex IIDbuex "building Exim"
1639
1640 .section "Unpacking" "SECID23"
1641 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1642 creates a directory with the name of the current release (for example,
1643 &_exim-&version()_&) into which the following files are placed:
1644
1645 .table2 140pt
1646 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1647 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1648   documented"
1649 .irow &_LICENCE_&         "the GNU General Public Licence"
1650 .irow &_Makefile_&        "top-level make file"
1651 .irow &_NOTICE_&          "conditions for the use of Exim"
1652 .irow &_README_&          "list of files, directories and simple build &&&
1653   instructions"
1654 .endtable
1655
1656 Other files whose names begin with &_README_& may also be present. The
1657 following subdirectories are created:
1658
1659 .table2 140pt
1660 .irow &_Local_&           "an empty directory for local configuration files"
1661 .irow &_OS_&              "OS-specific files"
1662 .irow &_doc_&             "documentation files"
1663 .irow &_exim_monitor_&    "source files for the Exim monitor"
1664 .irow &_scripts_&         "scripts used in the build process"
1665 .irow &_src_&             "remaining source files"
1666 .irow &_util_&            "independent utilities"
1667 .endtable
1668
1669 The main utility programs are contained in the &_src_& directory and are built
1670 with the Exim binary. The &_util_& directory contains a few optional scripts
1671 that may be useful to some sites.
1672
1673
1674 .section "Multiple machine architectures and operating systems" "SECID24"
1675 .cindex "building Exim" "multiple OS/architectures"
1676 The building process for Exim is arranged to make it easy to build binaries for
1677 a number of different architectures and operating systems from the same set of
1678 source files. Compilation does not take place in the &_src_& directory.
1679 Instead, a &'build directory'& is created for each architecture and operating
1680 system.
1681 .cindex "symbolic link" "to build directory"
1682 Symbolic links to the sources are installed in this directory, which is where
1683 the actual building takes place. In most cases, Exim can discover the machine
1684 architecture and operating system for itself, but the defaults can be
1685 overridden if necessary.
1686 .cindex compiler requirements
1687 .cindex compiler version
1688 A C99-capable compiler will be required for the build.
1689
1690
1691 .section "PCRE library" "SECTpcre"
1692 .cindex "PCRE library"
1693 Exim no longer has an embedded PCRE library as the vast majority of
1694 modern systems include PCRE as a system library, although you may need to
1695 install the PCRE package or the PCRE development package for your operating
1696 system. If your system has a normal PCRE installation the Exim build
1697 process will need no further configuration. If the library or the
1698 headers are in an unusual location you will need to either set the PCRE_LIBS
1699 and INCLUDE directives appropriately,
1700 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1701 If your operating system has no
1702 PCRE support then you will need to obtain and build the current PCRE
1703 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1704 More information on PCRE is available at &url(https://www.pcre.org/).
1705
1706 .section "DBM libraries" "SECTdb"
1707 .cindex "DBM libraries" "discussion of"
1708 .cindex "hints database" "DBM files used for"
1709 Even if you do not use any DBM files in your configuration, Exim still needs a
1710 DBM library in order to operate, because it uses indexed files for its hints
1711 databases. Unfortunately, there are a number of DBM libraries in existence, and
1712 different operating systems often have different ones installed.
1713
1714 .cindex "Solaris" "DBM library for"
1715 .cindex "IRIX, DBM library for"
1716 .cindex "BSD, DBM library for"
1717 .cindex "Linux, DBM library for"
1718 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1719 Linux distribution, the DBM configuration should happen automatically, and you
1720 may be able to ignore this section. Otherwise, you may have to learn more than
1721 you would like about DBM libraries from what follows.
1722
1723 .cindex "&'ndbm'& DBM library"
1724 Licensed versions of Unix normally contain a library of DBM functions operating
1725 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1726 versions of Unix seem to vary in what they contain as standard. In particular,
1727 some early versions of Linux have no default DBM library, and different
1728 distributors have chosen to bundle different libraries with their packaged
1729 versions. However, the more recent releases seem to have standardized on the
1730 Berkeley DB library.
1731
1732 Different DBM libraries have different conventions for naming the files they
1733 use. When a program opens a file called &_dbmfile_&, there are several
1734 possibilities:
1735
1736 .olist
1737 A traditional &'ndbm'& implementation, such as that supplied as part of
1738 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1739 .next
1740 .cindex "&'gdbm'& DBM library"
1741 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1742 compatibility interface it makes two different hard links to it with names
1743 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1744 filename is used unmodified.
1745 .next
1746 .cindex "Berkeley DB library"
1747 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1748 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1749 programmer exactly the same as the traditional &'ndbm'& implementation.
1750 .next
1751 If the Berkeley package is used in its native mode, it operates on a single
1752 file called &_dbmfile_&; the programmer's interface is somewhat different to
1753 the traditional &'ndbm'& interface.
1754 .next
1755 To complicate things further, there are several very different versions of the
1756 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1757 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1758 Maintenance of some of the earlier releases has ceased. All versions of
1759 Berkeley DB could be obtained from
1760 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1761 page with far newer versions listed.
1762 It is probably wise to plan to move your storage configurations away from
1763 Berkeley DB format, as today there are smaller and simpler alternatives more
1764 suited to Exim's usage model.
1765 .next
1766 .cindex "&'tdb'& DBM library"
1767 Yet another DBM library, called &'tdb'&, is available from
1768 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1769 operates on a single file.
1770 .endlist
1771
1772 .cindex "USE_DB"
1773 .cindex "DBM libraries" "configuration for building"
1774 Exim and its utilities can be compiled to use any of these interfaces. In order
1775 to use any version of the Berkeley DB package in native mode, you must set
1776 USE_DB in an appropriate configuration file (typically
1777 &_Local/Makefile_&). For example:
1778 .code
1779 USE_DB=yes
1780 .endd
1781 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1782 error is diagnosed if you set more than one of these.
1783
1784 At the lowest level, the build-time configuration sets none of these options,
1785 thereby assuming an interface of type (1). However, some operating system
1786 configuration files (for example, those for the BSD operating systems and
1787 Linux) assume type (4) by setting USE_DB as their default, and the
1788 configuration files for Cygwin set USE_GDBM. Anything you set in
1789 &_Local/Makefile_&, however, overrides these system defaults.
1790
1791 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1792 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1793 in one of these lines:
1794 .code
1795 DBMLIB = -ldb
1796 DBMLIB = -ltdb
1797 .endd
1798 Settings like that will work if the DBM library is installed in the standard
1799 place. Sometimes it is not, and the library's header file may also not be in
1800 the default path. You may need to set INCLUDE to specify where the header
1801 file is, and to specify the path to the library more fully in DBMLIB, as in
1802 this example:
1803 .code
1804 INCLUDE=-I/usr/local/include/db-4.1
1805 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1806 .endd
1807 There is further detailed discussion about the various DBM libraries in the
1808 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1809
1810
1811
1812 .section "Pre-building configuration" "SECID25"
1813 .cindex "building Exim" "pre-building configuration"
1814 .cindex "configuration for building Exim"
1815 .cindex "&_Local/Makefile_&"
1816 .cindex "&_src/EDITME_&"
1817 Before building Exim, a local configuration file that specifies options
1818 independent of any operating system has to be created with the name
1819 &_Local/Makefile_&. A template for this file is supplied as the file
1820 &_src/EDITME_&, and it contains full descriptions of all the option settings
1821 therein. These descriptions are therefore not repeated here. If you are
1822 building Exim for the first time, the simplest thing to do is to copy
1823 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1824
1825 There are three settings that you must supply, because Exim will not build
1826 without them. They are the location of the runtime configuration file
1827 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1828 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1829 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1830 a colon-separated list of filenames; Exim uses the first of them that exists.
1831
1832 There are a few other parameters that can be specified either at build time or
1833 at runtime, to enable the same binary to be used on a number of different
1834 machines. However, if the locations of Exim's spool directory and log file
1835 directory (if not within the spool directory) are fixed, it is recommended that
1836 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1837 detected early in Exim's execution (such as a malformed configuration file) can
1838 be logged.
1839
1840 .cindex "content scanning" "specifying at build time"
1841 Exim's interfaces for calling virus and spam scanning software directly from
1842 access control lists are not compiled by default. If you want to include these
1843 facilities, you need to set
1844 .code
1845 WITH_CONTENT_SCAN=yes
1846 .endd
1847 in your &_Local/Makefile_&. For details of the facilities themselves, see
1848 chapter &<<CHAPexiscan>>&.
1849
1850
1851 .cindex "&_Local/eximon.conf_&"
1852 .cindex "&_exim_monitor/EDITME_&"
1853 If you are going to build the Exim monitor, a similar configuration process is
1854 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1855 your installation and saved under the name &_Local/eximon.conf_&. If you are
1856 happy with the default settings described in &_exim_monitor/EDITME_&,
1857 &_Local/eximon.conf_& can be empty, but it must exist.
1858
1859 This is all the configuration that is needed in straightforward cases for known
1860 operating systems. However, the building process is set up so that it is easy
1861 to override options that are set by default or by operating-system-specific
1862 configuration files, for example, to change the C compiler, which
1863 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1864 do this.
1865
1866
1867
1868 .section "Support for iconv()" "SECID26"
1869 .cindex "&[iconv()]& support"
1870 .cindex "RFC 2047"
1871 The contents of header lines in messages may be encoded according to the rules
1872 described RFC 2047. This makes it possible to transmit characters that are not
1873 in the ASCII character set, and to label them as being in a particular
1874 character set. When Exim is inspecting header lines by means of the &%$h_%&
1875 mechanism, it decodes them, and translates them into a specified character set
1876 (default is set at build time). The translation is possible only if the operating system
1877 supports the &[iconv()]& function.
1878
1879 However, some of the operating systems that supply &[iconv()]& do not support
1880 very many conversions. The GNU &%libiconv%& library (available from
1881 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1882 systems to remedy this deficiency, as well as on systems that do not supply
1883 &[iconv()]& at all. After installing &%libiconv%&, you should add
1884 .code
1885 HAVE_ICONV=yes
1886 .endd
1887 to your &_Local/Makefile_& and rebuild Exim.
1888
1889
1890
1891 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1892 .cindex "TLS" "including support for TLS"
1893 .cindex "encryption" "including support for"
1894 .cindex "OpenSSL" "building Exim with"
1895 .cindex "GnuTLS" "building Exim with"
1896 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1897 command as per RFC 2487. It can also support clients that expect to
1898 start a TLS session immediately on connection to a non-standard port (see the
1899 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1900 line option).
1901
1902 If you want to build Exim with TLS support, you must first install either the
1903 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1904 implementing SSL.
1905
1906 If you do not want TLS support you should set
1907 .code
1908 DISABLE_TLS=yes
1909 .endd
1910 in &_Local/Makefile_&.
1911
1912 If OpenSSL is installed, you should set
1913 .code
1914 USE_OPENSL=yes
1915 TLS_LIBS=-lssl -lcrypto
1916 .endd
1917 in &_Local/Makefile_&. You may also need to specify the locations of the
1918 OpenSSL library and include files. For example:
1919 .code
1920 USE_OPENSSL=yes
1921 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1922 TLS_INCLUDE=-I/usr/local/openssl/include/
1923 .endd
1924 .cindex "pkg-config" "OpenSSL"
1925 If you have &'pkg-config'& available, then instead you can just use:
1926 .code
1927 USE_OPENSSL=yes
1928 USE_OPENSSL_PC=openssl
1929 .endd
1930 .cindex "USE_GNUTLS"
1931 If GnuTLS is installed, you should set
1932 .code
1933 USE_GNUTLS=yes
1934 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1935 .endd
1936 in &_Local/Makefile_&, and again you may need to specify the locations of the
1937 library and include files. For example:
1938 .code
1939 USE_GNUTLS=yes
1940 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1941 TLS_INCLUDE=-I/usr/gnu/include
1942 .endd
1943 .cindex "pkg-config" "GnuTLS"
1944 If you have &'pkg-config'& available, then instead you can just use:
1945 .code
1946 USE_GNUTLS=yes
1947 USE_GNUTLS_PC=gnutls
1948 .endd
1949
1950 You do not need to set TLS_INCLUDE if the relevant directory is already
1951 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1952 given in chapter &<<CHAPTLS>>&.
1953
1954
1955
1956
1957 .section "Use of tcpwrappers" "SECID27"
1958
1959 .cindex "tcpwrappers, building Exim to support"
1960 .cindex "USE_TCP_WRAPPERS"
1961 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1962 .cindex "tcp_wrappers_daemon_name"
1963 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1964 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1965 alternative to Exim's own checking facilities for installations that are
1966 already making use of &'tcpwrappers'& for other purposes. To do this, you
1967 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1968 &_tcpd.h_& to be available at compile time, and also ensure that the library
1969 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1970 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1971 you might have
1972 .code
1973 USE_TCP_WRAPPERS=yes
1974 CFLAGS=-O -I/usr/local/include
1975 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1976 .endd
1977 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1978 files is &"exim"&. For example, the line
1979 .code
1980 exim : LOCAL  192.168.1.  .friendly.domain.example
1981 .endd
1982 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1983 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1984 All other connections are denied. The daemon name used by &'tcpwrappers'&
1985 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1986 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1987 configure file. Consult the &'tcpwrappers'& documentation for
1988 further details.
1989
1990
1991 .section "Including support for IPv6" "SECID28"
1992 .cindex "IPv6" "including support for"
1993 Exim contains code for use on systems that have IPv6 support. Setting
1994 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1995 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1996 where the IPv6 support is not fully integrated into the normal include and
1997 library files.
1998
1999 Two different types of DNS record for handling IPv6 addresses have been
2000 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2001 currently seen as the mainstream. Another record type called A6 was proposed
2002 as better than AAAA because it had more flexibility. However, it was felt to be
2003 over-complex, and its status was reduced to &"experimental"&.
2004 Exim used to
2005 have a compile option for including A6 record support but this has now been
2006 withdrawn.
2007
2008
2009
2010 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2011 .cindex "lookup modules"
2012 .cindex "dynamic modules"
2013 .cindex ".so building"
2014 On some platforms, Exim supports not compiling all lookup types directly into
2015 the main binary, instead putting some into external modules which can be loaded
2016 on demand.
2017 This permits packagers to build Exim with support for lookups with extensive
2018 library dependencies without requiring all users to install all of those
2019 dependencies.
2020 Most, but not all, lookup types can be built this way.
2021
2022 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2023 installed; Exim will only load modules from that directory, as a security
2024 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2025 for your OS; see &_OS/Makefile-Linux_& for an example.
2026 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2027 see &_src/EDITME_& for details.
2028
2029 Then, for each module to be loaded dynamically, define the relevant
2030 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2031 For example, this will build in lsearch but load sqlite and mysql support
2032 on demand:
2033 .code
2034 LOOKUP_LSEARCH=yes
2035 LOOKUP_SQLITE=2
2036 LOOKUP_MYSQL=2
2037 .endd
2038
2039
2040 .section "The building process" "SECID29"
2041 .cindex "build directory"
2042 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2043 created, run &'make'& at the top level. It determines the architecture and
2044 operating system types, and creates a build directory if one does not exist.
2045 For example, on a Sun system running Solaris 8, the directory
2046 &_build-SunOS5-5.8-sparc_& is created.
2047 .cindex "symbolic link" "to source files"
2048 Symbolic links to relevant source files are installed in the build directory.
2049
2050 If this is the first time &'make'& has been run, it calls a script that builds
2051 a make file inside the build directory, using the configuration files from the
2052 &_Local_& directory. The new make file is then passed to another instance of
2053 &'make'&. This does the real work, building a number of utility scripts, and
2054 then compiling and linking the binaries for the Exim monitor (if configured), a
2055 number of utility programs, and finally Exim itself. The command &`make
2056 makefile`& can be used to force a rebuild of the make file in the build
2057 directory, should this ever be necessary.
2058
2059 If you have problems building Exim, check for any comments there may be in the
2060 &_README_& file concerning your operating system, and also take a look at the
2061 FAQ, where some common problems are covered.
2062
2063
2064
2065 .section 'Output from &"make"&' "SECID283"
2066 The output produced by the &'make'& process for compile lines is often very
2067 unreadable, because these lines can be very long. For this reason, the normal
2068 output is suppressed by default, and instead output similar to that which
2069 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2070 each module that is being compiled or linked. However, it is still possible to
2071 get the full output, by calling &'make'& like this:
2072 .code
2073 FULLECHO='' make -e
2074 .endd
2075 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2076 command reflection in &'make'&. When you ask for the full output, it is
2077 given in addition to the short output.
2078
2079
2080
2081 .section "Overriding build-time options for Exim" "SECToverride"
2082 .cindex "build-time options, overriding"
2083 The main make file that is created at the beginning of the building process
2084 consists of the concatenation of a number of files which set configuration
2085 values, followed by a fixed set of &'make'& instructions. If a value is set
2086 more than once, the last setting overrides any previous ones. This provides a
2087 convenient way of overriding defaults. The files that are concatenated are, in
2088 order:
2089 .display
2090 &_OS/Makefile-Default_&
2091 &_OS/Makefile-_&<&'ostype'&>
2092 &_Local/Makefile_&
2093 &_Local/Makefile-_&<&'ostype'&>
2094 &_Local/Makefile-_&<&'archtype'&>
2095 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2096 &_OS/Makefile-Base_&
2097 .endd
2098 .cindex "&_Local/Makefile_&"
2099 .cindex "building Exim" "operating system type"
2100 .cindex "building Exim" "architecture type"
2101 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2102 architecture type. &_Local/Makefile_& is required to exist, and the building
2103 process fails if it is absent. The other three &_Local_& files are optional,
2104 and are often not needed.
2105
2106 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2107 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2108 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2109 values are used, thereby providing a means of forcing particular settings.
2110 Otherwise, the scripts try to get values from the &%uname%& command. If this
2111 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2112 of &'ad hoc'& transformations are then applied, to produce the standard names
2113 that Exim expects. You can run these scripts directly from the shell in order
2114 to find out what values are being used on your system.
2115
2116
2117 &_OS/Makefile-Default_& contains comments about the variables that are set
2118 therein. Some (but not all) are mentioned below. If there is something that
2119 needs changing, review the contents of this file and the contents of the make
2120 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2121 default values are.
2122
2123
2124 .cindex "building Exim" "overriding default settings"
2125 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2126 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2127 need to change the original files. Instead, you should make the changes by
2128 putting the new values in an appropriate &_Local_& file. For example,
2129 .cindex "Tru64-Unix build-time settings"
2130 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2131 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2132 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2133 called with the option &%-std1%&, to make it recognize some of the features of
2134 Standard C that Exim uses. (Most other compilers recognize Standard C by
2135 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2136 containing the lines
2137 .code
2138 CC=cc
2139 CFLAGS=-std1
2140 .endd
2141 If you are compiling for just one operating system, it may be easier to put
2142 these lines directly into &_Local/Makefile_&.
2143
2144 Keeping all your local configuration settings separate from the distributed
2145 files makes it easy to transfer them to new versions of Exim simply by copying
2146 the contents of the &_Local_& directory.
2147
2148
2149 .cindex "NIS lookup type" "including support for"
2150 .cindex "NIS+ lookup type" "including support for"
2151 .cindex "LDAP" "including support for"
2152 .cindex "lookup" "inclusion in binary"
2153 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2154 lookup, but not all systems have these components installed, so the default is
2155 not to include the relevant code in the binary. All the different kinds of file
2156 and database lookup that Exim supports are implemented as separate code modules
2157 which are included only if the relevant compile-time options are set. In the
2158 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2159 .code
2160 LOOKUP_LDAP=yes
2161 LOOKUP_NIS=yes
2162 LOOKUP_NISPLUS=yes
2163 .endd
2164 and similar settings apply to the other lookup types. They are all listed in
2165 &_src/EDITME_&. In many cases the relevant include files and interface
2166 libraries need to be installed before compiling Exim.
2167 .cindex "cdb" "including support for"
2168 However, there are some optional lookup types (such as cdb) for which
2169 the code is entirely contained within Exim, and no external include
2170 files or libraries are required. When a lookup type is not included in the
2171 binary, attempts to configure Exim to use it cause runtime configuration
2172 errors.
2173
2174 .cindex "pkg-config" "lookups"
2175 .cindex "pkg-config" "authenticators"
2176 Many systems now use a tool called &'pkg-config'& to encapsulate information
2177 about how to compile against a library; Exim has some initial support for
2178 being able to use pkg-config for lookups and authenticators.  For any given
2179 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2180 variable with the &`_PC`& suffix in the name and assign as the value the
2181 name of the package to be queried.  The results of querying via the
2182 &'pkg-config'& command will be added to the appropriate Makefile variables
2183 with &`+=`& directives, so your version of &'make'& will need to support that
2184 syntax.  For instance:
2185 .code
2186 LOOKUP_SQLITE=yes
2187 LOOKUP_SQLITE_PC=sqlite3
2188 AUTH_GSASL=yes
2189 AUTH_GSASL_PC=libgsasl
2190 AUTH_HEIMDAL_GSSAPI=yes
2191 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2192 .endd
2193
2194 .cindex "Perl" "including support for"
2195 Exim can be linked with an embedded Perl interpreter, allowing Perl
2196 subroutines to be called during string expansion. To enable this facility,
2197 .code
2198 EXIM_PERL=perl.o
2199 .endd
2200 must be defined in &_Local/Makefile_&. Details of this facility are given in
2201 chapter &<<CHAPperl>>&.
2202
2203 .cindex "X11 libraries, location of"
2204 The location of the X11 libraries is something that varies a lot between
2205 operating systems, and there may be different versions of X11 to cope
2206 with. Exim itself makes no use of X11, but if you are compiling the Exim
2207 monitor, the X11 libraries must be available.
2208 The following three variables are set in &_OS/Makefile-Default_&:
2209 .code
2210 X11=/usr/X11R6
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib
2213 .endd
2214 These are overridden in some of the operating-system configuration files. For
2215 example, in &_OS/Makefile-SunOS5_& there is
2216 .code
2217 X11=/usr/openwin
2218 XINCLUDE=-I$(X11)/include
2219 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2220 .endd
2221 If you need to override the default setting for your operating system, place a
2222 definition of all three of these variables into your
2223 &_Local/Makefile-<ostype>_& file.
2224
2225 .cindex "EXTRALIBS"
2226 If you need to add any extra libraries to the link steps, these can be put in a
2227 variable called EXTRALIBS, which appears in all the link commands, but by
2228 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2229 command for linking the main Exim binary, and not for any associated utilities.
2230
2231 .cindex "DBM libraries" "configuration for building"
2232 There is also DBMLIB, which appears in the link commands for binaries that
2233 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2234 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2235 binary, and which can be used, for example, to include additional X11
2236 libraries.
2237
2238 .cindex "configuration file" "editing"
2239 The make file copes with rebuilding Exim correctly if any of the configuration
2240 files are edited. However, if an optional configuration file is deleted, it is
2241 necessary to touch the associated non-optional file (that is,
2242 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2243
2244
2245 .section "OS-specific header files" "SECID30"
2246 .cindex "&_os.h_&"
2247 .cindex "building Exim" "OS-specific C header files"
2248 The &_OS_& directory contains a number of files with names of the form
2249 &_os.h-<ostype>_&. These are system-specific C header files that should not
2250 normally need to be changed. There is a list of macro settings that are
2251 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2252 are porting Exim to a new operating system.
2253
2254
2255
2256 .section "Overriding build-time options for the monitor" "SECID31"
2257 .cindex "building Eximon"
2258 A similar process is used for overriding things when building the Exim monitor,
2259 where the files that are involved are
2260 .display
2261 &_OS/eximon.conf-Default_&
2262 &_OS/eximon.conf-_&<&'ostype'&>
2263 &_Local/eximon.conf_&
2264 &_Local/eximon.conf-_&<&'ostype'&>
2265 &_Local/eximon.conf-_&<&'archtype'&>
2266 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2267 .endd
2268 .cindex "&_Local/eximon.conf_&"
2269 As with Exim itself, the final three files need not exist, and in this case the
2270 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2271 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2272 variables of the same name, preceded by EXIMON_. For example, setting
2273 EXIMON_LOG_DEPTH in the environment overrides the value of
2274 LOG_DEPTH at runtime.
2275 .ecindex IIDbuex
2276
2277
2278 .section "Installing Exim binaries and scripts" "SECID32"
2279 .cindex "installing Exim"
2280 .cindex "BIN_DIRECTORY"
2281 The command &`make install`& runs the &(exim_install)& script with no
2282 arguments. The script copies binaries and utility scripts into the directory
2283 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2284 .cindex "setuid" "installing Exim with"
2285 The install script copies files only if they are newer than the files they are
2286 going to replace. The Exim binary is required to be owned by root and have the
2287 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2288 install`& as root so that it can set up the Exim binary in this way. However, in
2289 some special situations (for example, if a host is doing no local deliveries)
2290 it may be possible to run Exim without making the binary setuid root (see
2291 chapter &<<CHAPsecurity>>& for details).
2292
2293 .cindex "CONFIGURE_FILE"
2294 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2295 in &_Local/Makefile_&. If this names a single file, and the file does not
2296 exist, the default configuration file &_src/configure.default_& is copied there
2297 by the installation script. If a runtime configuration file already exists, it
2298 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2299 alternative files, no default is installed.
2300
2301 .cindex "system aliases file"
2302 .cindex "&_/etc/aliases_&"
2303 One change is made to the default configuration file when it is installed: the
2304 default configuration contains a router that references a system aliases file.
2305 The path to this file is set to the value specified by
2306 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2307 If the system aliases file does not exist, the installation script creates it,
2308 and outputs a comment to the user.
2309
2310 The created file contains no aliases, but it does contain comments about the
2311 aliases a site should normally have. Mail aliases have traditionally been
2312 kept in &_/etc/aliases_&. However, some operating systems are now using
2313 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2314 Exim's configuration if necessary.
2315
2316 The default configuration uses the local host's name as the only local domain,
2317 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2318 running as the local user. System aliases and &_.forward_& files in users' home
2319 directories are supported, but no NIS or NIS+ support is configured. Domains
2320 other than the name of the local host are routed using the DNS, with delivery
2321 over SMTP.
2322
2323 It is possible to install Exim for special purposes (such as building a binary
2324 distribution) in a private part of the file system. You can do this by a
2325 command such as
2326 .code
2327 make DESTDIR=/some/directory/ install
2328 .endd
2329 This has the effect of pre-pending the specified directory to all the file
2330 paths, except the name of the system aliases file that appears in the default
2331 configuration. (If a default alias file is created, its name &'is'& modified.)
2332 For backwards compatibility, ROOT is used if DESTDIR is not set,
2333 but this usage is deprecated.
2334
2335 .cindex "installing Exim" "what is not installed"
2336 Running &'make install'& does not copy the Exim 4 conversion script
2337 &'convert4r4'&. You will probably run this only once if you are
2338 upgrading from Exim 3. None of the documentation files in the &_doc_&
2339 directory are copied, except for the info files when you have set
2340 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2341
2342 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2343 to their names. The Exim binary itself, however, is handled differently. It is
2344 installed under a name that includes the version number and the compile number,
2345 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2346 called &_exim_& to point to the binary. If you are updating a previous version
2347 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2348 from the directory (as seen by other processes).
2349
2350 .cindex "installing Exim" "testing the script"
2351 If you want to see what the &'make install'& will do before running it for
2352 real, you can pass the &%-n%& option to the installation script by this
2353 command:
2354 .code
2355 make INSTALL_ARG=-n install
2356 .endd
2357 The contents of the variable INSTALL_ARG are passed to the installation
2358 script. You do not need to be root to run this test. Alternatively, you can run
2359 the installation script directly, but this must be from within the build
2360 directory. For example, from the top-level Exim directory you could use this
2361 command:
2362 .code
2363 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2364 .endd
2365 .cindex "installing Exim" "install script options"
2366 There are two other options that can be supplied to the installation script.
2367
2368 .ilist
2369 &%-no_chown%& bypasses the call to change the owner of the installed binary
2370 to root, and the call to make it a setuid binary.
2371 .next
2372 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2373 installed binary.
2374 .endlist
2375
2376 INSTALL_ARG can be used to pass these options to the script. For example:
2377 .code
2378 make INSTALL_ARG=-no_symlink install
2379 .endd
2380 The installation script can also be given arguments specifying which files are
2381 to be copied. For example, to install just the Exim binary, and nothing else,
2382 without creating the symbolic link, you could use:
2383 .code
2384 make INSTALL_ARG='-no_symlink exim' install
2385 .endd
2386
2387
2388
2389 .section "Installing info documentation" "SECTinsinfdoc"
2390 .cindex "installing Exim" "&'info'& documentation"
2391 Not all systems use the GNU &'info'& system for documentation, and for this
2392 reason, the Texinfo source of Exim's documentation is not included in the main
2393 distribution. Instead it is available separately from the FTP site (see section
2394 &<<SECTavail>>&).
2395
2396 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2397 source of the documentation is found in the source tree, running &`make
2398 install`& automatically builds the info files and installs them.
2399
2400
2401
2402 .section "Setting up the spool directory" "SECID33"
2403 .cindex "spool directory" "creating"
2404 When it starts up, Exim tries to create its spool directory if it does not
2405 exist. The Exim uid and gid are used for the owner and group of the spool
2406 directory. Sub-directories are automatically created in the spool directory as
2407 necessary.
2408
2409
2410
2411
2412 .section "Testing" "SECID34"
2413 .cindex "testing" "installation"
2414 Having installed Exim, you can check that the runtime configuration file is
2415 syntactically valid by running the following command, which assumes that the
2416 Exim binary directory is within your PATH environment variable:
2417 .code
2418 exim -bV
2419 .endd
2420 If there are any errors in the configuration file, Exim outputs error messages.
2421 Otherwise it outputs the version number and build date,
2422 the DBM library that is being used, and information about which drivers and
2423 other optional code modules are included in the binary.
2424 Some simple routing tests can be done by using the address testing option. For
2425 example,
2426 .display
2427 &`exim -bt`& <&'local username'&>
2428 .endd
2429 should verify that it recognizes a local mailbox, and
2430 .display
2431 &`exim -bt`& <&'remote address'&>
2432 .endd
2433 a remote one. Then try getting it to deliver mail, both locally and remotely.
2434 This can be done by passing messages directly to Exim, without going through a
2435 user agent. For example:
2436 .code
2437 exim -v postmaster@your.domain.example
2438 From: user@your.domain.example
2439 To: postmaster@your.domain.example
2440 Subject: Testing Exim
2441
2442 This is a test message.
2443 ^D
2444 .endd
2445 The &%-v%& option causes Exim to output some verification of what it is doing.
2446 In this case you should see copies of three log lines, one for the message's
2447 arrival, one for its delivery, and one containing &"Completed"&.
2448
2449 .cindex "delivery" "problems with"
2450 If you encounter problems, look at Exim's log files (&'mainlog'& and
2451 &'paniclog'&) to see if there is any relevant information there. Another source
2452 of information is running Exim with debugging turned on, by specifying the
2453 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2454 with debugging turned on by a command of the form
2455 .display
2456 &`exim -d -M`& <&'exim-message-id'&>
2457 .endd
2458 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2459 produces rather a lot of output, but you can cut this down to specific areas.
2460 For example, if you use &%-d-all+route%& only the debugging information
2461 relevant to routing is included. (See the &%-d%& option in chapter
2462 &<<CHAPcommandline>>& for more details.)
2463
2464 .cindex '&"sticky"& bit'
2465 .cindex "lock files"
2466 One specific problem that has shown up on some sites is the inability to do
2467 local deliveries into a shared mailbox directory, because it does not have the
2468 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2469 writing to a mailbox file, and if it cannot create the lock file, the delivery
2470 is deferred. You can get round this either by setting the &"sticky bit"& on the
2471 directory, or by setting a specific group for local deliveries and allowing
2472 that group to create files in the directory (see the comments above the
2473 &(local_delivery)& transport in the default configuration file). Another
2474 approach is to configure Exim not to use lock files, but just to rely on
2475 &[fcntl()]& locking instead. However, you should do this only if all user
2476 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2477 see chapter &<<CHAPappendfile>>&.
2478
2479 One thing that cannot be tested on a system that is already running an MTA is
2480 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2481 &%-oX%& option can be used to run an Exim daemon that listens on some other
2482 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2483 &'exim_checkaccess'& utility can be used to check out policy controls on
2484 incoming SMTP mail.
2485
2486 Testing a new version on a system that is already running Exim can most easily
2487 be done by building a binary with a different CONFIGURE_FILE setting. From
2488 within the runtime configuration, all other file and directory names
2489 that Exim uses can be altered, in order to keep it entirely clear of the
2490 production version.
2491
2492
2493 .section "Replacing another MTA with Exim" "SECID35"
2494 .cindex "replacing another MTA"
2495 Building and installing Exim for the first time does not of itself put it in
2496 general use. The name by which the system's MTA is called by mail user agents
2497 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2498 operating system), and it is necessary to make this name point to the &'exim'&
2499 binary in order to get the user agents to pass messages to Exim. This is
2500 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2501 or &_/usr/lib/sendmail_&
2502 .cindex "symbolic link" "to &'exim'& binary"
2503 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2504 privilege and executable status from the old MTA. It is then necessary to stop
2505 and restart the mailer daemon, if one is running.
2506
2507 .cindex "FreeBSD, MTA indirection"
2508 .cindex "&_/etc/mail/mailer.conf_&"
2509 Some operating systems have introduced alternative ways of switching MTAs. For
2510 example, if you are running FreeBSD, you need to edit the file
2511 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2512 described. A typical example of the contents of this file for running Exim is
2513 as follows:
2514 .code
2515 sendmail            /usr/exim/bin/exim
2516 send-mail           /usr/exim/bin/exim
2517 mailq               /usr/exim/bin/exim -bp
2518 newaliases          /usr/bin/true
2519 .endd
2520 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2521 your Exim installation is &"live"&. Check it by sending a message from your
2522 favourite user agent.
2523
2524 You should consider what to tell your users about the change of MTA. Exim may
2525 have different capabilities to what was previously running, and there are
2526 various operational differences such as the text of messages produced by
2527 command line options and in bounce messages. If you allow your users to make
2528 use of Exim's filtering capabilities, you should make the document entitled
2529 &'Exim's interface to mail filtering'& available to them.
2530
2531
2532
2533 .section "Upgrading Exim" "SECID36"
2534 .cindex "upgrading Exim"
2535 If you are already running Exim on your host, building and installing a new
2536 version automatically makes it available to MUAs, or any other programs that
2537 call the MTA directly. However, if you are running an Exim daemon, you do need
2538 .cindex restart "on HUP signal"
2539 .cindex signal "HUP, to restart"
2540 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2541 new binary. You do not need to stop processing mail in order to install a new
2542 version of Exim. The install script does not modify an existing runtime
2543 configuration file.
2544
2545
2546
2547
2548 .section "Stopping the Exim daemon on Solaris" "SECID37"
2549 .cindex "Solaris" "stopping Exim on"
2550 The standard command for stopping the mailer daemon on Solaris is
2551 .code
2552 /etc/init.d/sendmail stop
2553 .endd
2554 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2555 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2556 for the text &"sendmail"&; this is not present because the actual program name
2557 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2558 solution is to replace the line that finds the process id with something like
2559 .code
2560 pid=`cat /var/spool/exim/exim-daemon.pid`
2561 .endd
2562 to obtain the daemon's pid directly from the file that Exim saves it in.
2563
2564 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2565 still be received from local processes, and if automatic delivery is configured
2566 (the normal case), deliveries will still occur.
2567
2568
2569
2570
2571 . ////////////////////////////////////////////////////////////////////////////
2572 . ////////////////////////////////////////////////////////////////////////////
2573
2574 .chapter "The Exim command line" "CHAPcommandline"
2575 .scindex IIDclo1 "command line" "options"
2576 .scindex IIDclo2 "options" "command line"
2577 Exim's command line takes the standard Unix form of a sequence of options,
2578 each starting with a hyphen character, followed by a number of arguments. The
2579 options are compatible with the main options of Sendmail, and there are also
2580 some additional options, some of which are compatible with Smail 3. Certain
2581 combinations of options do not make sense, and provoke an error if used.
2582 The form of the arguments depends on which options are set.
2583
2584
2585 .section "Setting options by program name" "SECID38"
2586 .cindex "&'mailq'&"
2587 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2588 were present before any other options.
2589 The &%-bp%& option requests a listing of the contents of the mail queue on the
2590 standard output.
2591 This feature is for compatibility with some systems that contain a command of
2592 that name in one of the standard libraries, symbolically linked to
2593 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2594
2595 .cindex "&'rsmtp'&"
2596 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2597 were present before any other options, for compatibility with Smail. The
2598 &%-bS%& option is used for reading in a number of messages in batched SMTP
2599 format.
2600
2601 .cindex "&'rmail'&"
2602 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2603 &%-oee%& options were present before any other options, for compatibility with
2604 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2605
2606 .cindex "&'runq'&"
2607 .cindex "queue runner"
2608 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2609 were present before any other options, for compatibility with Smail. The &%-q%&
2610 option causes a single queue runner process to be started.
2611
2612 .cindex "&'newaliases'&"
2613 .cindex "alias file" "building"
2614 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2615 If Exim is called under the name &'newaliases'& it behaves as if the option
2616 &%-bi%& were present before any other options, for compatibility with Sendmail.
2617 This option is used for rebuilding Sendmail's alias file. Exim does not have
2618 the concept of a single alias file, but can be configured to run a given
2619 command if called with the &%-bi%& option.
2620
2621
2622 .section "Trusted and admin users" "SECTtrustedadmin"
2623 Some Exim options are available only to &'trusted users'& and others are
2624 available only to &'admin users'&. In the description below, the phrases &"Exim
2625 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2626 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2627 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2628
2629 .ilist
2630 .cindex "trusted users" "definition of"
2631 .cindex "user" "trusted definition of"
2632 The trusted users are root, the Exim user, any user listed in the
2633 &%trusted_users%& configuration option, and any user whose current group or any
2634 supplementary group is one of those listed in the &%trusted_groups%&
2635 configuration option. Note that the Exim group is not automatically trusted.
2636
2637 .cindex '&"From"& line'
2638 .cindex "envelope from"
2639 .cindex "envelope sender"
2640 Trusted users are always permitted to use the &%-f%& option or a leading
2641 &"From&~"& line to specify the envelope sender of a message that is passed to
2642 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2643 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2644 users to set envelope senders.
2645
2646 .cindex "&'From:'& header line"
2647 .cindex "&'Sender:'& header line"
2648 .cindex "header lines" "From:"
2649 .cindex "header lines" "Sender:"
2650 For a trusted user, there is never any check on the contents of the &'From:'&
2651 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2652 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2653
2654 Trusted users may also specify a host name, host address, interface address,
2655 protocol name, ident value, and authentication data when submitting a message
2656 locally. Thus, they are able to insert messages into Exim's queue locally that
2657 have the characteristics of messages received from a remote host. Untrusted
2658 users may in some circumstances use &%-f%&, but can never set the other values
2659 that are available to trusted users.
2660 .next
2661 .cindex "user" "admin definition of"
2662 .cindex "admin user" "definition of"
2663 The admin users are root, the Exim user, and any user that is a member of the
2664 Exim group or of any group listed in the &%admin_groups%& configuration option.
2665 The current group does not have to be one of these groups.
2666
2667 Admin users are permitted to list the queue, and to carry out certain
2668 operations on messages, for example, to force delivery failures. It is also
2669 necessary to be an admin user in order to see the full information provided by
2670 the Exim monitor, and full debugging output.
2671
2672 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2673 Exim to attempt delivery of messages on its queue is restricted to admin users.
2674 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2675 option false (that is, specifying &%no_prod_requires_admin%&).
2676
2677 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2678 is restricted to admin users unless &%queue_list_requires_admin%& is set
2679 false.
2680 .endlist
2681
2682
2683 &*Warning*&: If you configure your system so that admin users are able to
2684 edit Exim's configuration file, you are giving those users an easy way of
2685 getting root. There is further discussion of this issue at the start of chapter
2686 &<<CHAPconf>>&.
2687
2688
2689
2690
2691 .section "Command line options" "SECID39"
2692 Exim's command line options are described in alphabetical order below. If none
2693 of the options that specifies a specific action (such as starting the daemon or
2694 a queue runner, or testing an address, or receiving a message in a specific
2695 format, or listing the queue) are present, and there is at least one argument
2696 on the command line, &%-bm%& (accept a local message on the standard input,
2697 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2698 outputs a brief message about itself and exits.
2699
2700 . ////////////////////////////////////////////////////////////////////////////
2701 . Insert a stylized XML comment here, to identify the start of the command line
2702 . options. This is for the benefit of the Perl script that automatically
2703 . creates a man page for the options.
2704 . ////////////////////////////////////////////////////////////////////////////
2705
2706 .literal xml
2707 <!-- === Start of command line options === -->
2708 .literal off
2709
2710
2711 .vlist
2712 .vitem &%--%&
2713 .oindex "--"
2714 .cindex "options" "command line; terminating"
2715 This is a pseudo-option whose only purpose is to terminate the options and
2716 therefore to cause subsequent command line items to be treated as arguments
2717 rather than options, even if they begin with hyphens.
2718
2719 .vitem &%--help%&
2720 .oindex "&%--help%&"
2721 This option causes Exim to output a few sentences stating what it is.
2722 The same output is generated if the Exim binary is called with no options and
2723 no arguments.
2724
2725 .vitem &%--version%&
2726 .oindex "&%--version%&"
2727 This option is an alias for &%-bV%& and causes version information to be
2728 displayed.
2729
2730 .vitem &%-Ac%& &&&
2731        &%-Am%&
2732 .oindex "&%-Ac%&"
2733 .oindex "&%-Am%&"
2734 These options are used by Sendmail for selecting configuration files and are
2735 ignored by Exim.
2736
2737 .vitem &%-B%&<&'type'&>
2738 .oindex "&%-B%&"
2739 .cindex "8-bit characters"
2740 .cindex "Sendmail compatibility" "8-bit characters"
2741 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2742 clean; it ignores this option.
2743
2744 .vitem &%-bd%&
2745 .oindex "&%-bd%&"
2746 .cindex "daemon"
2747 .cindex "SMTP" "listener"
2748 .cindex "queue runner"
2749 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2750 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2751 that the daemon should also initiate periodic queue runs.
2752
2753 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2754 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2755 disconnect from the controlling terminal. When running this way, it can be
2756 stopped by pressing ctrl-C.
2757
2758 By default, Exim listens for incoming connections to the standard SMTP port on
2759 all the host's running interfaces. However, it is possible to listen on other
2760 ports, on multiple ports, and only on specific interfaces. Chapter
2761 &<<CHAPinterfaces>>& contains a description of the options that control this.
2762
2763 When a listening daemon
2764 .cindex "daemon" "process id (pid)"
2765 .cindex "pid (process id)" "of daemon"
2766 is started without the use of &%-oX%& (that is, without overriding the normal
2767 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2768 in Exim's spool directory. This location can be overridden by setting
2769 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2770 running as root.
2771
2772 When &%-oX%& is used on the command line to start a listening daemon, the
2773 process id is not written to the normal pid file path. However, &%-oP%& can be
2774 used to specify a path on the command line if a pid file is required.
2775
2776 The SIGHUP signal
2777 .cindex "SIGHUP"
2778 .cindex restart "on HUP signal"
2779 .cindex signal "HUP, to restart"
2780 .cindex "daemon" "restarting"
2781 .cindex signal "to reload configuration"
2782 .cindex daemon "reload configuration"
2783 .cindex reload configuration
2784 can be used to cause the daemon to re-execute itself. This should be done
2785 whenever Exim's configuration file, or any file that is incorporated into it by
2786 means of the &%.include%& facility, is changed, and also whenever a new version
2787 of Exim is installed. It is not necessary to do this when other files that are
2788 referenced from the configuration (for example, alias files) are changed,
2789 because these are reread each time they are used.
2790
2791 .vitem &%-bdf%&
2792 .oindex "&%-bdf%&"
2793 This option has the same effect as &%-bd%& except that it never disconnects
2794 from the controlling terminal, even when no debugging is specified.
2795
2796 .vitem &%-be%&
2797 .oindex "&%-be%&"
2798 .cindex "testing" "string expansion"
2799 .cindex "expansion" "testing"
2800 Run Exim in expansion testing mode. Exim discards its root privilege, to
2801 prevent ordinary users from using this mode to read otherwise inaccessible
2802 files. If no arguments are given, Exim runs interactively, prompting for lines
2803 of data. Otherwise, it processes each argument in turn.
2804
2805 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2806 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2807 used without command line arguments. If successful, it uses the &[readline()]&
2808 function, which provides extensive line-editing facilities, for reading the
2809 test data. A line history is supported.
2810
2811 Long expansion expressions can be split over several lines by using backslash
2812 continuations. As in Exim's runtime configuration, white space at the start of
2813 continuation lines is ignored. Each argument or data line is passed through the
2814 string expansion mechanism, and the result is output. Variable values from the
2815 configuration file (for example, &$qualify_domain$&) are available, but no
2816 message-specific values (such as &$message_exim_id$&) are set, because no message
2817 is being processed (but see &%-bem%& and &%-Mset%&).
2818
2819 &*Note*&: If you use this mechanism to test lookups, and you change the data
2820 files or databases you are using, you must exit and restart Exim before trying
2821 the same lookup again. Otherwise, because each Exim process caches the results
2822 of lookups, you will just get the same result as before.
2823
2824 Macro processing is done on lines before string-expansion: new macros can be
2825 defined and macros will be expanded.
2826 Because macros in the config file are often used for secrets, those are only
2827 available to admin users.
2828
2829 .vitem &%-bem%&&~<&'filename'&>
2830 .oindex "&%-bem%&"
2831 .cindex "testing" "string expansion"
2832 .cindex "expansion" "testing"
2833 This option operates like &%-be%& except that it must be followed by the name
2834 of a file. For example:
2835 .code
2836 exim -bem /tmp/testmessage
2837 .endd
2838 The file is read as a message (as if receiving a locally-submitted non-SMTP
2839 message) before any of the test expansions are done. Thus, message-specific
2840 variables such as &$message_size$& and &$header_from:$& are available. However,
2841 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2842 recipients are read from the headers in the normal way, and are shown in the
2843 &$recipients$& variable. Note that recipients cannot be given on the command
2844 line, because further arguments are taken as strings to expand (just like
2845 &%-be%&).
2846
2847 .vitem &%-bF%&&~<&'filename'&>
2848 .oindex "&%-bF%&"
2849 .cindex "system filter" "testing"
2850 .cindex "testing" "system filter"
2851 This option is the same as &%-bf%& except that it assumes that the filter being
2852 tested is a system filter. The additional commands that are available only in
2853 system filters are recognized.
2854
2855 .vitem &%-bf%&&~<&'filename'&>
2856 .oindex "&%-bf%&"
2857 .cindex "filter" "testing"
2858 .cindex "testing" "filter file"
2859 .cindex "forward file" "testing"
2860 .cindex "testing" "forward file"
2861 .cindex "Sieve filter" "testing"
2862 This option runs Exim in user filter testing mode; the file is the filter file
2863 to be tested, and a test message must be supplied on the standard input. If
2864 there are no message-dependent tests in the filter, an empty file can be
2865 supplied.
2866
2867 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2868 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2869 filter and a user filter in the same run. For example:
2870 .code
2871 exim -bF /system/filter -bf /user/filter </test/message
2872 .endd
2873 This is helpful when the system filter adds header lines or sets filter
2874 variables that are used by the user filter.
2875
2876 If the test filter file does not begin with one of the special lines
2877 .code
2878 # Exim filter
2879 # Sieve filter
2880 .endd
2881 it is taken to be a normal &_.forward_& file, and is tested for validity under
2882 that interpretation. See sections &<<SECTitenonfilred>>& to
2883 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2884 redirection lists.
2885
2886 The result of an Exim command that uses &%-bf%&, provided no errors are
2887 detected, is a list of the actions that Exim would try to take if presented
2888 with the message for real. More details of filter testing are given in the
2889 separate document entitled &'Exim's interfaces to mail filtering'&.
2890
2891 When testing a filter file,
2892 .cindex "&""From""& line"
2893 .cindex "envelope from"
2894 .cindex "envelope sender"
2895 .oindex "&%-f%&" "for filter testing"
2896 the envelope sender can be set by the &%-f%& option,
2897 or by a &"From&~"& line at the start of the test message. Various parameters
2898 that would normally be taken from the envelope recipient address of the message
2899 can be set by means of additional command line options (see the next four
2900 options).
2901
2902 .vitem &%-bfd%&&~<&'domain'&>
2903 .oindex "&%-bfd%&"
2904 .vindex "&$qualify_domain$&"
2905 This sets the domain of the recipient address when a filter file is being
2906 tested by means of the &%-bf%& option. The default is the value of
2907 &$qualify_domain$&.
2908
2909 .vitem &%-bfl%&&~<&'local&~part'&>
2910 .oindex "&%-bfl%&"
2911 This sets the local part of the recipient address when a filter file is being
2912 tested by means of the &%-bf%& option. The default is the username of the
2913 process that calls Exim. A local part should be specified with any prefix or
2914 suffix stripped, because that is how it appears to the filter when a message is
2915 actually being delivered.
2916
2917 .vitem &%-bfp%&&~<&'prefix'&>
2918 .oindex "&%-bfp%&"
2919 .cindex affix "filter testing"
2920 This sets the prefix of the local part of the recipient address when a filter
2921 file is being tested by means of the &%-bf%& option. The default is an empty
2922 prefix.
2923
2924 .vitem &%-bfs%&&~<&'suffix'&>
2925 .oindex "&%-bfs%&"
2926 .cindex affix "filter testing"
2927 This sets the suffix of the local part of the recipient address when a filter
2928 file is being tested by means of the &%-bf%& option. The default is an empty
2929 suffix.
2930
2931 .vitem &%-bh%&&~<&'IP&~address'&>
2932 .oindex "&%-bh%&"
2933 .cindex "testing" "incoming SMTP"
2934 .cindex "SMTP" "testing incoming"
2935 .cindex "testing" "relay control"
2936 .cindex "relaying" "testing configuration"
2937 .cindex "policy control" "testing"
2938 .cindex "debugging" "&%-bh%& option"
2939 This option runs a fake SMTP session as if from the given IP address, using the
2940 standard input and output. The IP address may include a port number at the end,
2941 after a full stop. For example:
2942 .code
2943 exim -bh 10.9.8.7.1234
2944 exim -bh fe80::a00:20ff:fe86:a061.5678
2945 .endd
2946 When an IPv6 address is given, it is converted into canonical form. In the case
2947 of the second example above, the value of &$sender_host_address$& after
2948 conversion to the canonical form is
2949 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2950
2951 Comments as to what is going on are written to the standard error file. These
2952 include lines beginning with &"LOG"& for anything that would have been logged.
2953 This facility is provided for testing configuration options for incoming
2954 messages, to make sure they implement the required policy. For example, you can
2955 test your relay controls using &%-bh%&.
2956
2957 &*Warning 1*&:
2958 .cindex "RFC 1413"
2959 You can test features of the configuration that rely on ident (RFC 1413)
2960 information by using the &%-oMt%& option. However, Exim cannot actually perform
2961 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2962 connection.
2963
2964 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2965 are also skipped when testing using &%-bh%&. If you want these callouts to
2966 occur, use &%-bhc%& instead.
2967
2968 Messages supplied during the testing session are discarded, and nothing is
2969 written to any of the real log files. There may be pauses when DNS (and other)
2970 lookups are taking place, and of course these may time out. The &%-oMi%& option
2971 can be used to specify a specific IP interface and port if this is important,
2972 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2973 session were authenticated.
2974
2975 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2976 output just states whether a given recipient address from a given host is
2977 acceptable or not. See section &<<SECTcheckaccess>>&.
2978
2979 Features such as authentication and encryption, where the client input is not
2980 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2981 specialized SMTP test program such as
2982 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2983
2984 .vitem &%-bhc%&&~<&'IP&~address'&>
2985 .oindex "&%-bhc%&"
2986 This option operates in the same way as &%-bh%&, except that address
2987 verification callouts are performed if required. This includes consulting and
2988 updating the callout cache database.
2989
2990 .vitem &%-bi%&
2991 .oindex "&%-bi%&"
2992 .cindex "alias file" "building"
2993 .cindex "building alias file"
2994 .cindex "Sendmail compatibility" "&%-bi%& option"
2995 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2996 Exim does not have the concept of a single alias file, and so it cannot mimic
2997 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2998 tend to appear in various scripts such as NIS make files, so the option must be
2999 recognized.
3000
3001 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3002 configuration option is run, under the uid and gid of the caller of Exim. If
3003 the &%-oA%& option is used, its value is passed to the command as an argument.
3004 The command set by &%bi_command%& may not contain arguments. The command can
3005 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3006 if this is required. If the &%bi_command%& option is not set, calling Exim with
3007 &%-bi%& is a no-op.
3008
3009 . // Keep :help first, then the rest in alphabetical order
3010 .vitem &%-bI:help%&
3011 .oindex "&%-bI:help%&"
3012 .cindex "querying exim information"
3013 We shall provide various options starting &`-bI:`& for querying Exim for
3014 information.  The output of many of these will be intended for machine
3015 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3016 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3017 options shall cause Exim to exit after producing the requested output.
3018
3019 .vitem &%-bI:dscp%&
3020 .oindex "&%-bI:dscp%&"
3021 .cindex "DSCP" "values"
3022 This option causes Exim to emit an alphabetically sorted list of all
3023 recognised DSCP names.
3024
3025 .vitem &%-bI:sieve%&
3026 .oindex "&%-bI:sieve%&"
3027 .cindex "Sieve filter" "capabilities"
3028 This option causes Exim to emit an alphabetically sorted list of all supported
3029 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3030 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3031 &`SIEVE`& capability response line.  As the precise list may depend upon
3032 compile-time build options, which this option will adapt to, this is the only
3033 way to guarantee a correct response.
3034
3035 .vitem &%-bm%&
3036 .oindex "&%-bm%&"
3037 .cindex "local message reception"
3038 This option runs an Exim receiving process that accepts an incoming,
3039 locally-generated message on the standard input. The recipients are given as the
3040 command arguments (except when &%-t%& is also present &-- see below). Each
3041 argument can be a comma-separated list of RFC 2822 addresses. This is the
3042 default option for selecting the overall action of an Exim call; it is assumed
3043 if no other conflicting option is present.
3044
3045 If any addresses in the message are unqualified (have no domain), they are
3046 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3047 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3048 suppressing this for special cases.
3049
3050 Policy checks on the contents of local messages can be enforced by means of
3051 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3052
3053 .cindex "return code" "for &%-bm%&"
3054 The return code is zero if the message is successfully accepted. Otherwise, the
3055 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3056
3057 The format
3058 .cindex "message" "format"
3059 .cindex "format" "message"
3060 .cindex "&""From""& line"
3061 .cindex "UUCP" "&""From""& line"
3062 .cindex "Sendmail compatibility" "&""From""& line"
3063 of the message must be as defined in RFC 2822, except that, for
3064 compatibility with Sendmail and Smail, a line in one of the forms
3065 .code
3066 From sender Fri Jan  5 12:55 GMT 1997
3067 From sender Fri, 5 Jan 97 12:55:01
3068 .endd
3069 (with the weekday optional, and possibly with additional text after the date)
3070 is permitted to appear at the start of the message. There appears to be no
3071 authoritative specification of the format of this line. Exim recognizes it by
3072 matching against the regular expression defined by the &%uucp_from_pattern%&
3073 option, which can be changed if necessary.
3074
3075 .oindex "&%-f%&" "overriding &""From""& line"
3076 The specified sender is treated as if it were given as the argument to the
3077 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3078 preference to the address taken from the message. The caller of Exim must be a
3079 trusted user for the sender of a message to be set in this way.
3080
3081 .vitem &%-bmalware%&&~<&'filename'&>
3082 .oindex "&%-bmalware%&"
3083 .cindex "testing", "malware"
3084 .cindex "malware scan test"
3085 This debugging option causes Exim to scan the given file or directory
3086 (depending on the used scanner interface),
3087 using the malware scanning framework.  The option of &%av_scanner%& influences
3088 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3089 the expansion should have defaults which apply to this invocation.  ACLs are
3090 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3091 will never be populated and &%-bmalware%& will fail.
3092
3093 Exim will have changed working directory before resolving the filename, so
3094 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3095 user when it tries to open the file, rather than as the invoking user.
3096 This option requires admin privileges.
3097
3098 The &%-bmalware%& option will not be extended to be more generally useful,
3099 there are better tools for file-scanning.  This option exists to help
3100 administrators verify their Exim and AV scanner configuration.
3101
3102 .vitem &%-bnq%&
3103 .oindex "&%-bnq%&"
3104 .cindex "address qualification, suppressing"
3105 By default, Exim automatically qualifies unqualified addresses (those
3106 without domains) that appear in messages that are submitted locally (that
3107 is, not over TCP/IP). This qualification applies both to addresses in
3108 envelopes, and addresses in header lines. Sender addresses are qualified using
3109 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3110 defaults to the value of &%qualify_domain%&).
3111
3112 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3113 being used to re-submit messages that originally came from remote hosts after
3114 content scanning, you probably do not want to qualify unqualified addresses in
3115 header lines. (Such lines will be present only if you have not enabled a header
3116 syntax check in the appropriate ACL.)
3117
3118 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3119 messages that originate on the local host. When this is used, unqualified
3120 addresses in the envelope provoke errors (causing message rejection) and
3121 unqualified addresses in header lines are left alone.
3122
3123
3124 .vitem &%-bP%&
3125 .oindex "&%-bP%&"
3126 .cindex "configuration options" "extracting"
3127 .cindex "options" "configuration &-- extracting"
3128 If this option is given with no arguments, it causes the values of all Exim's
3129 main configuration options to be written to the standard output. The values
3130 of one or more specific options can be requested by giving their names as
3131 arguments, for example:
3132 .code
3133 exim -bP qualify_domain hold_domains
3134 .endd
3135 .cindex "hiding configuration option values"
3136 .cindex "configuration options" "hiding value of"
3137 .cindex "options" "hiding value of"
3138 However, any option setting that is preceded by the word &"hide"& in the
3139 configuration file is not shown in full, except to an admin user. For other
3140 users, the output is as in this example:
3141 .code
3142 mysql_servers = <value not displayable>
3143 .endd
3144 If &%config%& is given as an argument, the config is
3145 output, as it was parsed, any include file resolved, any comment removed.
3146
3147 If &%config_file%& is given as an argument, the name of the runtime
3148 configuration file is output. (&%configure_file%& works too, for
3149 backward compatibility.)
3150 If a list of configuration files was supplied, the value that is output here
3151 is the name of the file that was actually used.
3152
3153 .cindex "options" "hiding name of"
3154 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3155 name will not be output.
3156
3157 .cindex "daemon" "process id (pid)"
3158 .cindex "pid (process id)" "of daemon"
3159 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3160 directories where log files and daemon pid files are written are output,
3161 respectively. If these values are unset, log files are written in a
3162 sub-directory of the spool directory called &%log%&, and the pid file is
3163 written directly into the spool directory.
3164
3165 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3166 .code
3167 exim -bP +local_domains
3168 .endd
3169 it searches for a matching named list of any type (domain, host, address, or
3170 local part) and outputs what it finds.
3171
3172 .cindex "options" "router &-- extracting"
3173 .cindex "options" "transport &-- extracting"
3174 .cindex "options" "authenticator &-- extracting"
3175 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3176 followed by the name of an appropriate driver instance, the option settings for
3177 that driver are output. For example:
3178 .code
3179 exim -bP transport local_delivery
3180 .endd
3181 The generic driver options are output first, followed by the driver's private
3182 options. A list of the names of drivers of a particular type can be obtained by
3183 using one of the words &%router_list%&, &%transport_list%&, or
3184 &%authenticator_list%&, and a complete list of all drivers with their option
3185 settings can be obtained by using &%routers%&, &%transports%&, or
3186 &%authenticators%&.
3187
3188 .cindex "environment"
3189 If &%environment%& is given as an argument, the set of environment
3190 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3191 variables.
3192
3193 .cindex "options" "macro &-- extracting"
3194 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3195 are available, similarly to the drivers.  Because macros are sometimes used
3196 for storing passwords, this option is restricted.
3197 The output format is one item per line.
3198 For the "-bP macro <name>" form, if no such macro is found
3199 the exit status will be nonzero.
3200
3201 .vitem &%-bp%&
3202 .oindex "&%-bp%&"
3203 .cindex "queue" "listing messages in"
3204 .cindex "listing" "messages in the queue"
3205 This option requests a listing of the contents of the mail queue on the
3206 standard output. If the &%-bp%& option is followed by a list of message ids,
3207 just those messages are listed. By default, this option can be used only by an
3208 admin user. However, the &%queue_list_requires_admin%& option can be set false
3209 to allow any user to see the queue.
3210
3211 Each message in the queue is displayed as in the following example:
3212 .code
3213 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3214           red.king@looking-glass.fict.example
3215           <other addresses>
3216 .endd
3217 .cindex "message" "size in queue listing"
3218 .cindex "size" "of message"
3219 The first line contains the length of time the message has been in the queue
3220 (in this case 25 minutes), the size of the message (2.9K), the unique local
3221 identifier for the message, and the message sender, as contained in the
3222 envelope. For bounce messages, the sender address is empty, and appears as
3223 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3224 the default sender address, the user's login name is shown in parentheses
3225 before the sender address.
3226
3227 .cindex "frozen messages" "in queue listing"
3228 If the message is frozen (attempts to deliver it are suspended) then the text
3229 &"*** frozen ***"& is displayed at the end of this line.
3230
3231 The recipients of the message (taken from the envelope, not the headers) are
3232 displayed on subsequent lines. Those addresses to which the message has already
3233 been delivered are marked with the letter D. If an original address gets
3234 expanded into several addresses via an alias or forward file, the original is
3235 displayed with a D only when deliveries for all of its child addresses are
3236 complete.
3237
3238
3239 .vitem &%-bpa%&
3240 .oindex "&%-bpa%&"
3241 This option operates like &%-bp%&, but in addition it shows delivered addresses
3242 that were generated from the original top level address(es) in each message by
3243 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3244 of just &"D"&.
3245
3246
3247 .vitem &%-bpc%&
3248 .oindex "&%-bpc%&"
3249 .cindex "queue" "count of messages on"
3250 This option counts the number of messages in the queue, and writes the total
3251 to the standard output. It is restricted to admin users, unless
3252 &%queue_list_requires_admin%& is set false.
3253
3254
3255 .vitem &%-bpr%&
3256 .oindex "&%-bpr%&"
3257 This option operates like &%-bp%&, but the output is not sorted into
3258 chronological order of message arrival. This can speed it up when there are
3259 lots of messages in the queue, and is particularly useful if the output is
3260 going to be post-processed in a way that doesn't need the sorting.
3261
3262 .vitem &%-bpra%&
3263 .oindex "&%-bpra%&"
3264 This option is a combination of &%-bpr%& and &%-bpa%&.
3265
3266 .vitem &%-bpru%&
3267 .oindex "&%-bpru%&"
3268 This option is a combination of &%-bpr%& and &%-bpu%&.
3269
3270
3271 .vitem &%-bpu%&
3272 .oindex "&%-bpu%&"
3273 This option operates like &%-bp%& but shows only undelivered top-level
3274 addresses for each message displayed. Addresses generated by aliasing or
3275 forwarding are not shown, unless the message was deferred after processing by a
3276 router with the &%one_time%& option set.
3277
3278
3279 .vitem &%-brt%&
3280 .oindex "&%-brt%&"
3281 .cindex "testing" "retry configuration"
3282 .cindex "retry" "configuration testing"
3283 This option is for testing retry rules, and it must be followed by up to three
3284 arguments. It causes Exim to look for a retry rule that matches the values
3285 and to write it to the standard output. For example:
3286 .code
3287 exim -brt bach.comp.mus.example
3288 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3289 .endd
3290 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3291 argument, which is required, can be a complete address in the form
3292 &'local_part@domain'&, or it can be just a domain name. If the second argument
3293 contains a dot, it is interpreted as an optional second domain name; if no
3294 retry rule is found for the first argument, the second is tried. This ties in
3295 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3296 rule is found that matches the host, one that matches the mail domain is
3297 sought. Finally, an argument that is the name of a specific delivery error, as
3298 used in setting up retry rules, can be given. For example:
3299 .code
3300 exim -brt haydn.comp.mus.example quota_3d
3301 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3302 .endd
3303
3304 .vitem &%-brw%&
3305 .oindex "&%-brw%&"
3306 .cindex "testing" "rewriting"
3307 .cindex "rewriting" "testing"
3308 This option is for testing address rewriting rules, and it must be followed by
3309 a single argument, consisting of either a local part without a domain, or a
3310 complete address with a fully qualified domain. Exim outputs how this address
3311 would be rewritten for each possible place it might appear. See chapter
3312 &<<CHAPrewrite>>& for further details.
3313
3314 .vitem &%-bS%&
3315 .oindex "&%-bS%&"
3316 .cindex "SMTP" "batched incoming"
3317 .cindex "batched SMTP input"
3318 This option is used for batched SMTP input, which is an alternative interface
3319 for non-interactive local message submission. A number of messages can be
3320 submitted in a single run. However, despite its name, this is not really SMTP
3321 input. Exim reads each message's envelope from SMTP commands on the standard
3322 input, but generates no responses. If the caller is trusted, or
3323 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3324 believed; otherwise the sender is always the caller of Exim.
3325
3326 The message itself is read from the standard input, in SMTP format (leading
3327 dots doubled), terminated by a line containing just a single dot. An error is
3328 provoked if the terminating dot is missing. A further message may then follow.
3329
3330 As for other local message submissions, the contents of incoming batch SMTP
3331 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3332 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3333 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3334
3335 Some other SMTP commands are recognized in the input. HELO and EHLO act
3336 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3337 QUIT quits, ignoring the rest of the standard input.
3338
3339 .cindex "return code" "for &%-bS%&"
3340 If any error is encountered, reports are written to the standard output and
3341 error streams, and Exim gives up immediately. The return code is 0 if no error
3342 was detected; it is 1 if one or more messages were accepted before the error
3343 was detected; otherwise it is 2.
3344
3345 More details of input using batched SMTP are given in section
3346 &<<SECTincomingbatchedSMTP>>&.
3347
3348 .vitem &%-bs%&
3349 .oindex "&%-bs%&"
3350 .cindex "SMTP" "local input"
3351 .cindex "local SMTP input"
3352 This option causes Exim to accept one or more messages by reading SMTP commands
3353 on the standard input, and producing SMTP replies on the standard output. SMTP
3354 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3355 Some user agents use this interface as a way of passing locally-generated
3356 messages to the MTA.
3357
3358 In
3359 .cindex "sender" "source of"
3360 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3361 set, the senders of messages are taken from the SMTP MAIL commands.
3362 Otherwise the content of these commands is ignored and the sender is set up as
3363 the calling user. Unqualified addresses are automatically qualified using
3364 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3365 &%-bnq%& option is used.
3366
3367 .cindex "inetd"
3368 The
3369 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3370 using a listening daemon. Exim can distinguish the two cases by checking
3371 whether the standard input is a TCP/IP socket. When Exim is called from
3372 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3373 above concerning senders and qualification do not apply. In this situation,
3374 Exim behaves in exactly the same way as it does when receiving a message via
3375 the listening daemon.
3376
3377 .vitem &%-bt%&
3378 .oindex "&%-bt%&"
3379 .cindex "testing" "addresses"
3380 .cindex "address" "testing"
3381 This option runs Exim in address testing mode, in which each argument is taken
3382 as a recipient address to be tested for deliverability. The results are
3383 written to the standard output. If a test fails, and the caller is not an admin
3384 user, no details of the failure are output, because these might contain
3385 sensitive information such as usernames and passwords for database lookups.
3386
3387 If no arguments are given, Exim runs in an interactive manner, prompting with a
3388 right angle bracket for addresses to be tested.
3389
3390 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3391 &[readline()]& function, because it is running as &'root'& and there are
3392 security issues.
3393
3394 Each address is handled as if it were the recipient address of a message
3395 (compare the &%-bv%& option). It is passed to the routers and the result is
3396 written to the standard output. However, any router that has
3397 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3398 genuine routing tests if your first router passes everything to a scanner
3399 program.
3400
3401 .cindex "return code" "for &%-bt%&"
3402 The return code is 2 if any address failed outright; it is 1 if no address
3403 failed outright but at least one could not be resolved for some reason. Return
3404 code 0 is given only when all addresses succeed.
3405
3406 .cindex "duplicate addresses"
3407 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3408 addresses after routing is complete, so that only one delivery takes place.
3409 This does not happen when testing with &%-bt%&; the full results of routing are
3410 always shown.
3411
3412 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3413 routers in the configuration makes any tests on the sender address of a
3414 message,
3415 .oindex "&%-f%&" "for address testing"
3416 you can use the &%-f%& option to set an appropriate sender when running
3417 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3418 default qualifying domain. However, if you have set up (for example) routers
3419 whose behaviour depends on the contents of an incoming message, you cannot test
3420 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3421 doing such tests.
3422
3423 .vitem &%-bV%&
3424 .oindex "&%-bV%&"
3425 .cindex "version number of Exim"
3426 This option causes Exim to write the current version number, compilation
3427 number, and compilation date of the &'exim'& binary to the standard output.
3428 It also lists the DBM library that is being used, the optional modules (such as
3429 specific lookup types), the drivers that are included in the binary, and the
3430 name of the runtime configuration file that is in use.
3431
3432 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3433 configuration file. However, this is a static check only. It cannot check
3434 values that are to be expanded. For example, although a misspelt ACL verb is
3435 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3436 alone to discover (for example) all the typos in the configuration; some
3437 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3438 dynamic testing facilities.
3439
3440 .vitem &%-bv%&
3441 .oindex "&%-bv%&"
3442 .cindex "verifying address" "using &%-bv%&"
3443 .cindex "address" "verification"
3444 This option runs Exim in address verification mode, in which each argument is
3445 taken as a recipient address to be verified by the routers. (This does
3446 not involve any verification callouts). During normal operation, verification
3447 happens mostly as a consequence processing a &%verify%& condition in an ACL
3448 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3449 including callouts, see the &%-bh%& and &%-bhc%& options.
3450
3451 If verification fails, and the caller is not an admin user, no details of the
3452 failure are output, because these might contain sensitive information such as
3453 usernames and passwords for database lookups.
3454
3455 If no arguments are given, Exim runs in an interactive manner, prompting with a
3456 right angle bracket for addresses to be verified.
3457
3458 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3459 &[readline()]& function, because it is running as &'exim'& and there are
3460 security issues.
3461
3462 Verification differs from address testing (the &%-bt%& option) in that routers
3463 that have &%no_verify%& set are skipped, and if the address is accepted by a
3464 router that has &%fail_verify%& set, verification fails. The address is
3465 verified as a recipient if &%-bv%& is used; to test verification for a sender
3466 address, &%-bvs%& should be used.
3467
3468 If the &%-v%& option is not set, the output consists of a single line for each
3469 address, stating whether it was verified or not, and giving a reason in the
3470 latter case. Without &%-v%&, generating more than one address by redirection
3471 causes verification to end successfully, without considering the generated
3472 addresses. However, if just one address is generated, processing continues,
3473 and the generated address must verify successfully for the overall verification
3474 to succeed.
3475
3476 When &%-v%& is set, more details are given of how the address has been handled,
3477 and in the case of address redirection, all the generated addresses are also
3478 considered. Verification may succeed for some and fail for others.
3479
3480 The
3481 .cindex "return code" "for &%-bv%&"
3482 return code is 2 if any address failed outright; it is 1 if no address
3483 failed outright but at least one could not be resolved for some reason. Return
3484 code 0 is given only when all addresses succeed.
3485
3486 If any of the routers in the configuration makes any tests on the sender
3487 address of a message, you should use the &%-f%& option to set an appropriate
3488 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3489 calling user at the default qualifying domain.
3490
3491 .vitem &%-bvs%&
3492 .oindex "&%-bvs%&"
3493 This option acts like &%-bv%&, but verifies the address as a sender rather
3494 than a recipient address. This affects any rewriting and qualification that
3495 might happen.
3496
3497 .vitem &%-bw%&
3498 .oindex "&%-bw%&"
3499 .cindex "daemon"
3500 .cindex "inetd"
3501 .cindex "inetd" "wait mode"
3502 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3503 similarly to the &%-bd%& option.  All port specifications on the command-line
3504 and in the configuration file are ignored.  Queue-running may not be specified.
3505
3506 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3507 listening for connections.  This permits the system to start up and have
3508 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3509 each port only when the first connection is received.
3510
3511 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3512 which the daemon will exit, which should cause inetd to listen once more.
3513
3514 .vitem &%-C%&&~<&'filelist'&>
3515 .oindex "&%-C%&"
3516 .cindex "configuration file" "alternate"
3517 .cindex "CONFIGURE_FILE"
3518 .cindex "alternate configuration file"
3519 This option causes Exim to find the runtime configuration file from the given
3520 list instead of from the list specified by the CONFIGURE_FILE
3521 compile-time setting. Usually, the list will consist of just a single filename,
3522 but it can be a colon-separated list of names. In this case, the first
3523 file that exists is used. Failure to open an existing file stops Exim from
3524 proceeding any further along the list, and an error is generated.
3525
3526 When this option is used by a caller other than root, and the list is different
3527 from the compiled-in list, Exim gives up its root privilege immediately, and
3528 runs with the real and effective uid and gid set to those of the caller.
3529 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3530 file contains a list of full pathnames, one per line, for configuration files
3531 which are trusted. Root privilege is retained for any configuration file so
3532 listed, as long as the caller is the Exim user (or the user specified in the
3533 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3534 not writeable by inappropriate users or groups.
3535
3536 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3537 configuration using &%-C%& right through message reception and delivery,
3538 even if the caller is root. The reception works, but by that time, Exim is
3539 running as the Exim user, so when it re-executes to regain privilege for the
3540 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3541 test reception and delivery using two separate commands (one to put a message
3542 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3543
3544 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3545 prefix string with which any file named in a &%-C%& command line option
3546 must start. In addition, the filename must not contain the sequence &`/../`&.
3547 However, if the value of the &%-C%& option is identical to the value of
3548 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3549 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3550 unset, any filename can be used with &%-C%&.
3551
3552 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3553 to a directory to which only root has access. This prevents someone who has
3554 broken into the Exim account from running a privileged Exim with an arbitrary
3555 configuration file.
3556
3557 The &%-C%& facility is useful for ensuring that configuration files are
3558 syntactically correct, but cannot be used for test deliveries, unless the
3559 caller is privileged, or unless it is an exotic configuration that does not
3560 require privilege. No check is made on the owner or group of the files
3561 specified by this option.
3562
3563
3564 .vitem &%-D%&<&'macro'&>=<&'value'&>
3565 .oindex "&%-D%&"
3566 .cindex "macro" "setting on command line"
3567 This option can be used to override macro definitions in the configuration file
3568 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3569 unprivileged caller, it causes Exim to give up its root privilege.
3570 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3571 completely disabled, and its use causes an immediate error exit.
3572
3573 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3574 colon-separated list of macros which are considered safe and, if &%-D%& only
3575 supplies macros from this list, and the values are acceptable, then Exim will
3576 not give up root privilege if the caller is root, the Exim run-time user, or
3577 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3578 to be removed in the future.  Acceptable values for the macros satisfy the
3579 regexp: &`^[A-Za-z0-9_/.-]*$`&
3580
3581 The entire option (including equals sign if present) must all be within one
3582 command line item. &%-D%& can be used to set the value of a macro to the empty
3583 string, in which case the equals sign is optional. These two commands are
3584 synonymous:
3585 .code
3586 exim -DABC  ...
3587 exim -DABC= ...
3588 .endd
3589 To include spaces in a macro definition item, quotes must be used. If you use
3590 quotes, spaces are permitted around the macro name and the equals sign. For
3591 example:
3592 .code
3593 exim '-D ABC = something' ...
3594 .endd
3595 &%-D%& may be repeated up to 10 times on a command line.
3596 Only macro names up to 22 letters long can be set.
3597
3598
3599 .vitem &%-d%&<&'debug&~options'&>
3600 .oindex "&%-d%&"
3601 .cindex "debugging" "list of selectors"
3602 .cindex "debugging" "&%-d%& option"
3603 This option causes debugging information to be written to the standard
3604 error stream. It is restricted to admin users because debugging output may show
3605 database queries that contain password information. Also, the details of users'
3606 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3607 writes an error message to the standard error stream and exits with a non-zero
3608 return code.
3609
3610 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3611 standard debugging data is output. This can be reduced, or increased to include
3612 some more rarely needed information, by directly following &%-d%& with a string
3613 made up of names preceded by plus or minus characters. These add or remove sets
3614 of debugging data, respectively. For example, &%-d+filter%& adds filter
3615 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3616 no spaces are allowed in the debug setting. The available debugging categories
3617 are:
3618 .display
3619 &`acl            `& ACL interpretation
3620 &`auth           `& authenticators
3621 &`deliver        `& general delivery logic
3622 &`dns            `& DNS lookups (see also resolver)
3623 &`dnsbl          `& DNS black list (aka RBL) code
3624 &`exec           `& arguments for &[execv()]& calls
3625 &`expand         `& detailed debugging for string expansions
3626 &`filter         `& filter handling
3627 &`hints_lookup   `& hints data lookups
3628 &`host_lookup    `& all types of name-to-IP address handling
3629 &`ident          `& ident lookup
3630 &`interface      `& lists of local interfaces
3631 &`lists          `& matching things in lists
3632 &`load           `& system load checks
3633 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3634                     &<<CHAPlocalscan>>&)
3635 &`lookup         `& general lookup code and all lookups
3636 &`memory         `& memory handling
3637 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3638 &`pid            `& modifier: add pid to debug output lines
3639 &`process_info   `& setting info for the process log
3640 &`queue_run      `& queue runs
3641 &`receive        `& general message reception logic
3642 &`resolver       `& turn on the DNS resolver's debugging output
3643 &`retry          `& retry handling
3644 &`rewrite        `& address rewriting
3645 &`route          `& address routing
3646 &`timestamp      `& modifier: add timestamp to debug output lines
3647 &`tls            `& TLS logic
3648 &`transport      `& transports
3649 &`uid            `& changes of uid/gid and looking up uid/gid
3650 &`verify         `& address verification logic
3651 &`all            `& almost all of the above (see below), and also &%-v%&
3652 .endd
3653 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3654 for &`-all`&. The reason for this is that &`+all`& is something that people
3655 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3656 is included, an awful lot of output that is very rarely of interest is
3657 generated, so it now has to be explicitly requested. However, &`-all`& does
3658 turn everything off.
3659
3660 .cindex "resolver, debugging output"
3661 .cindex "DNS resolver, debugging output"
3662 The &`resolver`& option produces output only if the DNS resolver was compiled
3663 with DEBUG enabled. This is not the case in some operating systems. Also,
3664 unfortunately, debugging output from the DNS resolver is written to stdout
3665 rather than stderr.
3666
3667 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3668 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3669 However, the &`pid`& selector is forced when debugging is turned on for a
3670 daemon, which then passes it on to any re-executed Exims. Exim also
3671 automatically adds the pid to debug lines when several remote deliveries are
3672 run in parallel.
3673
3674 The &`timestamp`& selector causes the current time to be inserted at the start
3675 of all debug output lines. This can be useful when trying to track down delays
3676 in processing.
3677
3678 .cindex debugging "UTF-8 in"
3679 .cindex UTF-8 "in debug output"
3680 The &`noutf8`& selector disables the use of
3681 UTF-8 line-drawing characters to group related information.
3682 When disabled. ascii-art is used instead.
3683 Using the &`+all`& option does not set this modifier,
3684
3685 If the &%debug_print%& option is set in any driver, it produces output whenever
3686 any debugging is selected, or if &%-v%& is used.
3687
3688 .vitem &%-dd%&<&'debug&~options'&>
3689 .oindex "&%-dd%&"
3690 This option behaves exactly like &%-d%& except when used on a command that
3691 starts a daemon process. In that case, debugging is turned off for the
3692 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3693 behaviour of the daemon without creating as much output as full debugging does.
3694
3695 .vitem &%-dropcr%&
3696 .oindex "&%-dropcr%&"
3697 This is an obsolete option that is now a no-op. It used to affect the way Exim
3698 handled CR and LF characters in incoming messages. What happens now is
3699 described in section &<<SECTlineendings>>&.
3700
3701 .vitem &%-E%&
3702 .oindex "&%-E%&"
3703 .cindex "bounce message" "generating"
3704 This option specifies that an incoming message is a locally-generated delivery
3705 failure report. It is used internally by Exim when handling delivery failures
3706 and is not intended for external use. Its only effect is to stop Exim
3707 generating certain messages to the postmaster, as otherwise message cascades
3708 could occur in some situations. As part of the same option, a message id may
3709 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3710 new message contains the id, following &"R="&, as a cross-reference.
3711
3712 .vitem &%-e%&&'x'&
3713 .oindex "&%-e%&&'x'&"
3714 There are a number of Sendmail options starting with &%-oe%& which seem to be
3715 called by various programs without the leading &%o%& in the option. For
3716 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3717 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3718
3719 .vitem &%-F%&&~<&'string'&>
3720 .oindex "&%-F%&"
3721 .cindex "sender" "name"
3722 .cindex "name" "of sender"
3723 This option sets the sender's full name for use when a locally-generated
3724 message is being accepted. In the absence of this option, the user's &'gecos'&
3725 entry from the password data is used. As users are generally permitted to alter
3726 their &'gecos'& entries, no security considerations are involved. White space
3727 between &%-F%& and the <&'string'&> is optional.
3728
3729 .vitem &%-f%&&~<&'address'&>
3730 .oindex "&%-f%&"
3731 .cindex "sender" "address"
3732 .cindex "address" "sender"
3733 .cindex "trusted users"
3734 .cindex "envelope from"
3735 .cindex "envelope sender"
3736 .cindex "user" "trusted"
3737 This option sets the address of the envelope sender of a locally-generated
3738 message (also known as the return path). The option can normally be used only
3739 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3740 users to use it.
3741
3742 Processes running as root or the Exim user are always trusted. Other
3743 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3744 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3745 of a local message is set to the caller's login name at the default qualify
3746 domain.
3747
3748 There is one exception to the restriction on the use of &%-f%&: an empty sender
3749 can be specified by any user, trusted or not, to create a message that can
3750 never provoke a bounce. An empty sender can be specified either as an empty
3751 string, or as a pair of angle brackets with nothing between them, as in these
3752 examples of shell commands:
3753 .code
3754 exim -f '<>' user@domain
3755 exim -f "" user@domain
3756 .endd
3757 In addition, the use of &%-f%& is not restricted when testing a filter file
3758 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3759 &%-bv%& options.
3760
3761 Allowing untrusted users to change the sender address does not of itself make
3762 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3763 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3764 though this can be overridden by setting &%no_local_from_check%&.
3765
3766 White
3767 .cindex "&""From""& line"
3768 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3769 given as two arguments or one combined argument). The sender of a
3770 locally-generated message can also be set (when permitted) by an initial
3771 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3772 if &%-f%& is also present, it overrides &"From&~"&.
3773
3774 .vitem &%-G%&
3775 .oindex "&%-G%&"
3776 .cindex "submission fixups, suppressing (command-line)"
3777 This option is equivalent to an ACL applying:
3778 .code
3779 control = suppress_local_fixups
3780 .endd
3781 for every message received.  Note that Sendmail will complain about such
3782 bad formatting, where Exim silently just does not fix it up.  This may change
3783 in future.
3784
3785 As this affects audit information, the caller must be a trusted user to use
3786 this option.
3787
3788 .vitem &%-h%&&~<&'number'&>
3789 .oindex "&%-h%&"
3790 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3791 This option is accepted for compatibility with Sendmail, but has no effect. (In
3792 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3793 headers.)
3794
3795 .vitem &%-i%&
3796 .oindex "&%-i%&"
3797 .cindex "Solaris" "&'mail'& command"
3798 .cindex "dot" "in incoming non-SMTP message"
3799 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3800 line by itself should not terminate an incoming, non-SMTP message. I can find
3801 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3802 command in Solaris 2.4 uses it. See also &%-ti%&.
3803
3804 .vitem &%-L%&&~<&'tag'&>
3805 .oindex "&%-L%&"
3806 .cindex "syslog" "process name; set with flag"
3807 This option is equivalent to setting &%syslog_processname%& in the config
3808 file and setting &%log_file_path%& to &`syslog`&.
3809 Its use is restricted to administrators.  The configuration file has to be
3810 read and parsed, to determine access rights, before this is set and takes
3811 effect, so early configuration file errors will not honour this flag.
3812
3813 The tag should not be longer than 32 characters.
3814
3815 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3816 .oindex "&%-M%&"
3817 .cindex "forcing delivery"
3818 .cindex "delivery" "forcing attempt"
3819 .cindex "frozen messages" "forcing delivery"
3820 This option requests Exim to run a delivery attempt on each message in turn. If
3821 any of the messages are frozen, they are automatically thawed before the
3822 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3823 and &%hold_domains%& are ignored.
3824
3825 Retry
3826 .cindex "hints database" "overriding retry hints"
3827 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3828 the normal retry time has not yet been reached. This option requires the caller
3829 to be an admin user. However, there is an option called &%prod_requires_admin%&
3830 which can be set false to relax this restriction (and also the same requirement
3831 for the &%-q%&, &%-R%&, and &%-S%& options).
3832
3833 The deliveries happen synchronously, that is, the original Exim process does
3834 not terminate until all the delivery attempts have finished. No output is
3835 produced unless there is a serious error. If you want to see what is happening,
3836 use the &%-v%& option as well, or inspect Exim's main log.
3837
3838 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3839 .oindex "&%-Mar%&"
3840 .cindex "message" "adding recipients"
3841 .cindex "recipient" "adding"
3842 This option requests Exim to add the addresses to the list of recipients of the
3843 message (&"ar"& for &"add recipients"&). The first argument must be a message
3844 id, and the remaining ones must be email addresses. However, if the message is
3845 active (in the middle of a delivery attempt), it is not altered. This option
3846 can be used only by an admin user.
3847
3848 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3849         &~<&'message&~id'&>"
3850 .oindex "&%-MC%&"
3851 .cindex "SMTP" "passed connection"
3852 .cindex "SMTP" "multiple deliveries"
3853 .cindex "multiple SMTP deliveries"
3854 This option is not intended for use by external callers. It is used internally
3855 by Exim to invoke another instance of itself to deliver a waiting message using
3856 an existing SMTP connection, which is passed as the standard input. Details are
3857 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3858 must be root or the Exim user in order to use it.
3859
3860 .vitem &%-MCA%&
3861 .oindex "&%-MCA%&"
3862 This option is not intended for use by external callers. It is used internally
3863 by Exim in conjunction with the &%-MC%& option. It signifies that the
3864 connection to the remote host has been authenticated.
3865
3866 .vitem &%-MCD%&
3867 .oindex "&%-MCD%&"
3868 This option is not intended for use by external callers. It is used internally
3869 by Exim in conjunction with the &%-MC%& option. It signifies that the
3870 remote host supports the ESMTP &_DSN_& extension.
3871
3872 .vitem &%-MCd%&
3873 .oindex "&%-MCd%&"
3874 This option is not intended for use by external callers. It is used internally
3875 by Exim in conjunction with the &%-d%& option
3876 to pass on an information string on the purpose of the process.
3877
3878 .vitem &%-MCG%&&~<&'queue&~name'&>
3879 .oindex "&%-MCG%&"
3880 This option is not intended for use by external callers. It is used internally
3881 by Exim in conjunction with the &%-MC%& option. It signifies that an
3882 alternate queue is used, named by the following argument.
3883
3884 .vitem &%-MCK%&
3885 .oindex "&%-MCK%&"
3886 This option is not intended for use by external callers. It is used internally
3887 by Exim in conjunction with the &%-MC%& option. It signifies that a
3888 remote host supports the ESMTP &_CHUNKING_& extension.
3889
3890 .vitem &%-MCP%&
3891 .oindex "&%-MCP%&"
3892 This option is not intended for use by external callers. It is used internally
3893 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3894 which Exim is connected supports pipelining.
3895
3896 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3897 .oindex "&%-MCQ%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option when the original delivery was
3900 started by a queue runner. It passes on the process id of the queue runner,
3901 together with the file descriptor number of an open pipe. Closure of the pipe
3902 signals the final completion of the sequence of processes that are passing
3903 messages through the same SMTP connection.
3904
3905 .new
3906 .vitem &%-MCq%&&~<&'recipient&~address'&>&~<&'size'&>
3907 .oindex "&%-MCq%&"
3908 This option is not intended for use by external callers. It is used internally
3909 by Exim to implement quota checking for local users.
3910 .wen
3911
3912 .vitem &%-MCS%&
3913 .oindex "&%-MCS%&"
3914 This option is not intended for use by external callers. It is used internally
3915 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3916 ESMTP SIZE option should be used on messages delivered down the existing
3917 connection.
3918
3919 .vitem &%-MCT%&
3920 .oindex "&%-MCT%&"
3921 This option is not intended for use by external callers. It is used internally
3922 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3923 host to which Exim is connected supports TLS encryption.
3924
3925 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3926 .oindex "&%-MCt%&"
3927 This option is not intended for use by external callers. It is used internally
3928 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3929 connection is being proxied by a parent process for handling TLS encryption.
3930 The arguments give the local address and port being proxied, and the TLS cipher.
3931
3932 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3933 .oindex "&%-Mc%&"
3934 .cindex "hints database" "not overridden by &%-Mc%&"
3935 .cindex "delivery" "manually started &-- not forced"
3936 This option requests Exim to run a delivery attempt on each message, in turn,
3937 but unlike the &%-M%& option, it does check for retry hints, and respects any
3938 that are found. This option is not very useful to external callers. It is
3939 provided mainly for internal use by Exim when it needs to re-invoke itself in
3940 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3941 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3942 respects retry times and other options such as &%hold_domains%& that are
3943 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3944 If you want to run a specific delivery as if in a queue run, you should use
3945 &%-q%& with a message id argument. A distinction between queue run deliveries
3946 and other deliveries is made in one or two places.
3947
3948 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3949 .oindex "&%-Mes%&"
3950 .cindex "message" "changing sender"
3951 .cindex "sender" "changing"
3952 This option requests Exim to change the sender address in the message to the
3953 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3954 &"edit sender"&). There must be exactly two arguments. The first argument must
3955 be a message id, and the second one an email address. However, if the message
3956 is active (in the middle of a delivery attempt), its status is not altered.
3957 This option can be used only by an admin user.
3958
3959 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3960 .oindex "&%-Mf%&"
3961 .cindex "freezing messages"
3962 .cindex "message" "manually freezing"
3963 This option requests Exim to mark each listed message as &"frozen"&. This
3964 prevents any delivery attempts taking place until the message is &"thawed"&,
3965 either manually or as a result of the &%auto_thaw%& configuration option.
3966 However, if any of the messages are active (in the middle of a delivery
3967 attempt), their status is not altered. This option can be used only by an admin
3968 user.
3969
3970 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3971 .oindex "&%-Mg%&"
3972 .cindex "giving up on messages"
3973 .cindex "message" "abandoning delivery attempts"
3974 .cindex "delivery" "abandoning further attempts"
3975 This option requests Exim to give up trying to deliver the listed messages,
3976 including any that are frozen. However, if any of the messages are active,
3977 their status is not altered. For non-bounce messages, a delivery error message
3978 is sent to the sender, containing the text &"cancelled by administrator"&.
3979 Bounce messages are just discarded. This option can be used only by an admin
3980 user.
3981
3982 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3983 .oindex "&%-MG%&"
3984 .cindex queue named
3985 .cindex "named queues" "moving messages"
3986 .cindex "queue" "moving messages"
3987 This option requests that each listed message be moved from its current
3988 queue to the given named queue.
3989 The destination queue name argument is required, but can be an empty
3990 string to define the default queue.
3991 If the messages are not currently located in the default queue,
3992 a &%-qG<name>%& option will be required to define the source queue.
3993
3994 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3995 .oindex "&%-Mmad%&"
3996 .cindex "delivery" "cancelling all"
3997 This option requests Exim to mark all the recipient addresses in the messages
3998 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3999 message is active (in the middle of a delivery attempt), its status is not
4000 altered. This option can be used only by an admin user.
4001
4002 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4003 .oindex "&%-Mmd%&"
4004 .cindex "delivery" "cancelling by address"
4005 .cindex "recipient" "removing"
4006 .cindex "removing recipients"
4007 This option requests Exim to mark the given addresses as already delivered
4008 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4009 the remaining ones must be email addresses. These are matched to recipient
4010 addresses in the message in a case-sensitive manner. If the message is active
4011 (in the middle of a delivery attempt), its status is not altered. This option
4012 can be used only by an admin user.
4013
4014 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4015 .oindex "&%-Mrm%&"
4016 .cindex "removing messages"
4017 .cindex "abandoning mail"
4018 .cindex "message" "manually discarding"
4019 This option requests Exim to remove the given messages from the queue. No
4020 bounce messages are sent; each message is simply forgotten. However, if any of
4021 the messages are active, their status is not altered. This option can be used
4022 only by an admin user or by the user who originally caused the message to be
4023 placed in the queue.
4024
4025 . .new
4026 . .vitem &%-MS%&
4027 . .oindex "&%-MS%&"
4028 . .cindex REQUIRETLS
4029 . This option is used to request REQUIRETLS processing on the message.
4030 . It is used internally by Exim in conjunction with -E when generating
4031 . a bounce message.
4032 . .wen
4033
4034 .vitem &%-Mset%&&~<&'message&~id'&>
4035 .oindex "&%-Mset%&"
4036 .cindex "testing" "string expansion"
4037 .cindex "expansion" "testing"
4038 This option is useful only in conjunction with &%-be%& (that is, when testing
4039 string expansions). Exim loads the given message from its spool before doing
4040 the test expansions, thus setting message-specific variables such as
4041 &$message_size$& and the header variables. The &$recipients$& variable is made
4042 available. This feature is provided to make it easier to test expansions that
4043 make use of these variables. However, this option can be used only by an admin
4044 user. See also &%-bem%&.
4045
4046 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4047 .oindex "&%-Mt%&"
4048 .cindex "thawing messages"
4049 .cindex "unfreezing messages"
4050 .cindex "frozen messages" "thawing"
4051 .cindex "message" "thawing frozen"
4052 This option requests Exim to &"thaw"& any of the listed messages that are
4053 &"frozen"&, so that delivery attempts can resume. However, if any of the
4054 messages are active, their status is not altered. This option can be used only
4055 by an admin user.
4056
4057 .vitem &%-Mvb%&&~<&'message&~id'&>
4058 .oindex "&%-Mvb%&"
4059 .cindex "listing" "message body"
4060 .cindex "message" "listing body of"
4061 This option causes the contents of the message body (-D) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvc%&&~<&'message&~id'&>
4065 .oindex "&%-Mvc%&"
4066 .cindex "message" "listing in RFC 2822 format"
4067 .cindex "listing" "message in RFC 2822 format"
4068 This option causes a copy of the complete message (header lines plus body) to
4069 be written to the standard output in RFC 2822 format. This option can be used
4070 only by an admin user.
4071
4072 .vitem &%-Mvh%&&~<&'message&~id'&>
4073 .oindex "&%-Mvh%&"
4074 .cindex "listing" "message headers"
4075 .cindex "header lines" "listing"
4076 .cindex "message" "listing header lines"
4077 This option causes the contents of the message headers (-H) spool file to be
4078 written to the standard output. This option can be used only by an admin user.
4079
4080 .vitem &%-Mvl%&&~<&'message&~id'&>
4081 .oindex "&%-Mvl%&"
4082 .cindex "listing" "message log"
4083 .cindex "message" "listing message log"
4084 This option causes the contents of the message log spool file to be written to
4085 the standard output. This option can be used only by an admin user.
4086
4087 .vitem &%-m%&
4088 .oindex "&%-m%&"
4089 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4090 treats it that way too.
4091
4092 .vitem &%-N%&
4093 .oindex "&%-N%&"
4094 .cindex "debugging" "&%-N%& option"
4095 .cindex "debugging" "suppressing delivery"
4096 This is a debugging option that inhibits delivery of a message at the transport
4097 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4098 it just doesn't actually transport the message, but instead behaves as if it
4099 had successfully done so. However, it does not make any updates to the retry
4100 database, and the log entries for deliveries are flagged with &"*>"& rather
4101 than &"=>"&.
4102
4103 Because &%-N%& discards any message to which it applies, only root or the Exim
4104 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4105 words, an ordinary user can use it only when supplying an incoming message to
4106 which it will apply. Although transportation never fails when &%-N%& is set, an
4107 address may be deferred because of a configuration problem on a transport, or a
4108 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4109 the message, and applies to any subsequent delivery attempts that may happen
4110 for that message.
4111
4112 .vitem &%-n%&
4113 .oindex "&%-n%&"
4114 This option is interpreted by Sendmail to mean &"no aliasing"&.
4115 For normal modes of operation, it is ignored by Exim.
4116 When combined with &%-bP%& it makes the output more terse (suppresses
4117 option names, environment values and config pretty printing).
4118
4119 .vitem &%-O%&&~<&'data'&>
4120 .oindex "&%-O%&"
4121 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4122 Exim.
4123
4124 .vitem &%-oA%&&~<&'file&~name'&>
4125 .oindex "&%-oA%&"
4126 .cindex "Sendmail compatibility" "&%-oA%& option"
4127 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4128 alternative alias filename. Exim handles &%-bi%& differently; see the
4129 description above.
4130
4131 .vitem &%-oB%&&~<&'n'&>
4132 .oindex "&%-oB%&"
4133 .cindex "SMTP" "passed connection"
4134 .cindex "SMTP" "multiple deliveries"
4135 .cindex "multiple SMTP deliveries"
4136 This is a debugging option which limits the maximum number of messages that can
4137 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4138 transport. If <&'n'&> is omitted, the limit is set to 1.
4139
4140 .vitem &%-odb%&
4141 .oindex "&%-odb%&"
4142 .cindex "background delivery"
4143 .cindex "delivery" "in the background"
4144 This option applies to all modes in which Exim accepts incoming messages,
4145 including the listening daemon. It requests &"background"& delivery of such
4146 messages, which means that the accepting process automatically starts a
4147 delivery process for each message received, but does not wait for the delivery
4148 processes to finish.
4149
4150 When all the messages have been received, the reception process exits,
4151 leaving the delivery processes to finish in their own time. The standard output
4152 and error streams are closed at the start of each delivery process.
4153 This is the default action if none of the &%-od%& options are present.
4154
4155 If one of the queueing options in the configuration file
4156 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4157 overrides it if &%queue_only_override%& is set true, which is the default
4158 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4159
4160 .vitem &%-odf%&
4161 .oindex "&%-odf%&"
4162 .cindex "foreground delivery"
4163 .cindex "delivery" "in the foreground"
4164 This option requests &"foreground"& (synchronous) delivery when Exim has
4165 accepted a locally-generated message. (For the daemon it is exactly the same as
4166 &%-odb%&.) A delivery process is automatically started to deliver the message,
4167 and Exim waits for it to complete before proceeding.
4168
4169 The original Exim reception process does not finish until the delivery
4170 process for the final message has ended. The standard error stream is left open
4171 during deliveries.
4172
4173 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4174 false and one of the queueing options in the configuration file is in effect.
4175
4176 If there is a temporary delivery error during foreground delivery, the
4177 message is left in the queue for later delivery, and the original reception
4178 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4179 restricted configuration that never queues messages.
4180
4181
4182 .vitem &%-odi%&
4183 .oindex "&%-odi%&"
4184 This option is synonymous with &%-odf%&. It is provided for compatibility with
4185 Sendmail.
4186
4187 .vitem &%-odq%&
4188 .oindex "&%-odq%&"
4189 .cindex "non-immediate delivery"
4190 .cindex "delivery" "suppressing immediate"
4191 .cindex "queueing incoming messages"
4192 This option applies to all modes in which Exim accepts incoming messages,
4193 including the listening daemon. It specifies that the accepting process should
4194 not automatically start a delivery process for each message received. Messages
4195 are placed in the queue, and remain there until a subsequent queue runner
4196 process encounters them. There are several configuration options (such as
4197 &%queue_only%&) that can be used to queue incoming messages under certain
4198 conditions. This option overrides all of them and also &%-odqs%&. It always
4199 forces queueing.
4200
4201 .vitem &%-odqs%&
4202 .oindex "&%-odqs%&"
4203 .cindex "SMTP" "delaying delivery"
4204 .cindex "first pass routing"
4205 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4206 However, like &%-odb%& and &%-odi%&, this option has no effect if
4207 &%queue_only_override%& is false and one of the queueing options in the
4208 configuration file is in effect.
4209
4210 When &%-odqs%& does operate, a delivery process is started for each incoming
4211 message, in the background by default, but in the foreground if &%-odi%& is
4212 also present. The recipient addresses are routed, and local deliveries are done
4213 in the normal way. However, if any SMTP deliveries are required, they are not
4214 done at this time, so the message remains in the queue until a subsequent queue
4215 runner process encounters it. Because routing was done, Exim knows which
4216 messages are waiting for which hosts, and so a number of messages for the same
4217 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4218 configuration option has the same effect for specific domains. See also the
4219 &%-qq%& option.
4220
4221 .vitem &%-oee%&
4222 .oindex "&%-oee%&"
4223 .cindex "error" "reporting"
4224 If an error is detected while a non-SMTP message is being received (for
4225 example, a malformed address), the error is reported to the sender in a mail
4226 message.
4227
4228 .cindex "return code" "for &%-oee%&"
4229 Provided
4230 this error message is successfully sent, the Exim receiving process
4231 exits with a return code of zero. If not, the return code is 2 if the problem
4232 is that the original message has no recipients, or 1 for any other error.
4233 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4234
4235 .vitem &%-oem%&
4236 .oindex "&%-oem%&"
4237 .cindex "error" "reporting"
4238 .cindex "return code" "for &%-oem%&"
4239 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4240 return code, whether or not the error message was successfully sent.
4241 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4242
4243 .vitem &%-oep%&
4244 .oindex "&%-oep%&"
4245 .cindex "error" "reporting"
4246 If an error is detected while a non-SMTP message is being received, the
4247 error is reported by writing a message to the standard error file (stderr).
4248 .cindex "return code" "for &%-oep%&"
4249 The return code is 1 for all errors.
4250
4251 .vitem &%-oeq%&
4252 .oindex "&%-oeq%&"
4253 .cindex "error" "reporting"
4254 This option is supported for compatibility with Sendmail, but has the same
4255 effect as &%-oep%&.
4256
4257 .vitem &%-oew%&
4258 .oindex "&%-oew%&"
4259 .cindex "error" "reporting"
4260 This option is supported for compatibility with Sendmail, but has the same
4261 effect as &%-oem%&.
4262
4263 .vitem &%-oi%&
4264 .oindex "&%-oi%&"
4265 .cindex "dot" "in incoming non-SMTP message"
4266 This option, which has the same effect as &%-i%&, specifies that a dot on a
4267 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4268 single dot does terminate, though Exim does no special processing for other
4269 lines that start with a dot. This option is set by default if Exim is called as
4270 &'rmail'&. See also &%-ti%&.
4271
4272 .vitem &%-oitrue%&
4273 .oindex "&%-oitrue%&"
4274 This option is treated as synonymous with &%-oi%&.
4275
4276 .vitem &%-oMa%&&~<&'host&~address'&>
4277 .oindex "&%-oMa%&"
4278 .cindex "sender" "host address, specifying for local message"
4279 A number of options starting with &%-oM%& can be used to set values associated
4280 with remote hosts on locally-submitted messages (that is, messages not received
4281 over TCP/IP). These options can be used by any caller in conjunction with the
4282 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4283 other circumstances, they are ignored unless the caller is trusted.
4284
4285 The &%-oMa%& option sets the sender host address. This may include a port
4286 number at the end, after a full stop (period). For example:
4287 .code
4288 exim -bs -oMa 10.9.8.7.1234
4289 .endd
4290 An alternative syntax is to enclose the IP address in square brackets,
4291 followed by a colon and the port number:
4292 .code
4293 exim -bs -oMa [10.9.8.7]:1234
4294 .endd
4295 The IP address is placed in the &$sender_host_address$& variable, and the
4296 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4297 are present on the command line, the sender host IP address is taken from
4298 whichever one is last.
4299
4300 .vitem &%-oMaa%&&~<&'name'&>
4301 .oindex "&%-oMaa%&"
4302 .cindex "authentication" "name, specifying for local message"
4303 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4304 option sets the value of &$sender_host_authenticated$& (the authenticator
4305 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4306 This option can be used with &%-bh%& and &%-bs%& to set up an
4307 authenticated SMTP session without actually using the SMTP AUTH command.
4308
4309 .vitem &%-oMai%&&~<&'string'&>
4310 .oindex "&%-oMai%&"
4311 .cindex "authentication" "id, specifying for local message"
4312 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4313 option sets the value of &$authenticated_id$& (the id that was authenticated).
4314 This overrides the default value (the caller's login id, except with &%-bh%&,
4315 where there is no default) for messages from local sources. See chapter
4316 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4317
4318 .vitem &%-oMas%&&~<&'address'&>
4319 .oindex "&%-oMas%&"
4320 .cindex "authentication" "sender, specifying for local message"
4321 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4322 option sets the authenticated sender value in &$authenticated_sender$&. It
4323 overrides the sender address that is created from the caller's login id for
4324 messages from local sources, except when &%-bh%& is used, when there is no
4325 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4326 specified on a MAIL command overrides this value. See chapter
4327 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4328
4329 .vitem &%-oMi%&&~<&'interface&~address'&>
4330 .oindex "&%-oMi%&"
4331 .cindex "interface" "address, specifying for local message"
4332 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4333 option sets the IP interface address value. A port number may be included,
4334 using the same syntax as for &%-oMa%&. The interface address is placed in
4335 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4336
4337 .vitem &%-oMm%&&~<&'message&~reference'&>
4338 .oindex "&%-oMm%&"
4339 .cindex "message reference" "message reference, specifying for local message"
4340 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4341 option sets the message reference, e.g. message-id, and is logged during
4342 delivery. This is useful when some kind of audit trail is required to tie
4343 messages together. The format of the message reference is checked and will
4344 abort if the format is invalid. The option will only be accepted if exim is
4345 running in trusted mode, not as any regular user.
4346
4347 The best example of a message reference is when Exim sends a bounce message.
4348 The message reference is the message-id of the original message for which Exim
4349 is sending the bounce.
4350
4351 .vitem &%-oMr%&&~<&'protocol&~name'&>
4352 .oindex "&%-oMr%&"
4353 .cindex "protocol, specifying for local message"
4354 .vindex "&$received_protocol$&"
4355 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4356 option sets the received protocol value that is stored in
4357 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4358 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4359 SMTP protocol names (see the description of &$received_protocol$& in section
4360 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4361 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4362 be set by &%-oMr%&. Repeated use of this option is not supported.
4363
4364 .vitem &%-oMs%&&~<&'host&~name'&>
4365 .oindex "&%-oMs%&"
4366 .cindex "sender" "host name, specifying for local message"
4367 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4368 option sets the sender host name in &$sender_host_name$&. When this option is
4369 present, Exim does not attempt to look up a host name from an IP address; it
4370 uses the name it is given.
4371
4372 .vitem &%-oMt%&&~<&'ident&~string'&>
4373 .oindex "&%-oMt%&"
4374 .cindex "sender" "ident string, specifying for local message"
4375 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4376 option sets the sender ident value in &$sender_ident$&. The default setting for
4377 local callers is the login id of the calling process, except when &%-bh%& is
4378 used, when there is no default.
4379
4380 .vitem &%-om%&
4381 .oindex "&%-om%&"
4382 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4383 In Sendmail, this option means &"me too"&, indicating that the sender of a
4384 message should receive a copy of the message if the sender appears in an alias
4385 expansion. Exim always does this, so the option does nothing.
4386
4387 .vitem &%-oo%&
4388 .oindex "&%-oo%&"
4389 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4390 This option is ignored. In Sendmail it specifies &"old style headers"&,
4391 whatever that means.
4392
4393 .vitem &%-oP%&&~<&'path'&>
4394 .oindex "&%-oP%&"
4395 .cindex "pid (process id)" "of daemon"
4396 .cindex "daemon" "process id (pid)"
4397 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4398 value. The option specifies the file to which the process id of the daemon is
4399 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4400 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4401 because in those cases, the normal pid file is not used.
4402
4403 .vitem &%-oPX%&
4404 .oindex "&%-oPX%&"
4405 .cindex "pid (process id)" "of daemon"
4406 .cindex "daemon" "process id (pid)"
4407 This option is not intended for general use.
4408 The daemon uses it when terminating due to a SIGTEM, possibly in
4409 combination with &%-oP%&&~<&'path'&>.
4410 It causes the pid file to be removed.
4411
4412 .vitem &%-or%&&~<&'time'&>
4413 .oindex "&%-or%&"
4414 .cindex "timeout" "for non-SMTP input"
4415 This option sets a timeout value for incoming non-SMTP messages. If it is not
4416 set, Exim will wait forever for the standard input. The value can also be set
4417 by the &%receive_timeout%& option. The format used for specifying times is
4418 described in section &<<SECTtimeformat>>&.
4419
4420 .vitem &%-os%&&~<&'time'&>
4421 .oindex "&%-os%&"
4422 .cindex "timeout" "for SMTP input"
4423 .cindex "SMTP" "input timeout"
4424 This option sets a timeout value for incoming SMTP messages. The timeout
4425 applies to each SMTP command and block of data. The value can also be set by
4426 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4427 for specifying times is described in section &<<SECTtimeformat>>&.
4428
4429 .vitem &%-ov%&
4430 .oindex "&%-ov%&"
4431 This option has exactly the same effect as &%-v%&.
4432
4433 .vitem &%-oX%&&~<&'number&~or&~string'&>
4434 .oindex "&%-oX%&"
4435 .cindex "TCP/IP" "setting listening ports"
4436 .cindex "TCP/IP" "setting listening interfaces"
4437 .cindex "port" "receiving TCP/IP"
4438 This option is relevant only when the &%-bd%& (start listening daemon) option
4439 is also given. It controls which ports and interfaces the daemon uses. Details
4440 of the syntax, and how it interacts with configuration file options, are given
4441 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4442 file is written unless &%-oP%& is also present to specify a pid filename.
4443
4444 .new
4445 .vitem &%-oY%&
4446 .oindex &%-oY%&
4447 .cindex "daemon notifier socket"
4448 This option controls the creation of an inter-process communications endpoint
4449 by the Exim daemon.
4450 It is only relevant when the &%-bd%& (start listening daemon) option is also
4451 given.
4452 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4453 option is also present.
4454 If this option is given then the socket will not be created.  This could be
4455 required if the system is running multiple daemons.
4456
4457 The socket is currently used for
4458 .ilist
4459 fast ramp-up of queue runner processes
4460 .next
4461 obtaining a current queue size
4462 .endlist
4463 .wen
4464
4465 .vitem &%-pd%&
4466 .oindex "&%-pd%&"
4467 .cindex "Perl" "starting the interpreter"
4468 This option applies when an embedded Perl interpreter is linked with Exim (see
4469 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4470 option, forcing the starting of the interpreter to be delayed until it is
4471 needed.
4472
4473 .vitem &%-ps%&
4474 .oindex "&%-ps%&"
4475 .cindex "Perl" "starting the interpreter"
4476 This option applies when an embedded Perl interpreter is linked with Exim (see
4477 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4478 option, forcing the starting of the interpreter to occur as soon as Exim is
4479 started.
4480
4481 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4482 .oindex "&%-p%&"
4483 For compatibility with Sendmail, this option is equivalent to
4484 .display
4485 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4486 .endd
4487 It sets the incoming protocol and host name (for trusted callers). The
4488 host name and its colon can be omitted when only the protocol is to be set.
4489 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4490 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4491 or &`s`& using this option (but that does not seem a real limitation).
4492 Repeated use of this option is not supported.
4493
4494 .vitem &%-q%&
4495 .oindex "&%-q%&"
4496 .cindex "queue runner" "starting manually"
4497 This option is normally restricted to admin users. However, there is a
4498 configuration option called &%prod_requires_admin%& which can be set false to
4499 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4500 and &%-S%& options).
4501
4502 .cindex "queue runner" "description of operation"
4503 If other commandline options do not specify an action,
4504 the &%-q%& option starts one queue runner process. This scans the queue of
4505 waiting messages, and runs a delivery process for each one in turn. It waits
4506 for each delivery process to finish before starting the next one. A delivery
4507 process may not actually do any deliveries if the retry times for the addresses
4508 have not been reached. Use &%-qf%& (see below) if you want to override this.
4509
4510 If
4511 .cindex "SMTP" "passed connection"
4512 .cindex "SMTP" "multiple deliveries"
4513 .cindex "multiple SMTP deliveries"
4514 the delivery process spawns other processes to deliver other messages down
4515 passed SMTP connections, the queue runner waits for these to finish before
4516 proceeding.
4517
4518 When all the queued messages have been considered, the original queue runner
4519 process terminates. In other words, a single pass is made over the waiting
4520 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4521 this to be repeated periodically.
4522
4523 Exim processes the waiting messages in an unpredictable order. It isn't very
4524 random, but it is likely to be different each time, which is all that matters.
4525 If one particular message screws up a remote MTA, other messages to the same
4526 MTA have a chance of getting through if they get tried first.
4527
4528 It is possible to cause the messages to be processed in lexical message id
4529 order, which is essentially the order in which they arrived, by setting the
4530 &%queue_run_in_order%& option, but this is not recommended for normal use.
4531
4532 .vitem &%-q%&<&'qflags'&>
4533 The &%-q%& option may be followed by one or more flag letters that change its
4534 behaviour. They are all optional, but if more than one is present, they must
4535 appear in the correct order. Each flag is described in a separate item below.
4536
4537 .vitem &%-qq...%&
4538 .oindex "&%-qq%&"
4539 .cindex "queue" "double scanning"
4540 .cindex "queue" "routing"
4541 .cindex "routing" "whole queue before delivery"
4542 .cindex "first pass routing"
4543 .cindex "queue runner" "two phase"
4544 An option starting with &%-qq%& requests a two-stage queue run. In the first
4545 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4546 every domain. Addresses are routed, local deliveries happen, but no remote
4547 transports are run.
4548
4549 Performance will be best if the &%queue_run_in_order%& option is false.
4550 If that is so and the &%queue_fast_ramp%& option is true then
4551 in the first phase of the run,
4552 once a threshold number of messages are routed for a given host,
4553 a delivery process is forked in parallel with the rest of the scan.
4554
4555 .cindex "hints database" "remembering routing"
4556 The hints database that remembers which messages are waiting for specific hosts
4557 is updated, as if delivery to those hosts had been deferred. After this is
4558 complete, a second, normal queue scan happens, with routing and delivery taking
4559 place as normal. Messages that are routed to the same host should mostly be
4560 delivered down a single SMTP
4561 .cindex "SMTP" "passed connection"
4562 .cindex "SMTP" "multiple deliveries"
4563 .cindex "multiple SMTP deliveries"
4564 connection because of the hints that were set up during the first queue scan.
4565 This option may be useful for hosts that are connected to the Internet
4566 intermittently.
4567
4568 .vitem &%-q[q]i...%&
4569 .oindex "&%-qi%&"
4570 .cindex "queue" "initial delivery"
4571 If the &'i'& flag is present, the queue runner runs delivery processes only for
4572 those messages that haven't previously been tried. (&'i'& stands for &"initial
4573 delivery"&.) This can be helpful if you are putting messages in the queue using
4574 &%-odq%& and want a queue runner just to process the new messages.
4575
4576 .vitem &%-q[q][i]f...%&
4577 .oindex "&%-qf%&"
4578 .cindex "queue" "forcing delivery"
4579 .cindex "delivery" "forcing in queue run"
4580 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4581 message, whereas without &'f'& only those non-frozen addresses that have passed
4582 their retry times are tried.
4583
4584 .vitem &%-q[q][i]ff...%&
4585 .oindex "&%-qff%&"
4586 .cindex "frozen messages" "forcing delivery"
4587 If &'ff'& is present, a delivery attempt is forced for every message, whether
4588 frozen or not.
4589
4590 .vitem &%-q[q][i][f[f]]l%&
4591 .oindex "&%-ql%&"
4592 .cindex "queue" "local deliveries only"
4593 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4594 be done. If a message requires any remote deliveries, it remains in the queue
4595 for later delivery.
4596
4597 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4598 .oindex "&%-qG%&"
4599 .cindex queue named
4600 .cindex "named queues"  "deliver from"
4601 .cindex "queue" "delivering specific messages"
4602 If the &'G'& flag and a name is present, the queue runner operates on the
4603 queue with the given name rather than the default queue.
4604 The name should not contain a &'/'& character.
4605 For a periodic queue run (see below)
4606 append to the name a slash and a time value.
4607
4608 If other commandline options specify an action, a &'-qG<name>'& option
4609 will specify a queue to operate on.
4610 For example:
4611 .code
4612 exim -bp -qGquarantine
4613 mailq -qGquarantine
4614 exim -qGoffpeak -Rf @special.domain.example
4615 .endd
4616
4617 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4618 When scanning the queue, Exim can be made to skip over messages whose ids are
4619 lexically less than a given value by following the &%-q%& option with a
4620 starting message id. For example:
4621 .code
4622 exim -q 0t5C6f-0000c8-00
4623 .endd
4624 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4625 second message id is given, messages whose ids are lexically greater than it
4626 are also skipped. If the same id is given twice, for example,
4627 .code
4628 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4629 .endd
4630 just one delivery process is started, for that message. This differs from
4631 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4632 that it counts as a delivery from a queue run. Note that the selection
4633 mechanism does not affect the order in which the messages are scanned. There
4634 are also other ways of selecting specific sets of messages for delivery in a
4635 queue run &-- see &%-R%& and &%-S%&.
4636
4637 .vitem &%-q%&<&'qflags'&><&'time'&>
4638 .cindex "queue runner" "starting periodically"
4639 .cindex "periodic queue running"
4640 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4641 starting a queue runner process at intervals specified by the given time value
4642 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4643 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4644 single daemon process handles both functions. A common way of starting up a
4645 combined daemon at system boot time is to use a command such as
4646 .code
4647 /usr/exim/bin/exim -bd -q30m
4648 .endd
4649 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4650 process every 30 minutes.
4651
4652 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4653 pid file is written unless one is explicitly requested by the &%-oP%& option.
4654
4655 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4656 .oindex "&%-qR%&"
4657 This option is synonymous with &%-R%&. It is provided for Sendmail
4658 compatibility.
4659
4660 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4661 .oindex "&%-qS%&"
4662 This option is synonymous with &%-S%&.
4663
4664 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4665 .oindex "&%-R%&"
4666 .cindex "queue runner" "for specific recipients"
4667 .cindex "delivery" "to given domain"
4668 .cindex "domain" "delivery to"
4669 The <&'rsflags'&> may be empty, in which case the white space before the string
4670 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4671 which are the possible values for <&'rsflags'&>. White space is required if
4672 <&'rsflags'&> is not empty.
4673
4674 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4675 perform a single queue run, except that, when scanning the messages on the
4676 queue, Exim processes only those that have at least one undelivered recipient
4677 address containing the given string, which is checked in a case-independent
4678 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4679 regular expression; otherwise it is a literal string.
4680
4681 If you want to do periodic queue runs for messages with specific recipients,
4682 you can combine &%-R%& with &%-q%& and a time value. For example:
4683 .code
4684 exim -q25m -R @special.domain.example
4685 .endd
4686 This example does a queue run for messages with recipients in the given domain
4687 every 25 minutes. Any additional flags that are specified with &%-q%& are
4688 applied to each queue run.
4689
4690 Once a message is selected for delivery by this mechanism, all its addresses
4691 are processed. For the first selected message, Exim overrides any retry
4692 information and forces a delivery attempt for each undelivered address. This
4693 means that if delivery of any address in the first message is successful, any
4694 existing retry information is deleted, and so delivery attempts for that
4695 address in subsequently selected messages (which are processed without forcing)
4696 will run. However, if delivery of any address does not succeed, the retry
4697 information is updated, and in subsequently selected messages, the failing
4698 address will be skipped.
4699
4700 .cindex "frozen messages" "forcing delivery"
4701 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4702 all selected messages, not just the first; frozen messages are included when
4703 &'ff'& is present.
4704
4705 The &%-R%& option makes it straightforward to initiate delivery of all messages
4706 to a given domain after a host has been down for some time. When the SMTP
4707 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4708 effect is to run Exim with the &%-R%& option, but it can be configured to run
4709 an arbitrary command instead.
4710
4711 .vitem &%-r%&
4712 .oindex "&%-r%&"
4713 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4714
4715 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4716 .oindex "&%-S%&"
4717 .cindex "delivery" "from given sender"
4718 .cindex "queue runner" "for specific senders"
4719 This option acts like &%-R%& except that it checks the string against each
4720 message's sender instead of against the recipients. If &%-R%& is also set, both
4721 conditions must be met for a message to be selected. If either of the options
4722 has &'f'& or &'ff'& in its flags, the associated action is taken.
4723
4724 .vitem &%-Tqt%&&~<&'times'&>
4725 .oindex "&%-Tqt%&"
4726 This is an option that is exclusively for use by the Exim testing suite. It is not
4727 recognized when Exim is run normally. It allows for the setting up of explicit
4728 &"queue times"& so that various warning/retry features can be tested.
4729
4730 .vitem &%-t%&
4731 .oindex "&%-t%&"
4732 .cindex "recipient" "extracting from header lines"
4733 .cindex "&'Bcc:'& header line"
4734 .cindex "&'Cc:'& header line"
4735 .cindex "&'To:'& header line"
4736 When Exim is receiving a locally-generated, non-SMTP message on its standard
4737 input, the &%-t%& option causes the recipients of the message to be obtained
4738 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4739 from the command arguments. The addresses are extracted before any rewriting
4740 takes place and the &'Bcc:'& header line, if present, is then removed.
4741
4742 .cindex "Sendmail compatibility" "&%-t%& option"
4743 If the command has any arguments, they specify addresses to which the message
4744 is &'not'& to be delivered. That is, the argument addresses are removed from
4745 the recipients list obtained from the headers. This is compatible with Smail 3
4746 and in accordance with the documented behaviour of several versions of
4747 Sendmail, as described in man pages on a number of operating systems (e.g.
4748 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4749 argument addresses to those obtained from the headers, and the O'Reilly
4750 Sendmail book documents it that way. Exim can be made to add argument addresses
4751 instead of subtracting them by setting the option
4752 &%extract_addresses_remove_arguments%& false.
4753
4754 .cindex "&%Resent-%& header lines" "with &%-t%&"
4755 If there are any &%Resent-%& header lines in the message, Exim extracts
4756 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4757 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4758 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4759 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4760
4761 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4762 message is resent several times). The RFC also specifies that they should be
4763 added at the front of the message, and separated by &'Received:'& lines. It is
4764 not at all clear how &%-t%& should operate in the present of multiple sets,
4765 nor indeed exactly what constitutes a &"set"&.
4766 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4767 are often added at the end of the header, and if a message is resent more than
4768 once, it is common for the original set of &%Resent-%& headers to be renamed as
4769 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4770
4771 .vitem &%-ti%&
4772 .oindex "&%-ti%&"
4773 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4774 compatibility with Sendmail.
4775
4776 .vitem &%-tls-on-connect%&
4777 .oindex "&%-tls-on-connect%&"
4778 .cindex "TLS" "use without STARTTLS"
4779 .cindex "TLS" "automatic start"
4780 This option is available when Exim is compiled with TLS support. It forces all
4781 incoming SMTP connections to behave as if the incoming port is listed in the
4782 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4783 &<<CHAPTLS>>& for further details.
4784
4785
4786 .vitem &%-U%&
4787 .oindex "&%-U%&"
4788 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4789 Sendmail uses this option for &"initial message submission"&, and its
4790 documentation states that in future releases, it may complain about
4791 syntactically invalid messages rather than fixing them when this flag is not
4792 set. Exim ignores this option.
4793
4794 .vitem &%-v%&
4795 .oindex "&%-v%&"
4796 This option causes Exim to write information to the standard error stream,
4797 describing what it is doing. In particular, it shows the log lines for
4798 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4799 dialogue is shown. Some of the log lines shown may not actually be written to
4800 the log if the setting of &%log_selector%& discards them. Any relevant
4801 selectors are shown with each log line. If none are shown, the logging is
4802 unconditional.
4803
4804 .vitem &%-x%&
4805 .oindex "&%-x%&"
4806 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4807 National Language Support extended characters in the body of the mail item"&).
4808 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4809 this option.
4810
4811 .vitem &%-X%&&~<&'logfile'&>
4812 .oindex "&%-X%&"
4813 This option is interpreted by Sendmail to cause debug information to be sent
4814 to the named file.  It is ignored by Exim.
4815
4816 .vitem &%-z%&&~<&'log-line'&>
4817 .oindex "&%-z%&"
4818 This option writes its argument to Exim's logfile.
4819 Use is restricted to administrators; the intent is for operational notes.
4820 Quotes should be used to maintain a multi-word item as a single argument,
4821 under most shells.
4822 .endlist
4823
4824 .ecindex IIDclo1
4825 .ecindex IIDclo2
4826
4827
4828 . ////////////////////////////////////////////////////////////////////////////
4829 . Insert a stylized DocBook comment here, to identify the end of the command
4830 . line options. This is for the benefit of the Perl script that automatically
4831 . creates a man page for the options.
4832 . ////////////////////////////////////////////////////////////////////////////
4833
4834 .literal xml
4835 <!-- === End of command line options === -->
4836 .literal off
4837
4838
4839
4840
4841
4842 . ////////////////////////////////////////////////////////////////////////////
4843 . ////////////////////////////////////////////////////////////////////////////
4844
4845
4846 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4847          "The runtime configuration file"
4848
4849 .cindex "runtime configuration"
4850 .cindex "configuration file" "general description"
4851 .cindex "CONFIGURE_FILE"
4852 .cindex "configuration file" "errors in"
4853 .cindex "error" "in configuration file"
4854 .cindex "return code" "for bad configuration"
4855 Exim uses a single runtime configuration file that is read whenever an Exim
4856 binary is executed. Note that in normal operation, this happens frequently,
4857 because Exim is designed to operate in a distributed manner, without central
4858 control.
4859
4860 If a syntax error is detected while reading the configuration file, Exim
4861 writes a message on the standard error, and exits with a non-zero return code.
4862 The message is also written to the panic log. &*Note*&: Only simple syntax
4863 errors can be detected at this time. The values of any expanded options are
4864 not checked until the expansion happens, even when the expansion does not
4865 actually alter the string.
4866
4867 The name of the configuration file is compiled into the binary for security
4868 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4869 most configurations, this specifies a single file. However, it is permitted to
4870 give a colon-separated list of filenames, in which case Exim uses the first
4871 existing file in the list.
4872
4873 .cindex "EXIM_USER"
4874 .cindex "EXIM_GROUP"
4875 .cindex "CONFIGURE_OWNER"
4876 .cindex "CONFIGURE_GROUP"
4877 .cindex "configuration file" "ownership"
4878 .cindex "ownership" "configuration file"
4879 The runtime configuration file must be owned by root or by the user that is
4880 specified at compile time by the CONFIGURE_OWNER option (if set). The
4881 configuration file must not be world-writeable, or group-writeable unless its
4882 group is the root group or the one specified at compile time by the
4883 CONFIGURE_GROUP option.
4884
4885 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4886 to root, anybody who is able to edit the runtime configuration file has an
4887 easy way to run commands as root. If you specify a user or group in the
4888 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4889 who are members of that group will trivially be able to obtain root privileges.
4890
4891 Up to Exim version 4.72, the runtime configuration file was also permitted to
4892 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4893 since it offered a simple privilege escalation for any attacker who managed to
4894 compromise the Exim user account.
4895
4896 A default configuration file, which will work correctly in simple situations,
4897 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4898 defines just one filename, the installation process copies the default
4899 configuration to a new file of that name if it did not previously exist. If
4900 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4901 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4902 configuration.
4903
4904
4905
4906 .section "Using a different configuration file" "SECID40"
4907 .cindex "configuration file" "alternate"
4908 A one-off alternate configuration can be specified by the &%-C%& command line
4909 option, which may specify a single file or a list of files. However, when
4910 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4911 unless the argument for &%-C%& is identical to the built-in value from
4912 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4913 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4914 is useful mainly for checking the syntax of configuration files before
4915 installing them. No owner or group checks are done on a configuration file
4916 specified by &%-C%&, if root privilege has been dropped.
4917
4918 Even the Exim user is not trusted to specify an arbitrary configuration file
4919 with the &%-C%& option to be used with root privileges, unless that file is
4920 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4921 testing a configuration using &%-C%& right through message reception and
4922 delivery, even if the caller is root. The reception works, but by that time,
4923 Exim is running as the Exim user, so when it re-execs to regain privilege for
4924 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4925 can test reception and delivery using two separate commands (one to put a
4926 message in the queue, using &%-odq%&, and another to do the delivery, using
4927 &%-M%&).
4928
4929 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4930 prefix string with which any file named in a &%-C%& command line option must
4931 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4932 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4933 filename can be used with &%-C%&.
4934
4935 One-off changes to a configuration can be specified by the &%-D%& command line
4936 option, which defines and overrides values for macros used inside the
4937 configuration file. However, like &%-C%&, the use of this option by a
4938 non-privileged user causes Exim to discard its root privilege.
4939 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4940 completely disabled, and its use causes an immediate error exit.
4941
4942 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4943 to declare certain macro names trusted, such that root privilege will not
4944 necessarily be discarded.
4945 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4946 considered safe and, if &%-D%& only supplies macros from this list, and the
4947 values are acceptable, then Exim will not give up root privilege if the caller
4948 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4949 transition mechanism and is expected to be removed in the future.  Acceptable
4950 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4951
4952 Some sites may wish to use the same Exim binary on different machines that
4953 share a file system, but to use different configuration files on each machine.
4954 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4955 looks for a file whose name is the configuration filename followed by a dot
4956 and the machine's node name, as obtained from the &[uname()]& function. If this
4957 file does not exist, the standard name is tried. This processing occurs for
4958 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4959
4960 In some esoteric situations different versions of Exim may be run under
4961 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4962 help with this. See the comments in &_src/EDITME_& for details.
4963
4964
4965
4966 .section "Configuration file format" "SECTconffilfor"
4967 .cindex "configuration file" "format of"
4968 .cindex "format" "configuration file"
4969 Exim's configuration file is divided into a number of different parts. General
4970 option settings must always appear at the start of the file. The other parts
4971 are all optional, and may appear in any order. Each part other than the first
4972 is introduced by the word &"begin"& followed by at least one literal
4973 space, and the name of the part. The optional parts are:
4974
4975 .ilist
4976 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4977 &<<CHAPACL>>&).
4978 .next
4979 .cindex "AUTH" "configuration"
4980 &'authenticators'&: Configuration settings for the authenticator drivers. These
4981 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4982 .next
4983 &'routers'&: Configuration settings for the router drivers. Routers process
4984 addresses and determine how the message is to be delivered (see chapters
4985 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4986 .next
4987 &'transports'&: Configuration settings for the transport drivers. Transports
4988 define mechanisms for copying messages to destinations (see chapters
4989 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4990 .next
4991 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4992 If there is no retry section, or if it is empty (that is, no retry rules are
4993 defined), Exim will not retry deliveries. In this situation, temporary errors
4994 are treated the same as permanent errors. Retry rules are discussed in chapter
4995 &<<CHAPretry>>&.
4996 .next
4997 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4998 when new addresses are generated during delivery. Rewriting is discussed in
4999 chapter &<<CHAPrewrite>>&.
5000 .next
5001 &'local_scan'&: Private options for the &[local_scan()]& function. If you
5002 want to use this feature, you must set
5003 .code
5004 LOCAL_SCAN_HAS_OPTIONS=yes
5005 .endd
5006 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5007 facility are given in chapter &<<CHAPlocalscan>>&.
5008 .endlist
5009
5010 .cindex "configuration file" "leading white space in"
5011 .cindex "configuration file" "trailing white space in"
5012 .cindex "white space" "in configuration file"
5013 Leading and trailing white space in configuration lines is always ignored.
5014
5015 Blank lines in the file, and lines starting with a # character (ignoring
5016 leading white space) are treated as comments and are ignored. &*Note*&: A
5017 # character other than at the beginning of a line is not treated specially,
5018 and does not introduce a comment.
5019
5020 Any non-comment line can be continued by ending it with a backslash. Note that
5021 the general rule for white space means that trailing white space after the
5022 backslash and leading white space at the start of continuation
5023 lines is ignored. Comment lines beginning with # (but not empty lines) may
5024 appear in the middle of a sequence of continuation lines.
5025
5026 A convenient way to create a configuration file is to start from the
5027 default, which is supplied in &_src/configure.default_&, and add, delete, or
5028 change settings as required.
5029
5030 The ACLs, retry rules, and rewriting rules have their own syntax which is
5031 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5032 respectively. The other parts of the configuration file have some syntactic
5033 items in common, and these are described below, from section &<<SECTcos>>&
5034 onwards. Before that, the inclusion, macro, and conditional facilities are
5035 described.
5036
5037
5038
5039 .section "File inclusions in the configuration file" "SECID41"
5040 .cindex "inclusions in configuration file"
5041 .cindex "configuration file" "including other files"
5042 .cindex "&`.include`& in configuration file"
5043 .cindex "&`.include_if_exists`& in configuration file"
5044 You can include other files inside Exim's runtime configuration file by
5045 using this syntax:
5046 .display
5047 &`.include`& <&'filename'&>
5048 &`.include_if_exists`& <&'filename'&>
5049 .endd
5050 on a line by itself. Double quotes round the filename are optional. If you use
5051 the first form, a configuration error occurs if the file does not exist; the
5052 second form does nothing for non-existent files.
5053 The first form allows a relative name. It is resolved relative to
5054 the directory of the including file. For the second form an absolute filename
5055 is required.
5056
5057 Includes may be nested to any depth, but remember that Exim reads its
5058 configuration file often, so it is a good idea to keep them to a minimum.
5059 If you change the contents of an included file, you must HUP the daemon,
5060 because an included file is read only when the configuration itself is read.
5061
5062 The processing of inclusions happens early, at a physical line level, so, like
5063 comment lines, an inclusion can be used in the middle of an option setting,
5064 for example:
5065 .code
5066 hosts_lookup = a.b.c \
5067                .include /some/file
5068 .endd
5069 Include processing happens after macro processing (see below). Its effect is to
5070 process the lines of the included file as if they occurred inline where the
5071 inclusion appears.
5072
5073
5074
5075 .section "Macros in the configuration file" "SECTmacrodefs"
5076 .cindex "macro" "description of"
5077 .cindex "configuration file" "macros"
5078 If a line in the main part of the configuration (that is, before the first
5079 &"begin"& line) begins with an upper case letter, it is taken as a macro
5080 definition, and must be of the form
5081 .display
5082 <&'name'&> = <&'rest of line'&>
5083 .endd
5084 The name must consist of letters, digits, and underscores, and need not all be
5085 in upper case, though that is recommended. The rest of the line, including any
5086 continuations, is the replacement text, and has leading and trailing white
5087 space removed. Quotes are not removed. The replacement text can never end with
5088 a backslash character, but this doesn't seem to be a serious limitation.
5089
5090 Macros may also be defined between router, transport, authenticator, or ACL
5091 definitions. They may not, however, be defined within an individual driver or
5092 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5093
5094 .section "Macro substitution" "SECID42"
5095 Once a macro is defined, all subsequent lines in the file (and any included
5096 files) are scanned for the macro name; if there are several macros, the line is
5097 scanned for each, in turn, in the order in which the macros are defined. The
5098 replacement text is not re-scanned for the current macro, though it is scanned
5099 for subsequently defined macros. For this reason, a macro name may not contain
5100 the name of a previously defined macro as a substring. You could, for example,
5101 define
5102 .display
5103 &`ABCD_XYZ = `&<&'something'&>
5104 &`ABCD = `&<&'something else'&>
5105 .endd
5106 but putting the definitions in the opposite order would provoke a configuration
5107 error. Macro expansion is applied to individual physical lines from the file,
5108 before checking for line continuation or file inclusion (see above). If a line
5109 consists solely of a macro name, and the expansion of the macro is empty, the
5110 line is ignored. A macro at the start of a line may turn the line into a
5111 comment line or a &`.include`& line.
5112
5113
5114 .section "Redefining macros" "SECID43"
5115 Once defined, the value of a macro can be redefined later in the configuration
5116 (or in an included file). Redefinition is specified by using &'=='& instead of
5117 &'='&. For example:
5118 .code
5119 MAC =  initial value
5120 ...
5121 MAC == updated value
5122 .endd
5123 Redefinition does not alter the order in which the macros are applied to the
5124 subsequent lines of the configuration file. It is still the same order in which
5125 the macros were originally defined. All that changes is the macro's value.
5126 Redefinition makes it possible to accumulate values. For example:
5127 .code
5128 MAC =  initial value
5129 ...
5130 MAC == MAC and something added
5131 .endd
5132 This can be helpful in situations where the configuration file is built
5133 from a number of other files.
5134
5135 .section "Overriding macro values" "SECID44"
5136 The values set for macros in the configuration file can be overridden by the
5137 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5138 used, unless called by root or the Exim user. A definition on the command line
5139 using the &%-D%& option causes all definitions and redefinitions within the
5140 file to be ignored.
5141
5142
5143
5144 .section "Example of macro usage" "SECID45"
5145 As an example of macro usage, consider a configuration where aliases are looked
5146 up in a MySQL database. It helps to keep the file less cluttered if long
5147 strings such as SQL statements are defined separately as macros, for example:
5148 .code
5149 ALIAS_QUERY = select mailbox from user where \
5150               login='${quote_mysql:$local_part}';
5151 .endd
5152 This can then be used in a &(redirect)& router setting like this:
5153 .code
5154 data = ${lookup mysql{ALIAS_QUERY}}
5155 .endd
5156 In earlier versions of Exim macros were sometimes used for domain, host, or
5157 address lists. In Exim 4 these are handled better by named lists &-- see
5158 section &<<SECTnamedlists>>&.
5159
5160
5161 .section "Builtin macros" "SECTbuiltinmacros"
5162 Exim defines some macros depending on facilities available, which may
5163 differ due to build-time definitions and from one release to another.
5164 All of these macros start with an underscore.
5165 They can be used to conditionally include parts of a configuration
5166 (see below).
5167
5168 The following classes of macros are defined:
5169 .display
5170 &` _HAVE_*                    `&  build-time defines
5171 &` _DRIVER_ROUTER_*           `&  router drivers
5172 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5173 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5174 &` _LOG_*                     `&  log_selector values
5175 &` _OPT_MAIN_*                `&  main config options
5176 &` _OPT_ROUTERS_*             `&  generic router options
5177 &` _OPT_TRANSPORTS_*          `&  generic transport options
5178 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5179 &` _OPT_ROUTER_*_*            `&  private router options
5180 &` _OPT_TRANSPORT_*_*         `&  private transport options
5181 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5182 .endd
5183
5184 Use an &"exim -bP macros"& command to get the list of macros.
5185
5186
5187 .section "Conditional skips in the configuration file" "SECID46"
5188 .cindex "configuration file" "conditional skips"
5189 .cindex "&`.ifdef`&"
5190 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5191 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5192 portions of the configuration file. The processing happens whenever the file is
5193 read (that is, when an Exim binary starts to run).
5194
5195 The implementation is very simple. Instances of the first four directives must
5196 be followed by text that includes the names of one or macros. The condition
5197 that is tested is whether or not any macro substitution has taken place in the
5198 line. Thus:
5199 .code
5200 .ifdef AAA
5201 message_size_limit = 50M
5202 .else
5203 message_size_limit = 100M
5204 .endif
5205 .endd
5206 sets a message size limit of 50M if the macro &`AAA`& is defined
5207 (or &`A`& or &`AA`&), and 100M
5208 otherwise. If there is more than one macro named on the line, the condition
5209 is true if any of them are defined. That is, it is an &"or"& condition. To
5210 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5211
5212 Although you can use a macro expansion to generate one of these directives,
5213 it is not very useful, because the condition &"there was a macro substitution
5214 in this line"& will always be true.
5215
5216 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5217 to clarify complicated nestings.
5218
5219
5220
5221 .section "Common option syntax" "SECTcos"
5222 .cindex "common option syntax"
5223 .cindex "syntax of common options"
5224 .cindex "configuration file" "common option syntax"
5225 For the main set of options, driver options, and &[local_scan()]& options,
5226 each setting is on a line by itself, and starts with a name consisting of
5227 lower-case letters and underscores. Many options require a data value, and in
5228 these cases the name must be followed by an equals sign (with optional white
5229 space) and then the value. For example:
5230 .code
5231 qualify_domain = mydomain.example.com
5232 .endd
5233 .cindex "hiding configuration option values"
5234 .cindex "configuration options" "hiding value of"
5235 .cindex "options" "hiding value of"
5236 Some option settings may contain sensitive data, for example, passwords for
5237 accessing databases. To stop non-admin users from using the &%-bP%& command
5238 line option to read these values, you can precede the option settings with the
5239 word &"hide"&. For example:
5240 .code
5241 hide mysql_servers = localhost/users/admin/secret-password
5242 .endd
5243 For non-admin users, such options are displayed like this:
5244 .code
5245 mysql_servers = <value not displayable>
5246 .endd
5247 If &"hide"& is used on a driver option, it hides the value of that option on
5248 all instances of the same driver.
5249
5250 The following sections describe the syntax used for the different data types
5251 that are found in option settings.
5252
5253
5254 .section "Boolean options" "SECID47"
5255 .cindex "format" "boolean"
5256 .cindex "boolean configuration values"
5257 .oindex "&%no_%&&'xxx'&"
5258 .oindex "&%not_%&&'xxx'&"
5259 Options whose type is given as boolean are on/off switches. There are two
5260 different ways of specifying such options: with and without a data value. If
5261 the option name is specified on its own without data, the switch is turned on;
5262 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5263 boolean options may be followed by an equals sign and one of the words
5264 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5265 the following two settings have exactly the same effect:
5266 .code
5267 queue_only
5268 queue_only = true
5269 .endd
5270 The following two lines also have the same (opposite) effect:
5271 .code
5272 no_queue_only
5273 queue_only = false
5274 .endd
5275 You can use whichever syntax you prefer.
5276
5277
5278
5279
5280 .section "Integer values" "SECID48"
5281 .cindex "integer configuration values"
5282 .cindex "format" "integer"
5283 If an option's type is given as &"integer"&, the value can be given in decimal,
5284 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5285 number is assumed. Otherwise, it is treated as an octal number unless it starts
5286 with the characters &"0x"&, in which case the remainder is interpreted as a
5287 hexadecimal number.
5288
5289 If an integer value is followed by the letter K, it is multiplied by 1024; if
5290 it is followed by the letter M, it is multiplied by 1024x1024;
5291 if by the letter G, 1024x1024x1024.
5292 When the values
5293 of integer option settings are output, values which are an exact multiple of
5294 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5295 and M. The printing style is independent of the actual input format that was
5296 used.
5297
5298
5299 .section "Octal integer values" "SECID49"
5300 .cindex "integer format"
5301 .cindex "format" "octal integer"
5302 If an option's type is given as &"octal integer"&, its value is always
5303 interpreted as an octal number, whether or not it starts with the digit zero.
5304 Such options are always output in octal.
5305
5306
5307 .section "Fixed point numbers" "SECID50"
5308 .cindex "fixed point configuration values"
5309 .cindex "format" "fixed point"
5310 If an option's type is given as &"fixed-point"&, its value must be a decimal
5311 integer, optionally followed by a decimal point and up to three further digits.
5312
5313
5314
5315 .section "Time intervals" "SECTtimeformat"
5316 .cindex "time interval" "specifying in configuration"
5317 .cindex "format" "time interval"
5318 A time interval is specified as a sequence of numbers, each followed by one of
5319 the following letters, with no intervening white space:
5320
5321 .table2 30pt
5322 .irow &%s%& seconds
5323 .irow &%m%& minutes
5324 .irow &%h%& hours
5325 .irow &%d%& days
5326 .irow &%w%& weeks
5327 .endtable
5328
5329 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5330 intervals are output in the same format. Exim does not restrict the values; it
5331 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5332
5333
5334
5335 .section "String values" "SECTstrings"
5336 .cindex "string" "format of configuration values"
5337 .cindex "format" "string"
5338 If an option's type is specified as &"string"&, the value can be specified with
5339 or without double-quotes. If it does not start with a double-quote, the value
5340 consists of the remainder of the line plus any continuation lines, starting at
5341 the first character after any leading white space, with trailing white space
5342 removed, and with no interpretation of the characters in the string. Because
5343 Exim removes comment lines (those beginning with #) at an early stage, they can
5344 appear in the middle of a multi-line string. The following two settings are
5345 therefore equivalent:
5346 .code
5347 trusted_users = uucp:mail
5348 trusted_users = uucp:\
5349                 # This comment line is ignored
5350                 mail
5351 .endd
5352 .cindex "string" "quoted"
5353 .cindex "escape characters in quoted strings"
5354 If a string does start with a double-quote, it must end with a closing
5355 double-quote, and any backslash characters other than those used for line
5356 continuation are interpreted as escape characters, as follows:
5357
5358 .table2 100pt
5359 .irow &`\\`&                     "single backslash"
5360 .irow &`\n`&                     "newline"
5361 .irow &`\r`&                     "carriage return"
5362 .irow &`\t`&                     "tab"
5363 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5364 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5365                                    character"
5366 .endtable
5367
5368 If a backslash is followed by some other character, including a double-quote
5369 character, that character replaces the pair.
5370
5371 Quoting is necessary only if you want to make use of the backslash escapes to
5372 insert special characters, or if you need to specify a value with leading or
5373 trailing spaces. These cases are rare, so quoting is almost never needed in
5374 current versions of Exim. In versions of Exim before 3.14, quoting was required
5375 in order to continue lines, so you may come across older configuration files
5376 and examples that apparently quote unnecessarily.
5377
5378
5379 .section "Expanded strings" "SECID51"
5380 .cindex "expansion" "definition of"
5381 Some strings in the configuration file are subjected to &'string expansion'&,
5382 by which means various parts of the string may be changed according to the
5383 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5384 is as just described; in particular, the handling of backslashes in quoted
5385 strings is done as part of the input process, before expansion takes place.
5386 However, backslash is also an escape character for the expander, so any
5387 backslashes that are required for that reason must be doubled if they are
5388 within a quoted configuration string.
5389
5390
5391 .section "User and group names" "SECID52"
5392 .cindex "user name" "format of"
5393 .cindex "format" "user name"
5394 .cindex "groups" "name format"
5395 .cindex "format" "group name"
5396 User and group names are specified as strings, using the syntax described
5397 above, but the strings are interpreted specially. A user or group name must
5398 either consist entirely of digits, or be a name that can be looked up using the
5399 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5400
5401
5402 .section "List construction" "SECTlistconstruct"
5403 .cindex "list" "syntax of in configuration"
5404 .cindex "format" "list item in configuration"
5405 .cindex "string" "list, definition of"
5406 The data for some configuration options is a list of items, with colon as the
5407 default separator. Many of these options are shown with type &"string list"& in
5408 the descriptions later in this document. Others are listed as &"domain list"&,
5409 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5410 are all the same; however, those other than &"string list"& are subject to
5411 particular kinds of interpretation, as described in chapter
5412 &<<CHAPdomhosaddlists>>&.
5413
5414 In all these cases, the entire list is treated as a single string as far as the
5415 input syntax is concerned. The &%trusted_users%& setting in section
5416 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5417 in a list, it must be entered as two colons. Leading and trailing white space
5418 on each item in a list is ignored. This makes it possible to include items that
5419 start with a colon, and in particular, certain forms of IPv6 address. For
5420 example, the list
5421 .code
5422 local_interfaces = 127.0.0.1 : ::::1
5423 .endd
5424 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5425
5426 &*Note*&: Although leading and trailing white space is ignored in individual
5427 list items, it is not ignored when parsing the list. The space after the first
5428 colon in the example above is necessary. If it were not there, the list would
5429 be interpreted as the two items 127.0.0.1:: and 1.
5430
5431 .section "Changing list separators" "SECTlistsepchange"
5432 .cindex "list separator" "changing"
5433 .cindex "IPv6" "addresses in lists"
5434 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5435 introduced to allow the separator character to be changed. If a list begins
5436 with a left angle bracket, followed by any punctuation character, that
5437 character is used instead of colon as the list separator. For example, the list
5438 above can be rewritten to use a semicolon separator like this:
5439 .code
5440 local_interfaces = <; 127.0.0.1 ; ::1
5441 .endd
5442 This facility applies to all lists, with the exception of the list in
5443 &%log_file_path%&. It is recommended that the use of non-colon separators be
5444 confined to circumstances where they really are needed.
5445
5446 .cindex "list separator" "newline as"
5447 .cindex "newline" "as list separator"
5448 It is also possible to use newline and other control characters (those with
5449 code values less than 32, plus DEL) as separators in lists. Such separators
5450 must be provided literally at the time the list is processed. For options that
5451 are string-expanded, you can write the separator using a normal escape
5452 sequence. This will be processed by the expander before the string is
5453 interpreted as a list. For example, if a newline-separated list of domains is
5454 generated by a lookup, you can process it directly by a line such as this:
5455 .code
5456 domains = <\n ${lookup mysql{.....}}
5457 .endd
5458 This avoids having to change the list separator in such data. You are unlikely
5459 to want to use a control character as a separator in an option that is not
5460 expanded, because the value is literal text. However, it can be done by giving
5461 the value in quotes. For example:
5462 .code
5463 local_interfaces = "<\n 127.0.0.1 \n ::1"
5464 .endd
5465 Unlike printing character separators, which can be included in list items by
5466 doubling, it is not possible to include a control character as data when it is
5467 set as the separator. Two such characters in succession are interpreted as
5468 enclosing an empty list item.
5469
5470
5471
5472 .section "Empty items in lists" "SECTempitelis"
5473 .cindex "list" "empty item in"
5474 An empty item at the end of a list is always ignored. In other words, trailing
5475 separator characters are ignored. Thus, the list in
5476 .code
5477 senders = user@domain :
5478 .endd
5479 contains only a single item. If you want to include an empty string as one item
5480 in a list, it must not be the last item. For example, this list contains three
5481 items, the second of which is empty:
5482 .code
5483 senders = user1@domain : : user2@domain
5484 .endd
5485 &*Note*&: There must be white space between the two colons, as otherwise they
5486 are interpreted as representing a single colon data character (and the list
5487 would then contain just one item). If you want to specify a list that contains
5488 just one, empty item, you can do it as in this example:
5489 .code
5490 senders = :
5491 .endd
5492 In this case, the first item is empty, and the second is discarded because it
5493 is at the end of the list.
5494
5495
5496
5497
5498 .section "Format of driver configurations" "SECTfordricon"
5499 .cindex "drivers" "configuration format"
5500 There are separate parts in the configuration for defining routers, transports,
5501 and authenticators. In each part, you are defining a number of driver
5502 instances, each with its own set of options. Each driver instance is defined by
5503 a sequence of lines like this:
5504 .display
5505 <&'instance name'&>:
5506   <&'option'&>
5507   ...
5508   <&'option'&>
5509 .endd
5510 In the following example, the instance name is &(localuser)&, and it is
5511 followed by three options settings:
5512 .code
5513 localuser:
5514   driver = accept
5515   check_local_user
5516   transport = local_delivery
5517 .endd
5518 For each driver instance, you specify which Exim code module it uses &-- by the
5519 setting of the &%driver%& option &-- and (optionally) some configuration
5520 settings. For example, in the case of transports, if you want a transport to
5521 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5522 a local file you would use the &(appendfile)& driver. Each of the drivers is
5523 described in detail in its own separate chapter later in this manual.
5524
5525 You can have several routers, transports, or authenticators that are based on
5526 the same underlying driver (each must have a different instance name).
5527
5528 The order in which routers are defined is important, because addresses are
5529 passed to individual routers one by one, in order. The order in which
5530 transports are defined does not matter at all. The order in which
5531 authenticators are defined is used only when Exim, as a client, is searching
5532 them to find one that matches an authentication mechanism offered by the
5533 server.
5534
5535 .cindex "generic options"
5536 .cindex "options" "generic &-- definition of"
5537 Within a driver instance definition, there are two kinds of option: &'generic'&
5538 and &'private'&. The generic options are those that apply to all drivers of the
5539 same type (that is, all routers, all transports or all authenticators). The
5540 &%driver%& option is a generic option that must appear in every definition.
5541 .cindex "private options"
5542 The private options are special for each driver, and none need appear, because
5543 they all have default values.
5544
5545 The options may appear in any order, except that the &%driver%& option must
5546 precede any private options, since these depend on the particular driver. For
5547 this reason, it is recommended that &%driver%& always be the first option.
5548
5549 Driver instance names, which are used for reference in log entries and
5550 elsewhere, can be any sequence of letters, digits, and underscores (starting
5551 with a letter) and must be unique among drivers of the same type. A router and
5552 a transport (for example) can each have the same name, but no two router
5553 instances can have the same name. The name of a driver instance should not be
5554 confused with the name of the underlying driver module. For example, the
5555 configuration lines:
5556 .code
5557 remote_smtp:
5558   driver = smtp
5559 .endd
5560 create an instance of the &(smtp)& transport driver whose name is
5561 &(remote_smtp)&. The same driver code can be used more than once, with
5562 different instance names and different option settings each time. A second
5563 instance of the &(smtp)& transport, with different options, might be defined
5564 thus:
5565 .code
5566 special_smtp:
5567   driver = smtp
5568   port = 1234
5569   command_timeout = 10s
5570 .endd
5571 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5572 these transport instances from routers, and these names would appear in log
5573 lines.
5574
5575 Comment lines may be present in the middle of driver specifications. The full
5576 list of option settings for any particular driver instance, including all the
5577 defaulted values, can be extracted by making use of the &%-bP%& command line
5578 option.
5579
5580
5581
5582
5583
5584
5585 . ////////////////////////////////////////////////////////////////////////////
5586 . ////////////////////////////////////////////////////////////////////////////
5587
5588 .chapter "The default configuration file" "CHAPdefconfil"
5589 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5590 .cindex "default" "configuration file &""walk through""&"
5591 The default configuration file supplied with Exim as &_src/configure.default_&
5592 is sufficient for a host with simple mail requirements. As an introduction to
5593 the way Exim is configured, this chapter &"walks through"& the default
5594 configuration, giving brief explanations of the settings. Detailed descriptions
5595 of the options are given in subsequent chapters. The default configuration file
5596 itself contains extensive comments about ways you might want to modify the
5597 initial settings. However, note that there are many options that are not
5598 mentioned at all in the default configuration.
5599
5600
5601
5602 .section "Macros" "SECTdefconfmacros"
5603 All macros should be defined before any options.
5604
5605 One macro is specified, but commented out, in the default configuration:
5606 .code
5607 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5608 .endd
5609 If all off-site mail is expected to be delivered to a "smarthost", then set the
5610 hostname here and uncomment the macro.  This will affect which router is used
5611 later on.  If this is left commented out, then Exim will perform direct-to-MX
5612 deliveries using a &(dnslookup)& router.
5613
5614 In addition to macros defined here, Exim includes a number of built-in macros
5615 to enable configuration to be guarded by a binary built with support for a
5616 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5617
5618
5619 .section "Main configuration settings" "SECTdefconfmain"
5620 The main (global) configuration option settings section must always come first
5621 in the file, after the macros.
5622 The first thing you'll see in the file, after some initial comments, is the line
5623 .code
5624 # primary_hostname =
5625 .endd
5626 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5627 to know the official, fully qualified name of your host, and this is where you
5628 can specify it. However, in most cases you do not need to set this option. When
5629 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5630
5631 The first three non-comment configuration lines are as follows:
5632 .code
5633 domainlist local_domains    = @
5634 domainlist relay_to_domains =
5635 hostlist   relay_from_hosts = 127.0.0.1
5636 .endd
5637 These are not, in fact, option settings. They are definitions of two named
5638 domain lists and one named host list. Exim allows you to give names to lists of
5639 domains, hosts, and email addresses, in order to make it easier to manage the
5640 configuration file (see section &<<SECTnamedlists>>&).
5641
5642 The first line defines a domain list called &'local_domains'&; this is used
5643 later in the configuration to identify domains that are to be delivered
5644 on the local host.
5645
5646 .cindex "@ in a domain list"
5647 There is just one item in this list, the string &"@"&. This is a special form
5648 of entry which means &"the name of the local host"&. Thus, if the local host is
5649 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5650 be delivered locally. Because the local host's name is referenced indirectly,
5651 the same configuration file can be used on different hosts.
5652
5653 The second line defines a domain list called &'relay_to_domains'&, but the
5654 list itself is empty. Later in the configuration we will come to the part that
5655 controls mail relaying through the local host; it allows relaying to any
5656 domains in this list. By default, therefore, no relaying on the basis of a mail
5657 domain is permitted.
5658
5659 The third line defines a host list called &'relay_from_hosts'&. This list is
5660 used later in the configuration to permit relaying from any host or IP address
5661 that matches the list. The default contains just the IP address of the IPv4
5662 loopback interface, which means that processes on the local host are able to
5663 submit mail for relaying by sending it over TCP/IP to that interface. No other
5664 hosts are permitted to submit messages for relaying.
5665
5666 Just to be sure there's no misunderstanding: at this point in the configuration
5667 we aren't actually setting up any controls. We are just defining some domains
5668 and hosts that will be used in the controls that are specified later.
5669
5670 The next two configuration lines are genuine option settings:
5671 .code
5672 acl_smtp_rcpt = acl_check_rcpt
5673 acl_smtp_data = acl_check_data
5674 .endd
5675 These options specify &'Access Control Lists'& (ACLs) that are to be used
5676 during an incoming SMTP session for every recipient of a message (every RCPT
5677 command), and after the contents of the message have been received,
5678 respectively. The names of the lists are &'acl_check_rcpt'& and
5679 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5680 section of the configuration. The RCPT ACL controls which recipients are
5681 accepted for an incoming message &-- if a configuration does not provide an ACL
5682 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5683 contents of a message to be checked.
5684
5685 Two commented-out option settings are next:
5686 .code
5687 # av_scanner = clamd:/tmp/clamd
5688 # spamd_address = 127.0.0.1 783
5689 .endd
5690 These are example settings that can be used when Exim is compiled with the
5691 content-scanning extension. The first specifies the interface to the virus
5692 scanner, and the second specifies the interface to SpamAssassin. Further
5693 details are given in chapter &<<CHAPexiscan>>&.
5694
5695 Three more commented-out option settings follow:
5696 .code
5697 # tls_advertise_hosts = *
5698 # tls_certificate = /etc/ssl/exim.crt
5699 # tls_privatekey = /etc/ssl/exim.pem
5700 .endd
5701 These are example settings that can be used when Exim is compiled with
5702 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5703 first one specifies the list of clients that are allowed to use TLS when
5704 connecting to this server; in this case, the wildcard means all clients. The
5705 other options specify where Exim should find its TLS certificate and private
5706 key, which together prove the server's identity to any clients that connect.
5707 More details are given in chapter &<<CHAPTLS>>&.
5708
5709 Another two commented-out option settings follow:
5710 .code
5711 # daemon_smtp_ports = 25 : 465 : 587
5712 # tls_on_connect_ports = 465
5713 .endd
5714 .cindex "port" "465 and 587"
5715 .cindex "port" "for message submission"
5716 .cindex "message" "submission, ports for"
5717 .cindex "submissions protocol"
5718 .cindex "smtps protocol"
5719 .cindex "ssmtp protocol"
5720 .cindex "SMTP" "submissions protocol"
5721 .cindex "SMTP" "ssmtp protocol"
5722 .cindex "SMTP" "smtps protocol"
5723 These options provide better support for roaming users who wish to use this
5724 server for message submission. They are not much use unless you have turned on
5725 TLS (as described in the previous paragraph) and authentication (about which
5726 more in section &<<SECTdefconfauth>>&).
5727 Mail submission from mail clients (MUAs) should be separate from inbound mail
5728 to your domain (MX delivery) for various good reasons (eg, ability to impose
5729 much saner TLS protocol and ciphersuite requirements without unintended
5730 consequences).
5731 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5732 which uses STARTTLS, so this is the &"submission"& port.
5733 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5734 which should be used in preference to 587.
5735 You should also consider deploying SRV records to help clients find
5736 these ports.
5737 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5738
5739 Two more commented-out options settings follow:
5740 .code
5741 # qualify_domain =
5742 # qualify_recipient =
5743 .endd
5744 The first of these specifies a domain that Exim uses when it constructs a
5745 complete email address from a local login name. This is often needed when Exim
5746 receives a message from a local process. If you do not set &%qualify_domain%&,
5747 the value of &%primary_hostname%& is used. If you set both of these options,
5748 you can have different qualification domains for sender and recipient
5749 addresses. If you set only the first one, its value is used in both cases.
5750
5751 .cindex "domain literal" "recognizing format"
5752 The following line must be uncommented if you want Exim to recognize
5753 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5754 (an IP address within square brackets) instead of a named domain.
5755 .code
5756 # allow_domain_literals
5757 .endd
5758 The RFCs still require this form, but many people think that in the modern
5759 Internet it makes little sense to permit mail to be sent to specific hosts by
5760 quoting their IP addresses. This ancient format has been used by people who
5761 try to abuse hosts by using them for unwanted relaying. However, some
5762 people believe there are circumstances (for example, messages addressed to
5763 &'postmaster'&) where domain literals are still useful.
5764
5765 The next configuration line is a kind of trigger guard:
5766 .code
5767 never_users = root
5768 .endd
5769 It specifies that no delivery must ever be run as the root user. The normal
5770 convention is to set up &'root'& as an alias for the system administrator. This
5771 setting is a guard against slips in the configuration.
5772 The list of users specified by &%never_users%& is not, however, the complete
5773 list; the build-time configuration in &_Local/Makefile_& has an option called
5774 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5775 contents of &%never_users%& are added to this list. By default
5776 FIXED_NEVER_USERS also specifies root.
5777
5778 When a remote host connects to Exim in order to send mail, the only information
5779 Exim has about the host's identity is its IP address. The next configuration
5780 line,
5781 .code
5782 host_lookup = *
5783 .endd
5784 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5785 in order to get a host name. This improves the quality of the logging
5786 information, but if you feel it is too expensive, you can remove it entirely,
5787 or restrict the lookup to hosts on &"nearby"& networks.
5788 Note that it is not always possible to find a host name from an IP address,
5789 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5790 unreachable.
5791
5792 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5793 1413 (hence their names):
5794 .code
5795 rfc1413_hosts = *
5796 rfc1413_query_timeout = 0s
5797 .endd
5798 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5799 Few hosts offer RFC1413 service these days; calls have to be
5800 terminated by a timeout and this needlessly delays the startup
5801 of an incoming SMTP connection.
5802 If you have hosts for which you trust RFC1413 and need this
5803 information, you can change this.
5804
5805 This line enables an efficiency SMTP option.  It is negotiated by clients
5806 and not expected to cause problems but can be disabled if needed.
5807 .code
5808 prdr_enable = true
5809 .endd
5810
5811 When Exim receives messages over SMTP connections, it expects all addresses to
5812 be fully qualified with a domain, as required by the SMTP definition. However,
5813 if you are running a server to which simple clients submit messages, you may
5814 find that they send unqualified addresses. The two commented-out options:
5815 .code
5816 # sender_unqualified_hosts =
5817 # recipient_unqualified_hosts =
5818 .endd
5819 show how you can specify hosts that are permitted to send unqualified sender
5820 and recipient addresses, respectively.
5821
5822 The &%log_selector%& option is used to increase the detail of logging
5823 over the default:
5824 .code
5825 log_selector = +smtp_protocol_error +smtp_syntax_error \
5826                +tls_certificate_verified
5827 .endd
5828
5829 The &%percent_hack_domains%& option is also commented out:
5830 .code
5831 # percent_hack_domains =
5832 .endd
5833 It provides a list of domains for which the &"percent hack"& is to operate.
5834 This is an almost obsolete form of explicit email routing. If you do not know
5835 anything about it, you can safely ignore this topic.
5836
5837 The next two settings in the main part of the default configuration are
5838 concerned with messages that have been &"frozen"& on Exim's queue. When a
5839 message is frozen, Exim no longer continues to try to deliver it. Freezing
5840 occurs when a bounce message encounters a permanent failure because the sender
5841 address of the original message that caused the bounce is invalid, so the
5842 bounce cannot be delivered. This is probably the most common case, but there
5843 are also other conditions that cause freezing, and frozen messages are not
5844 always bounce messages.
5845 .code
5846 ignore_bounce_errors_after = 2d
5847 timeout_frozen_after = 7d
5848 .endd
5849 The first of these options specifies that failing bounce messages are to be
5850 discarded after 2 days in the queue. The second specifies that any frozen
5851 message (whether a bounce message or not) is to be timed out (and discarded)
5852 after a week. In this configuration, the first setting ensures that no failing
5853 bounce message ever lasts a week.
5854
5855 Exim queues it's messages in a spool directory. If you expect to have
5856 large queues, you may consider using this option. It splits the spool
5857 directory into subdirectories to avoid file system degradation from
5858 many files in a single directory, resulting in better performance.
5859 Manual manipulation of queued messages becomes more complex (though fortunately
5860 not often needed).
5861 .code
5862 # split_spool_directory = true
5863 .endd
5864
5865 In an ideal world everybody follows the standards. For non-ASCII
5866 messages RFC 2047 is a standard, allowing a maximum line length of 76
5867 characters. Exim adheres that standard and won't process messages which
5868 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5869 In particular, the Exim maintainers have had multiple reports of
5870 problems from Russian administrators of issues until they disable this
5871 check, because of some popular, yet buggy, mail composition software.
5872 .code
5873 # check_rfc2047_length = false
5874 .endd
5875
5876 If you need to be strictly RFC compliant you may wish to disable the
5877 8BITMIME advertisement. Use this, if you exchange mails with systems
5878 that are not 8-bit clean.
5879 .code
5880 # accept_8bitmime = false
5881 .endd
5882
5883 Libraries you use may depend on specific environment settings.  This
5884 imposes a security risk (e.g. PATH). There are two lists:
5885 &%keep_environment%& for the variables to import as they are, and
5886 &%add_environment%& for variables we want to set to a fixed value.
5887 Note that TZ is handled separately, by the $%timezone%$ runtime
5888 option and by the TIMEZONE_DEFAULT buildtime option.
5889 .code
5890 # keep_environment = ^LDAP
5891 # add_environment = PATH=/usr/bin::/bin
5892 .endd
5893
5894
5895 .section "ACL configuration" "SECID54"
5896 .cindex "default" "ACLs"
5897 .cindex "&ACL;" "default configuration"
5898 In the default configuration, the ACL section follows the main configuration.
5899 It starts with the line
5900 .code
5901 begin acl
5902 .endd
5903 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5904 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5905 and &%acl_smtp_data%& above.
5906
5907 .cindex "RCPT" "ACL for"
5908 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5909 RCPT command specifies one of the message's recipients. The ACL statements
5910 are considered in order, until the recipient address is either accepted or
5911 rejected. The RCPT command is then accepted or rejected, according to the
5912 result of the ACL processing.
5913 .code
5914 acl_check_rcpt:
5915 .endd
5916 This line, consisting of a name terminated by a colon, marks the start of the
5917 ACL, and names it.
5918 .code
5919 accept  hosts = :
5920 .endd
5921 This ACL statement accepts the recipient if the sending host matches the list.
5922 But what does that strange list mean? It doesn't actually contain any host
5923 names or IP addresses. The presence of the colon puts an empty item in the
5924 list; Exim matches this only if the incoming message did not come from a remote
5925 host, because in that case, the remote hostname is empty. The colon is
5926 important. Without it, the list itself is empty, and can never match anything.
5927
5928 What this statement is doing is to accept unconditionally all recipients in
5929 messages that are submitted by SMTP from local processes using the standard
5930 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5931 manner.
5932 .code
5933 deny    domains       = +local_domains
5934         local_parts   = ^[.] : ^.*[@%!/|]
5935         message       = Restricted characters in address
5936
5937 deny    domains       = !+local_domains
5938         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5939         message       = Restricted characters in address
5940 .endd
5941 These statements are concerned with local parts that contain any of the
5942 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5943 Although these characters are entirely legal in local parts (in the case of
5944 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5945 in Internet mail addresses.
5946
5947 The first three have in the past been associated with explicitly routed
5948 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5949 option). Addresses containing these characters are regularly tried by spammers
5950 in an attempt to bypass relaying restrictions, and also by open relay testing
5951 programs. Unless you really need them it is safest to reject these characters
5952 at this early stage. This configuration is heavy-handed in rejecting these
5953 characters for all messages it accepts from remote hosts. This is a deliberate
5954 policy of being as safe as possible.
5955
5956 The first rule above is stricter, and is applied to messages that are addressed
5957 to one of the local domains handled by this host. This is implemented by the
5958 first condition, which restricts it to domains that are listed in the
5959 &'local_domains'& domain list. The &"+"& character is used to indicate a
5960 reference to a named list. In this configuration, there is just one domain in
5961 &'local_domains'&, but in general there may be many.
5962
5963 The second condition on the first statement uses two regular expressions to
5964 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5965 or &"|"&. If you have local accounts that include these characters, you will
5966 have to modify this rule.
5967
5968 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5969 allows them because they have been encountered in practice. (Consider the
5970 common convention of local parts constructed as
5971 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5972 the author of Exim, who has no second initial.) However, a local part starting
5973 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5974 filename (for example, for a mailing list). This is also true for local parts
5975 that contain slashes. A pipe symbol can also be troublesome if the local part
5976 is incorporated unthinkingly into a shell command line.
5977
5978 The second rule above applies to all other domains, and is less strict. This
5979 allows your own users to send outgoing messages to sites that use slashes
5980 and vertical bars in their local parts. It blocks local parts that begin
5981 with a dot, slash, or vertical bar, but allows these characters within the
5982 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5983 and &"!"& is blocked, as before. The motivation here is to prevent your users
5984 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5985 .code
5986 accept  local_parts   = postmaster
5987         domains       = +local_domains
5988 .endd
5989 This statement, which has two conditions, accepts an incoming address if the
5990 local part is &'postmaster'& and the domain is one of those listed in the
5991 &'local_domains'& domain list. The &"+"& character is used to indicate a
5992 reference to a named list. In this configuration, there is just one domain in
5993 &'local_domains'&, but in general there may be many.
5994
5995 The presence of this statement means that mail to postmaster is never blocked
5996 by any of the subsequent tests. This can be helpful while sorting out problems
5997 in cases where the subsequent tests are incorrectly denying access.
5998 .code
5999 require verify        = sender
6000 .endd
6001 This statement requires the sender address to be verified before any subsequent
6002 ACL statement can be used. If verification fails, the incoming recipient
6003 address is refused. Verification consists of trying to route the address, to
6004 see if a bounce message could be delivered to it. In the case of remote
6005 addresses, basic verification checks only the domain, but &'callouts'& can be
6006 used for more verification if required. Section &<<SECTaddressverification>>&
6007 discusses the details of address verification.
6008 .code
6009 accept  hosts         = +relay_from_hosts
6010         control       = submission
6011 .endd
6012 This statement accepts the address if the message is coming from one of the
6013 hosts that are defined as being allowed to relay through this host. Recipient
6014 verification is omitted here, because in many cases the clients are dumb MUAs
6015 that do not cope well with SMTP error responses. For the same reason, the
6016 second line specifies &"submission mode"& for messages that are accepted. This
6017 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6018 messages that are deficient in some way, for example, because they lack a
6019 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6020 probably add recipient verification here, and disable submission mode.
6021 .code
6022 accept  authenticated = *
6023         control       = submission
6024 .endd
6025 This statement accepts the address if the client host has authenticated itself.
6026 Submission mode is again specified, on the grounds that such messages are most
6027 likely to come from MUAs. The default configuration does not define any
6028 authenticators, though it does include some nearly complete commented-out
6029 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6030 fact authenticate until you complete the authenticator definitions.
6031 .code
6032 require message = relay not permitted
6033         domains = +local_domains : +relay_to_domains
6034 .endd
6035 This statement rejects the address if its domain is neither a local domain nor
6036 one of the domains for which this host is a relay.
6037 .code
6038 require verify = recipient
6039 .endd
6040 This statement requires the recipient address to be verified; if verification
6041 fails, the address is rejected.
6042 .code
6043 # deny    dnslists    = black.list.example
6044 #         message     = rejected because $sender_host_address \
6045 #                       is in a black list at $dnslist_domain\n\
6046 #                       $dnslist_text
6047 #
6048 # warn    dnslists    = black.list.example
6049 #         add_header  = X-Warning: $sender_host_address is in \
6050 #                       a black list at $dnslist_domain
6051 #         log_message = found in $dnslist_domain
6052 .endd
6053 These commented-out lines are examples of how you could configure Exim to check
6054 sending hosts against a DNS black list. The first statement rejects messages
6055 from blacklisted hosts, whereas the second just inserts a warning header
6056 line.
6057 .code
6058 # require verify = csa
6059 .endd
6060 This commented-out line is an example of how you could turn on client SMTP
6061 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6062 records.
6063 .code
6064 accept
6065 .endd
6066 The final statement in the first ACL unconditionally accepts any recipient
6067 address that has successfully passed all the previous tests.
6068 .code
6069 acl_check_data:
6070 .endd
6071 This line marks the start of the second ACL, and names it. Most of the contents
6072 of this ACL are commented out:
6073 .code
6074 # deny    malware   = *
6075 #         message   = This message contains a virus \
6076 #                     ($malware_name).
6077 .endd
6078 These lines are examples of how to arrange for messages to be scanned for
6079 viruses when Exim has been compiled with the content-scanning extension, and a
6080 suitable virus scanner is installed. If the message is found to contain a
6081 virus, it is rejected with the given custom error message.
6082 .code
6083 # warn    spam      = nobody
6084 #         message   = X-Spam_score: $spam_score\n\
6085 #                     X-Spam_score_int: $spam_score_int\n\
6086 #                     X-Spam_bar: $spam_bar\n\
6087 #                     X-Spam_report: $spam_report
6088 .endd
6089 These lines are an example of how to arrange for messages to be scanned by
6090 SpamAssassin when Exim has been compiled with the content-scanning extension,
6091 and SpamAssassin has been installed. The SpamAssassin check is run with
6092 &`nobody`& as its user parameter, and the results are added to the message as a
6093 series of extra header line. In this case, the message is not rejected,
6094 whatever the spam score.
6095 .code
6096 accept
6097 .endd
6098 This final line in the DATA ACL accepts the message unconditionally.
6099
6100
6101 .section "Router configuration" "SECID55"
6102 .cindex "default" "routers"
6103 .cindex "routers" "default"
6104 The router configuration comes next in the default configuration, introduced
6105 by the line
6106 .code
6107 begin routers
6108 .endd
6109 Routers are the modules in Exim that make decisions about where to send
6110 messages. An address is passed to each router, in turn, until it is either
6111 accepted, or failed. This means that the order in which you define the routers
6112 matters. Each router is fully described in its own chapter later in this
6113 manual. Here we give only brief overviews.
6114 .code
6115 # domain_literal:
6116 #   driver = ipliteral
6117 #   domains = !+local_domains
6118 #   transport = remote_smtp
6119 .endd
6120 .cindex "domain literal" "default router"
6121 This router is commented out because the majority of sites do not want to
6122 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6123 you uncomment this router, you also need to uncomment the setting of
6124 &%allow_domain_literals%& in the main part of the configuration.
6125
6126 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6127 macro has been defined, per
6128 .code
6129 .ifdef ROUTER_SMARTHOST
6130 smarthost:
6131 #...
6132 .else
6133 dnslookup:
6134 #...
6135 .endif
6136 .endd
6137
6138 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6139 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6140 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6141 skip these routers because of the &%domains%& option.
6142
6143 .code
6144 smarthost:
6145   driver = manualroute
6146   domains = ! +local_domains
6147   transport = smarthost_smtp
6148   route_data = ROUTER_SMARTHOST
6149   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6150   no_more
6151 .endd
6152 This router only handles mail which is not to any local domains; this is
6153 specified by the line
6154 .code
6155 domains = ! +local_domains
6156 .endd
6157 The &%domains%& option lists the domains to which this router applies, but the
6158 exclamation mark is a negation sign, so the router is used only for domains
6159 that are not in the domain list called &'local_domains'& (which was defined at
6160 the start of the configuration). The plus sign before &'local_domains'&
6161 indicates that it is referring to a named list. Addresses in other domains are
6162 passed on to the following routers.
6163
6164 The name of the router driver is &(manualroute)& because we are manually
6165 specifying how mail should be routed onwards, instead of using DNS MX.
6166 While the name of this router instance is arbitrary, the &%driver%& option must
6167 be one of the driver modules that is in the Exim binary.
6168
6169 With no pre-conditions other than &%domains%&, all mail for non-local domains
6170 will be handled by this router, and the &%no_more%& setting will ensure that no
6171 other routers will be used for messages matching the pre-conditions.  See
6172 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6173 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6174 and the macro supplies the value; the address is then queued for the
6175 &(smarthost_smtp)& transport.
6176
6177 .code
6178 dnslookup:
6179   driver = dnslookup
6180   domains = ! +local_domains
6181   transport = remote_smtp
6182   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6183   no_more
6184 .endd
6185 The &%domains%& option behaves as per smarthost, above.
6186
6187 The name of the router driver is &(dnslookup)&,
6188 and is specified by the &%driver%& option. Do not be confused by the fact that
6189 the name of this router instance is the same as the name of the driver. The
6190 instance name is arbitrary, but the name set in the &%driver%& option must be
6191 one of the driver modules that is in the Exim binary.
6192
6193 The &(dnslookup)& router routes addresses by looking up their domains in the
6194 DNS in order to obtain a list of hosts to which the address is routed. If the
6195 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6196 specified by the &%transport%& option. If the router does not find the domain
6197 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6198 the address fails and is bounced.
6199
6200 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6201 be entirely ignored. This option is present because a number of cases have been
6202 encountered where MX records in the DNS point to host names
6203 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6204 Completely ignoring these IP addresses causes Exim to fail to route the
6205 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6206 continue to try to deliver the message periodically until the address timed
6207 out.
6208 .code
6209 system_aliases:
6210   driver = redirect
6211   allow_fail
6212   allow_defer
6213   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6214 # user = exim
6215   file_transport = address_file
6216   pipe_transport = address_pipe
6217 .endd
6218 Control reaches this and subsequent routers only for addresses in the local
6219 domains. This router checks to see whether the local part is defined as an
6220 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6221 data that it looks up from that file. If no data is found for the local part,
6222 the value of the &%data%& option is empty, causing the address to be passed to
6223 the next router.
6224
6225 &_/etc/aliases_& is a conventional name for the system aliases file that is
6226 often used. That is why it is referenced by from the default configuration
6227 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6228 &_Local/Makefile_& before building Exim.
6229 .code
6230 userforward:
6231   driver = redirect
6232   check_local_user
6233 # local_part_suffix = +* : -*
6234 # local_part_suffix_optional
6235   file = $home/.forward
6236 # allow_filter
6237   no_verify
6238   no_expn
6239   check_ancestor
6240   file_transport = address_file
6241   pipe_transport = address_pipe
6242   reply_transport = address_reply
6243 .endd
6244 This is the most complicated router in the default configuration. It is another
6245 redirection router, but this time it is looking for forwarding data set up by
6246 individual users. The &%check_local_user%& setting specifies a check that the
6247 local part of the address is the login name of a local user. If it is not, the
6248 router is skipped. The two commented options that follow &%check_local_user%&,
6249 namely:
6250 .code
6251 # local_part_suffix = +* : -*
6252 # local_part_suffix_optional
6253 .endd
6254 .vindex "&$local_part_suffix$&"
6255 show how you can specify the recognition of local part suffixes. If the first
6256 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6257 by any sequence of characters, is removed from the local part and placed in the
6258 variable &$local_part_suffix$&. The second suffix option specifies that the
6259 presence of a suffix in the local part is optional. When a suffix is present,
6260 the check for a local login uses the local part with the suffix removed.
6261
6262 When a local user account is found, the file called &_.forward_& in the user's
6263 home directory is consulted. If it does not exist, or is empty, the router
6264 declines. Otherwise, the contents of &_.forward_& are interpreted as
6265 redirection data (see chapter &<<CHAPredirect>>& for more details).
6266
6267 .cindex "Sieve filter" "enabling in default router"
6268 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6269 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6270 is commented out by default), the contents of the file are interpreted as a set
6271 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6272 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6273 separate document entitled &'Exim's interfaces to mail filtering'&.
6274
6275 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6276 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6277 There are two reasons for doing this:
6278
6279 .olist
6280 Whether or not a local user has a &_.forward_& file is not really relevant when
6281 checking an address for validity; it makes sense not to waste resources doing
6282 unnecessary work.
6283 .next
6284 More importantly, when Exim is verifying addresses or handling an EXPN
6285 command during an SMTP session, it is running as the Exim user, not as root.
6286 The group is the Exim group, and no additional groups are set up.
6287 It may therefore not be possible for Exim to read users' &_.forward_& files at
6288 this time.
6289 .endlist
6290
6291 The setting of &%check_ancestor%& prevents the router from generating a new
6292 address that is the same as any previous address that was redirected. (This
6293 works round a problem concerning a bad interaction between aliasing and
6294 forwarding &-- see section &<<SECTredlocmai>>&).
6295
6296 The final three option settings specify the transports that are to be used when
6297 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6298 auto-reply, respectively. For example, if a &_.forward_& file contains
6299 .code
6300 a.nother@elsewhere.example, /home/spqr/archive
6301 .endd
6302 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6303 transport.
6304 .code
6305 localuser:
6306   driver = accept
6307   check_local_user
6308 # local_part_suffix = +* : -*
6309 # local_part_suffix_optional
6310   transport = local_delivery
6311 .endd
6312 The final router sets up delivery into local mailboxes, provided that the local
6313 part is the name of a local login, by accepting the address and assigning it to
6314 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6315 routers, so the address is bounced. The commented suffix settings fulfil the
6316 same purpose as they do for the &(userforward)& router.
6317
6318
6319 .section "Transport configuration" "SECID56"
6320 .cindex "default" "transports"
6321 .cindex "transports" "default"
6322 Transports define mechanisms for actually delivering messages. They operate
6323 only when referenced from routers, so the order in which they are defined does
6324 not matter. The transports section of the configuration starts with
6325 .code
6326 begin transports
6327 .endd
6328 Two remote transports and four local transports are defined.
6329 .code
6330 remote_smtp:
6331   driver = smtp
6332   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6333 .ifdef _HAVE_PRDR
6334   hosts_try_prdr = *
6335 .endif
6336 .endd
6337 This transport is used for delivering messages over SMTP connections.
6338 The list of remote hosts comes from the router.
6339 The &%message_size_limit%& usage is a hack to avoid sending on messages
6340 with over-long lines.
6341
6342 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6343 negotiated between client and server and not expected to cause problems
6344 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6345 use of the &%hosts_try_prdr%& configuration option.
6346
6347 The other remote transport is used when delivering to a specific smarthost
6348 with whom there must be some kind of existing relationship, instead of the
6349 usual federated system.
6350
6351 .code
6352 smarthost_smtp:
6353   driver = smtp
6354   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6355   multi_domain
6356   #
6357 .ifdef _HAVE_TLS
6358   # Comment out any of these which you have to, then file a Support
6359   # request with your smarthost provider to get things fixed:
6360   hosts_require_tls = *
6361   tls_verify_hosts = *
6362   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6363   # have to comment it out then this will at least log whether you succeed
6364   # or not:
6365   tls_try_verify_hosts = *
6366   #
6367   # The SNI name should match the name which we'll expect to verify;
6368   # many mail systems don't use SNI and this doesn't matter, but if it does,
6369   # we need to send a name which the remote site will recognize.
6370   # This _should_ be the name which the smarthost operators specified as
6371   # the hostname for sending your mail to.
6372   tls_sni = ROUTER_SMARTHOST
6373   #
6374 .ifdef _HAVE_OPENSSL
6375   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6376 .endif
6377 .ifdef _HAVE_GNUTLS
6378   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6379 .endif
6380 .endif
6381 .ifdef _HAVE_PRDR
6382   hosts_try_prdr = *
6383 .endif
6384 .endd
6385 After the same &%message_size_limit%& hack, we then specify that this Transport
6386 can handle messages to multiple domains in one run.  The assumption here is
6387 that you're routing all non-local mail to the same place and that place is
6388 happy to take all messages from you as quickly as possible.
6389 All other options depend upon built-in macros; if Exim was built without TLS support
6390 then no other options are defined.
6391 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6392 and versions using the &%tls_require_ciphers%& option, where the value to be
6393 used depends upon the library providing TLS.
6394 Beyond that, the options adopt the stance that you should have TLS support available
6395 from your smarthost on today's Internet, so we turn on requiring TLS for the
6396 mail to be delivered, and requiring that the certificate be valid, and match
6397 the expected hostname.  The &%tls_sni%& option can be used by service providers
6398 to select an appropriate certificate to present to you and here we re-use the
6399 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6400 You want to specify the hostname which you'll expect to validate for, and that
6401 should not be subject to insecure tampering via DNS results.
6402
6403 For the &%hosts_try_prdr%& option see the previous transport.
6404
6405 All other options are defaulted.
6406 .code
6407 local_delivery:
6408   driver = appendfile
6409   file = /var/mail/$local_part_data
6410   delivery_date_add
6411   envelope_to_add
6412   return_path_add
6413 # group = mail
6414 # mode = 0660
6415 .endd
6416 This &(appendfile)& transport is used for local delivery to user mailboxes in
6417 traditional BSD mailbox format.
6418
6419 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6420 as it is provided by a potential bad actor.
6421 Instead we use &$local_part_data$&,
6422 the result of looking up &$local_part$& in the user database
6423 (done by using &%check_local_user%& in the the router).
6424
6425 By default &(appendfile)& runs under the uid and gid of the
6426 local user, which requires the sticky bit to be set on the &_/var/mail_&
6427 directory. Some systems use the alternative approach of running mail deliveries
6428 under a particular group instead of using the sticky bit. The commented options
6429 show how this can be done.
6430
6431 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6432 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6433 similarly-named options above.
6434 .code
6435 address_pipe:
6436   driver = pipe
6437   return_output
6438 .endd
6439 This transport is used for handling deliveries to pipes that are generated by
6440 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6441 option specifies that any output on stdout or stderr generated by the pipe is to
6442 be returned to the sender.
6443 .code
6444 address_file:
6445   driver = appendfile
6446   delivery_date_add
6447   envelope_to_add
6448   return_path_add
6449 .endd
6450 This transport is used for handling deliveries to files that are generated by
6451 redirection. The name of the file is not specified in this instance of
6452 &(appendfile)&, because it comes from the &(redirect)& router.
6453 .code
6454 address_reply:
6455   driver = autoreply
6456 .endd
6457 This transport is used for handling automatic replies generated by users'
6458 filter files.
6459
6460
6461
6462 .section "Default retry rule" "SECID57"
6463 .cindex "retry" "default rule"
6464 .cindex "default" "retry rule"
6465 The retry section of the configuration file contains rules which affect the way
6466 Exim retries deliveries that cannot be completed at the first attempt. It is
6467 introduced by the line
6468 .code
6469 begin retry
6470 .endd
6471 In the default configuration, there is just one rule, which applies to all
6472 errors:
6473 .code
6474 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6475 .endd
6476 This causes any temporarily failing address to be retried every 15 minutes for
6477 2 hours, then at intervals starting at one hour and increasing by a factor of
6478 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6479 is not delivered after 4 days of temporary failure, it is bounced. The time is
6480 measured from first failure, not from the time the message was received.
6481
6482 If the retry section is removed from the configuration, or is empty (that is,
6483 if no retry rules are defined), Exim will not retry deliveries. This turns
6484 temporary errors into permanent errors.
6485
6486
6487 .section "Rewriting configuration" "SECID58"
6488 The rewriting section of the configuration, introduced by
6489 .code
6490 begin rewrite
6491 .endd
6492 contains rules for rewriting addresses in messages as they arrive. There are no
6493 rewriting rules in the default configuration file.
6494
6495
6496
6497 .section "Authenticators configuration" "SECTdefconfauth"
6498 .cindex "AUTH" "configuration"
6499 The authenticators section of the configuration, introduced by
6500 .code
6501 begin authenticators
6502 .endd
6503 defines mechanisms for the use of the SMTP AUTH command. The default
6504 configuration file contains two commented-out example authenticators
6505 which support plaintext username/password authentication using the
6506 standard PLAIN mechanism and the traditional but non-standard LOGIN
6507 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6508 to support most MUA software.
6509
6510 The example PLAIN authenticator looks like this:
6511 .code
6512 #PLAIN:
6513 #  driver                  = plaintext
6514 #  server_set_id           = $auth2
6515 #  server_prompts          = :
6516 #  server_condition        = Authentication is not yet configured
6517 #  server_advertise_condition = ${if def:tls_in_cipher }
6518 .endd
6519 And the example LOGIN authenticator looks like this:
6520 .code
6521 #LOGIN:
6522 #  driver                  = plaintext
6523 #  server_set_id           = $auth1
6524 #  server_prompts          = <| Username: | Password:
6525 #  server_condition        = Authentication is not yet configured
6526 #  server_advertise_condition = ${if def:tls_in_cipher }
6527 .endd
6528
6529 The &%server_set_id%& option makes Exim remember the authenticated username
6530 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6531 &%server_prompts%& option configures the &(plaintext)& authenticator so
6532 that it implements the details of the specific authentication mechanism,
6533 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6534 when Exim offers authentication to clients; in the examples, this is only
6535 when TLS or SSL has been started, so to enable the authenticators you also
6536 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6537
6538 The &%server_condition%& setting defines how to verify that the username and
6539 password are correct. In the examples it just produces an error message.
6540 To make the authenticators work, you can use a string expansion
6541 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6542
6543 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6544 usercode and password are in different positions.
6545 Chapter &<<CHAPplaintext>>& covers both.
6546
6547 .ecindex IIDconfiwal
6548
6549
6550
6551 . ////////////////////////////////////////////////////////////////////////////
6552 . ////////////////////////////////////////////////////////////////////////////
6553
6554 .chapter "Regular expressions" "CHAPregexp"
6555
6556 .cindex "regular expressions" "library"
6557 .cindex "PCRE"
6558 Exim supports the use of regular expressions in many of its options. It
6559 uses the PCRE regular expression library; this provides regular expression
6560 matching that is compatible with Perl 5. The syntax and semantics of
6561 regular expressions is discussed in
6562 online Perl manpages, in
6563 many Perl reference books, and also in
6564 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6565 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6566 . --- the http: URL here redirects to another page with the ISBN in the URL
6567 . --- where trying to use https: just redirects back to http:, so sticking
6568 . --- to the old URL for now.  2018-09-07.
6569
6570 The documentation for the syntax and semantics of the regular expressions that
6571 are supported by PCRE is included in the PCRE distribution, and no further
6572 description is included here. The PCRE functions are called from Exim using
6573 the default option settings (that is, with no PCRE options set), except that
6574 the PCRE_CASELESS option is set when the matching is required to be
6575 case-insensitive.
6576
6577 In most cases, when a regular expression is required in an Exim configuration,
6578 it has to start with a circumflex, in order to distinguish it from plain text
6579 or an &"ends with"& wildcard. In this example of a configuration setting, the
6580 second item in the colon-separated list is a regular expression.
6581 .code
6582 domains = a.b.c : ^\\d{3} : *.y.z : ...
6583 .endd
6584 The doubling of the backslash is required because of string expansion that
6585 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6586 of this issue, and a way of avoiding the need for doubling backslashes. The
6587 regular expression that is eventually used in this example contains just one
6588 backslash. The circumflex is included in the regular expression, and has the
6589 normal effect of &"anchoring"& it to the start of the string that is being
6590 matched.
6591
6592 There are, however, two cases where a circumflex is not required for the
6593 recognition of a regular expression: these are the &%match%& condition in a
6594 string expansion, and the &%matches%& condition in an Exim filter file. In
6595 these cases, the relevant string is always treated as a regular expression; if
6596 it does not start with a circumflex, the expression is not anchored, and can
6597 match anywhere in the subject string.
6598
6599 In all cases, if you want a regular expression to match at the end of a string,
6600 you must code the $ metacharacter to indicate this. For example:
6601 .code
6602 domains = ^\\d{3}\\.example
6603 .endd
6604 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6605 You need to use:
6606 .code
6607 domains = ^\\d{3}\\.example\$
6608 .endd
6609 if you want &'example'& to be the top-level domain. The backslash before the
6610 $ is needed because string expansion also interprets dollar characters.
6611
6612
6613
6614 . ////////////////////////////////////////////////////////////////////////////
6615 . ////////////////////////////////////////////////////////////////////////////
6616
6617 .chapter "File and database lookups" "CHAPfdlookup"
6618 .scindex IIDfidalo1 "file" "lookups"
6619 .scindex IIDfidalo2 "database" "lookups"
6620 .cindex "lookup" "description of"
6621 Exim can be configured to look up data in files or databases as it processes
6622 messages. Two different kinds of syntax are used:
6623
6624 .olist
6625 A string that is to be expanded may contain explicit lookup requests. These
6626 cause parts of the string to be replaced by data that is obtained from the
6627 lookup. Lookups of this type are conditional expansion items. Different results
6628 can be defined for the cases of lookup success and failure. See chapter
6629 &<<CHAPexpand>>&, where string expansions are described in detail.
6630 The key for the lookup is &*specified*& as part of the string expansion.
6631 .next
6632 Lists of domains, hosts, and email addresses can contain lookup requests as a
6633 way of avoiding excessively long linear lists. In this case, the data that is
6634 returned by the lookup is often (but not always) discarded; whether the lookup
6635 succeeds or fails is what really counts. These kinds of list are described in
6636 chapter &<<CHAPdomhosaddlists>>&.
6637 The key for the lookup is &*implicit*&,
6638 given by the context in which the list is expanded.
6639 .endlist
6640
6641 String expansions, lists, and lookups interact with each other in such a way
6642 that there is no order in which to describe any one of them that does not
6643 involve references to the others. Each of these three chapters makes more sense
6644 if you have read the other two first. If you are reading this for the first
6645 time, be aware that some of it will make a lot more sense after you have read
6646 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6647
6648 .section "Examples of different lookup syntax" "SECID60"
6649 It is easy to confuse the two different kinds of lookup, especially as the
6650 lists that may contain the second kind are always expanded before being
6651 processed as lists. Therefore, they may also contain lookups of the first kind.
6652 Be careful to distinguish between the following two examples:
6653 .code
6654 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6655 domains = lsearch;/some/file
6656 .endd
6657 The first uses a string expansion, the result of which must be a domain list.
6658 No strings have been specified for a successful or a failing lookup; the
6659 defaults in this case are the looked-up data and an empty string, respectively.
6660 The expansion takes place before the string is processed as a list, and the
6661 file that is searched could contain lines like this:
6662 .code
6663 192.168.3.4: domain1:domain2:...
6664 192.168.1.9: domain3:domain4:...
6665 .endd
6666 When the lookup succeeds, the result of the expansion is a list of domains (and
6667 possibly other types of item that are allowed in domain lists).
6668 .cindex "tainted data" "de-tainting"
6669 The result of the expansion is not tainted.
6670
6671 In the second example, the lookup is a single item in a domain list. It causes
6672 Exim to use a lookup to see if the domain that is being processed can be found
6673 in the file.
6674 The file could contains lines like this:
6675 .code
6676 domain1:
6677 domain2:
6678 .endd
6679 Any data that follows the keys is not relevant when checking that the domain
6680 matches the list item.
6681
6682 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6683 Consider a file containing lines like this:
6684 .code
6685 192.168.5.6: lsearch;/another/file
6686 .endd
6687 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6688 first &%domains%& setting above generates the second setting, which therefore
6689 causes a second lookup to occur.
6690
6691 .new
6692 The lookup type may optionally be followed by a comma
6693 and a comma-separated list of options.
6694 Each option is a &"name=value"& pair.
6695 Whether an option is meaningful depands on the lookup type.
6696
6697 All lookups support the option &"cache=no_rd"&.
6698 If this is given then the cache that Exim manages for lookup results
6699 is not checked before diong the lookup.
6700 The result of the lookup is still written to the cache.
6701 .wen
6702
6703 The rest of this chapter describes the different lookup types that are
6704 available. Any of them can be used in any part of the configuration where a
6705 lookup is permitted.
6706
6707
6708 .section "Lookup types" "SECID61"
6709 .cindex "lookup" "types of"
6710 .cindex "single-key lookup" "definition of"
6711 Two different types of data lookup are implemented:
6712
6713 .ilist
6714 The &'single-key'& type requires the specification of a file in which to look,
6715 and a single key to search for. The key must be a non-empty string for the
6716 lookup to succeed. The lookup type determines how the file is searched.
6717 .cindex "tainted data" "single-key lookups"
6718 The file string may not be tainted
6719
6720 .cindex "tainted data" "de-tainting"
6721 All single-key lookups support the option &"ret=key"&.
6722 If this is given and the lookup
6723 (either underlying implementation or cached value)
6724 returns data, the result is replaced with a non-tainted
6725 version of the lookup key.
6726 .cindex "tainted data" "de-tainting"
6727 .next
6728 .cindex "query-style lookup" "definition of"
6729 The &'query-style'& type accepts a generalized database query. No particular
6730 key value is assumed by Exim for query-style lookups. You can use whichever
6731 Exim variables you need to construct the database query.
6732 .endlist
6733
6734 The code for each lookup type is in a separate source file that is included in
6735 the binary of Exim only if the corresponding compile-time option is set. The
6736 default settings in &_src/EDITME_& are:
6737 .code
6738 LOOKUP_DBM=yes
6739 LOOKUP_LSEARCH=yes
6740 .endd
6741 which means that only linear searching and DBM lookups are included by default.
6742 For some types of lookup (e.g. SQL databases), you need to install appropriate
6743 libraries and header files before building Exim.
6744
6745
6746
6747
6748 .section "Single-key lookup types" "SECTsinglekeylookups"
6749 .cindex "lookup" "single-key types"
6750 .cindex "single-key lookup" "list of types"
6751 The following single-key lookup types are implemented:
6752
6753 .ilist
6754 .cindex "cdb" "description of"
6755 .cindex "lookup" "cdb"
6756 .cindex "binary zero" "in lookup key"
6757 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6758 string without a terminating binary zero. The cdb format is designed for
6759 indexed files that are read frequently and never updated, except by total
6760 re-creation. As such, it is particularly suitable for large files containing
6761 aliases or other indexed data referenced by an MTA. Information about cdb and
6762 tools for building the files can be found in several places:
6763 .display
6764 &url(https://cr.yp.to/cdb.html)
6765 &url(https://www.corpit.ru/mjt/tinycdb.html)
6766 &url(https://packages.debian.org/stable/utils/freecdb)
6767 &url(https://github.com/philpennock/cdbtools) (in Go)
6768 .endd
6769 A cdb distribution is not needed in order to build Exim with cdb support,
6770 because the code for reading cdb files is included directly in Exim itself.
6771 However, no means of building or testing cdb files is provided with Exim, so
6772 you need to obtain a cdb distribution in order to do this.
6773 .next
6774 .cindex "DBM" "lookup type"
6775 .cindex "lookup" "dbm"
6776 .cindex "binary zero" "in lookup key"
6777 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6778 DBM file by looking up the record with the given key. A terminating binary
6779 zero is included in the key that is passed to the DBM library. See section
6780 &<<SECTdb>>& for a discussion of DBM libraries.
6781
6782 .cindex "Berkeley DB library" "file format"
6783 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6784 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6785 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6786 the DB_UNKNOWN option. This enables it to handle any of the types of database
6787 that the library supports, and can be useful for accessing DBM files created by
6788 other applications. (For earlier DB versions, DB_HASH is always used.)
6789 .next
6790 .cindex "lookup" "dbmjz"
6791 .cindex "lookup" "dbm &-- embedded NULs"
6792 .cindex "sasldb2"
6793 .cindex "dbmjz lookup type"
6794 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6795 interpreted as an Exim list; the elements of the list are joined together with
6796 ASCII NUL characters to form the lookup key.  An example usage would be to
6797 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6798 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6799 &(cram_md5)& authenticator.
6800 .next
6801 .cindex "lookup" "dbmnz"
6802 .cindex "lookup" "dbm &-- terminating zero"
6803 .cindex "binary zero" "in lookup key"
6804 .cindex "Courier"
6805 .cindex "&_/etc/userdbshadow.dat_&"
6806 .cindex "dbmnz lookup type"
6807 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6808 is not included in the key that is passed to the DBM library. You may need this
6809 if you want to look up data in files that are created by or shared with some
6810 other application that does not use terminating zeros. For example, you need to
6811 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6812 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6813 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6814 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6815 .next
6816 .cindex "lookup" "dsearch"
6817 .cindex "dsearch lookup type"
6818 &(dsearch)&: The given file must be an
6819 absolute
6820 directory path; this is searched for an entry
6821 whose name is the key by calling the &[lstat()]& function.
6822 The key may not
6823 contain any forward slash characters.
6824 If &[lstat()]& succeeds then so does the lookup.
6825 .cindex "tainted data" "dsearch result"
6826 The result is regarded as untainted.
6827
6828 Options for the lookup can be given by appending them after the word "dsearch",
6829 separated by a comma.  Options, if present, are a comma-separated list having
6830 each element starting with a tag name and an equals.
6831
6832 Two options are supported, for the return value and for filtering match
6833 candidates.
6834 The "ret" option requests an alternate result value of
6835 the entire path for the entry. Example:
6836 .code
6837 ${lookup {passwd} dsearch,ret=full {/etc}}
6838 .endd
6839 The default result is just the requested entry.
6840 The "filter" option requests that only directory entries of a given type
6841 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6842 not matching "." or ".."). Example:
6843 .code
6844 ${lookup {passwd} dsearch,filter=file {/etc}}
6845 .endd
6846 The default matching is for any entry type, including directories
6847 and symlinks.
6848
6849 An example of how this
6850 lookup can be used to support virtual domains is given in section
6851 &<<SECTvirtualdomains>>&.
6852 .next
6853 .cindex "lookup" "iplsearch"
6854 .cindex "iplsearch lookup type"
6855 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6856 terminated by a colon or white space or the end of the line. The keys in the
6857 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6858 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6859 being interpreted as a key terminator. For example:
6860 .code
6861 1.2.3.4:           data for 1.2.3.4
6862 192.168.0.0/16:    data for 192.168.0.0/16
6863 "abcd::cdab":      data for abcd::cdab
6864 "abcd:abcd::/32"   data for abcd:abcd::/32
6865 .endd
6866 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6867 file is searched linearly, using the CIDR masks where present, until a matching
6868 key is found. The first key that matches is used; there is no attempt to find a
6869 &"best"& match. Apart from the way the keys are matched, the processing for
6870 &(iplsearch)& is the same as for &(lsearch)&.
6871
6872 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6873 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6874 lookup types support only literal keys.
6875
6876 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6877 the implicit key is the host's IP address rather than its name (see section
6878 &<<SECThoslispatsikey>>&).
6879
6880 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6881 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6882 notation before executing the lookup.)
6883
6884 .new
6885 One option is supported, "ret=full", to request the return of the entire line
6886 rather than omitting the key porttion.
6887 Note however that the key portion will have been de-quoted.
6888 .wen
6889
6890 .next
6891 .cindex lookup json
6892 .cindex json "lookup type"
6893 .cindex JSON expansions
6894 &(json)&: The given file is a text file with a JSON structure.
6895 An element of the structure is extracted, defined by the search key.
6896 The key is a list of subelement selectors
6897 (colon-separated by default but changeable in the usual way)
6898 which are applied in turn to select smaller and smaller portions
6899 of the JSON structure.
6900 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6901 nunbered array element is selected.
6902 Otherwise it must apply to a JSON object; the named element is selected.
6903 The final resulting element can be a simple JSON type or a JSON object
6904 or array; for the latter two a string-representation of the JSON
6905 is returned.
6906 For elements of type string, the returned value is de-quoted.
6907
6908
6909 .new
6910 .next
6911 .cindex LMDB
6912 .cindex lookup lmdb
6913 .cindex database lmdb
6914 &(lmdb)&: The given file is an LMDB database.
6915 LMDB is a memory-mapped key-value store,
6916 with API modeled loosely on that of BerkeleyDB.
6917 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6918 for the feature set and operation modes.
6919
6920 Exim provides read-only access via the LMDB C library.
6921 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6922 or your operating system package repository.
6923 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6924
6925 You will need to separately create the LMDB database file,
6926 possibly using the &"mdb_load"& utility.
6927 .wen
6928
6929
6930 .next
6931 .cindex "linear search"
6932 .cindex "lookup" "lsearch"
6933 .cindex "lsearch lookup type"
6934 .cindex "case sensitivity" "in lsearch lookup"
6935 &(lsearch)&: The given file is a text file that is searched linearly for a
6936 line beginning with the search key, terminated by a colon or white space or the
6937 end of the line. The search is case-insensitive; that is, upper and lower case
6938 letters are treated as the same. The first occurrence of the key that is found
6939 in the file is used.
6940
6941 White space between the key and the colon is permitted. The remainder of the
6942 line, with leading and trailing white space removed, is the data. This can be
6943 continued onto subsequent lines by starting them with any amount of white
6944 space, but only a single space character is included in the data at such a
6945 junction. If the data begins with a colon, the key must be terminated by a
6946 colon, for example:
6947 .code
6948 baduser:  :fail:
6949 .endd
6950 Empty lines and lines beginning with # are ignored, even if they occur in the
6951 middle of an item. This is the traditional textual format of alias files. Note
6952 that the keys in an &(lsearch)& file are literal strings. There is no
6953 wildcarding of any kind.
6954
6955 .cindex "lookup" "lsearch &-- colons in keys"
6956 .cindex "white space" "in lsearch key"
6957 In most &(lsearch)& files, keys are not required to contain colons or #
6958 characters, or white space. However, if you need this feature, it is available.
6959 If a key begins with a doublequote character, it is terminated only by a
6960 matching quote (or end of line), and the normal escaping rules apply to its
6961 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6962 quoted keys (exactly as for unquoted keys). There is no special handling of
6963 quotes for the data part of an &(lsearch)& line.
6964
6965 .next
6966 .cindex "NIS lookup type"
6967 .cindex "lookup" "NIS"
6968 .cindex "binary zero" "in lookup key"
6969 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6970 the given key, without a terminating binary zero. There is a variant called
6971 &(nis0)& which does include the terminating binary zero in the key. This is
6972 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6973 aliases; the full map names must be used.
6974
6975 .next
6976 .cindex "wildlsearch lookup type"
6977 .cindex "lookup" "wildlsearch"
6978 .cindex "nwildlsearch lookup type"
6979 .cindex "lookup" "nwildlsearch"
6980 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6981 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6982 the file may be wildcarded. The difference between these two lookup types is
6983 that for &(wildlsearch)&, each key in the file is string-expanded before being
6984 used, whereas for &(nwildlsearch)&, no expansion takes place.
6985
6986 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6987 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6988 file that are regular expressions can be made case-sensitive by the use of
6989 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6990
6991 . ==== As this is a nested list, any displays it contains must be indented
6992 . ==== as otherwise they are too far to the left.
6993
6994 .olist
6995 The string may begin with an asterisk to mean &"ends with"&. For example:
6996 .code
6997     *.a.b.c       data for anything.a.b.c
6998     *fish         data for anythingfish
6999 .endd
7000 .next
7001 The string may begin with a circumflex to indicate a regular expression. For
7002 example, for &(wildlsearch)&:
7003 .code
7004     ^\N\d+\.a\.b\N    data for <digits>.a.b
7005 .endd
7006 Note the use of &`\N`& to disable expansion of the contents of the regular
7007 expression. If you are using &(nwildlsearch)&, where the keys are not
7008 string-expanded, the equivalent entry is:
7009 .code
7010     ^\d+\.a\.b        data for <digits>.a.b
7011 .endd
7012 The case-insensitive flag is set at the start of compiling the regular
7013 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7014 For example, to make the entire pattern case-sensitive:
7015 .code
7016     ^(?-i)\d+\.a\.b        data for <digits>.a.b
7017 .endd
7018
7019 If the regular expression contains white space or colon characters, you must
7020 either quote it (see &(lsearch)& above), or represent these characters in other
7021 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7022 colon. This may be easier than quoting, because if you quote, you have to
7023 escape all the backslashes inside the quotes.
7024
7025 &*Note*&: It is not possible to capture substrings in a regular expression
7026 match for later use, because the results of all lookups are cached. If a lookup
7027 is repeated, the result is taken from the cache, and no actual pattern matching
7028 takes place. The values of all the numeric variables are unset after a
7029 &((n)wildlsearch)& match.
7030
7031 .next
7032 Although I cannot see it being of much use, the general matching function that
7033 is used to implement &((n)wildlsearch)& means that the string may begin with a
7034 lookup name terminated by a semicolon, and followed by lookup data. For
7035 example:
7036 .code
7037     cdb;/some/file  data for keys that match the file
7038 .endd
7039 The data that is obtained from the nested lookup is discarded.
7040 .endlist olist
7041
7042 Keys that do not match any of these patterns are interpreted literally. The
7043 continuation rules for the data are the same as for &(lsearch)&, and keys may
7044 be followed by optional colons.
7045
7046 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7047 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7048 lookup types support only literal keys.
7049
7050 .next
7051 .cindex "spf lookup type"
7052 .cindex "lookup" "spf"
7053 &(spf)&: If Exim is built with SPF support, manual lookups can be done
7054 (as opposed to the standard ACL condition method).
7055 For details see section &<<SECSPF>>&.
7056 .endlist ilist
7057
7058
7059 .section "Query-style lookup types" "SECTquerystylelookups"
7060 .cindex "lookup" "query-style types"
7061 .cindex "query-style lookup" "list of types"
7062 The supported query-style lookup types are listed below. Further details about
7063 many of them are given in later sections.
7064
7065 .ilist
7066 .cindex "DNS" "as a lookup type"
7067 .cindex "lookup" "DNS"
7068 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7069 are given in the supplied query. The resulting data is the contents of the
7070 records. See section &<<SECTdnsdb>>&.
7071 .next
7072 .cindex "InterBase lookup type"
7073 .cindex "lookup" "InterBase"
7074 &(ibase)&: This does a lookup in an InterBase database.
7075 .next
7076 .cindex "LDAP" "lookup type"
7077 .cindex "lookup" "LDAP"
7078 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7079 returns attributes from a single entry. There is a variant called &(ldapm)&
7080 that permits values from multiple entries to be returned. A third variant
7081 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7082 any attribute values. See section &<<SECTldap>>&.
7083 .next
7084 .cindex "MySQL" "lookup type"
7085 .cindex "lookup" "MySQL"
7086 &(mysql)&: The format of the query is an SQL statement that is passed to a
7087 MySQL database. See section &<<SECTsql>>&.
7088 .next
7089 .cindex "NIS+ lookup type"
7090 .cindex "lookup" "NIS+"
7091 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7092 the field to be returned. See section &<<SECTnisplus>>&.
7093 .next
7094 .cindex "Oracle" "lookup type"
7095 .cindex "lookup" "Oracle"
7096 &(oracle)&: The format of the query is an SQL statement that is passed to an
7097 Oracle database. See section &<<SECTsql>>&.
7098 .next
7099 .cindex "lookup" "passwd"
7100 .cindex "passwd lookup type"
7101 .cindex "&_/etc/passwd_&"
7102 &(passwd)& is a query-style lookup with queries that are just user names. The
7103 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7104 success, the result string is the same as you would get from an &(lsearch)&
7105 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7106 password value. For example:
7107 .code
7108 *:42:42:King Rat:/home/kr:/bin/bash
7109 .endd
7110 .next
7111 .cindex "PostgreSQL lookup type"
7112 .cindex "lookup" "PostgreSQL"
7113 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7114 PostgreSQL database. See section &<<SECTsql>>&.
7115
7116 .next
7117 .cindex "Redis lookup type"
7118 .cindex lookup Redis
7119 &(redis)&: The format of the query is either a simple get or simple set,
7120 passed to a Redis database. See section &<<SECTsql>>&.
7121
7122 .next
7123 .cindex "sqlite lookup type"
7124 .cindex "lookup" "sqlite"
7125 &(sqlite)&: The format of the query is
7126 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7127
7128 .next
7129 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7130 not likely to be useful in normal operation.
7131 .next
7132 .cindex "whoson lookup type"
7133 .cindex "lookup" "whoson"
7134 . --- still http:-only, 2018-09-07
7135 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7136 allows a server to check whether a particular (dynamically allocated) IP
7137 address is currently allocated to a known (trusted) user and, optionally, to
7138 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7139 at one time for &"POP before SMTP"& authentication, but that approach has been
7140 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7141 &"POP before SMTP"& checking using ACL statements such as
7142 .code
7143 require condition = \
7144   ${lookup whoson {$sender_host_address}{yes}{no}}
7145 .endd
7146 The query consists of a single IP address. The value returned is the name of
7147 the authenticated user, which is stored in the variable &$value$&. However, in
7148 this example, the data in &$value$& is not used; the result of the lookup is
7149 one of the fixed strings &"yes"& or &"no"&.
7150 .endlist
7151
7152
7153
7154 .section "Temporary errors in lookups" "SECID63"
7155 .cindex "lookup" "temporary error in"
7156 Lookup functions can return temporary error codes if the lookup cannot be
7157 completed. For example, an SQL or LDAP database might be unavailable. For this
7158 reason, it is not advisable to use a lookup that might do this for critical
7159 options such as a list of local domains.
7160
7161 When a lookup cannot be completed in a router or transport, delivery
7162 of the message (to the relevant address) is deferred, as for any other
7163 temporary error. In other circumstances Exim may assume the lookup has failed,
7164 or may give up altogether.
7165
7166
7167
7168 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7169 .cindex "wildcard lookups"
7170 .cindex "lookup" "default values"
7171 .cindex "lookup" "wildcard"
7172 .cindex "lookup" "* added to type"
7173 .cindex "default" "in single-key lookups"
7174 In this context, a &"default value"& is a value specified by the administrator
7175 that is to be used if a lookup fails.
7176
7177 &*Note:*& This section applies only to single-key lookups. For query-style
7178 lookups, the facilities of the query language must be used. An attempt to
7179 specify a default for a query-style lookup provokes an error.
7180
7181 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7182 and the initial lookup fails, the key &"*"& is looked up in the file to
7183 provide a default value. See also the section on partial matching below.
7184
7185 .cindex "*@ with single-key lookup"
7186 .cindex "lookup" "*@ added to type"
7187 .cindex "alias file" "per-domain default"
7188 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7189 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7190 character, a second lookup is done with everything before the last @ replaced
7191 by *. This makes it possible to provide per-domain defaults in alias files
7192 that include the domains in the keys. If the second lookup fails (or doesn't
7193 take place because there is no @ in the key), &"*"& is looked up.
7194 For example, a &(redirect)& router might contain:
7195 .code
7196 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7197 .endd
7198 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7199 looks up these keys, in this order:
7200 .code
7201 jane@eyre.example
7202 *@eyre.example
7203 *
7204 .endd
7205 The data is taken from whichever key it finds first. &*Note*&: In an
7206 &(lsearch)& file, this does not mean the first of these keys in the file. A
7207 complete scan is done for each key, and only if it is not found at all does
7208 Exim move on to try the next key.
7209
7210
7211
7212 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7213 .cindex "partial matching"
7214 .cindex "wildcard lookups"
7215 .cindex "lookup" "partial matching"
7216 .cindex "lookup" "wildcard"
7217 .cindex "asterisk" "in search type"
7218 The normal operation of a single-key lookup is to search the file for an exact
7219 match with the given key. However, in a number of situations where domains are
7220 being looked up, it is useful to be able to do partial matching. In this case,
7221 information in the file that has a key starting with &"*."& is matched by any
7222 domain that ends with the components that follow the full stop. For example, if
7223 a key in a DBM file is
7224 .code
7225 *.dates.fict.example
7226 .endd
7227 then when partial matching is enabled this is matched by (amongst others)
7228 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7229 by &'dates.fict.example'&, if that does not appear as a separate key in the
7230 file.
7231
7232 &*Note*&: Partial matching is not available for query-style lookups. It is
7233 also not available for any lookup items in address lists (see section
7234 &<<SECTaddresslist>>&).
7235
7236 Partial matching is implemented by doing a series of separate lookups using
7237 keys constructed by modifying the original subject key. This means that it can
7238 be used with any of the single-key lookup types, provided that
7239 partial matching keys
7240 beginning with a special prefix (default &"*."&) are included in the data file.
7241 Keys in the file that do not begin with the prefix are matched only by
7242 unmodified subject keys when partial matching is in use.
7243
7244 Partial matching is requested by adding the string &"partial-"& to the front of
7245 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7246 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7247 is added at the start of the subject key, and it is looked up again. If that
7248 fails, further lookups are tried with dot-separated components removed from the
7249 start of the subject key, one-by-one, and &"*."& added on the front of what
7250 remains.
7251
7252 A minimum number of two non-* components are required. This can be adjusted
7253 by including a number before the hyphen in the search type. For example,
7254 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7255 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7256 subject key is &'2250.dates.fict.example'& then the following keys are looked
7257 up when the minimum number of non-* components is two:
7258 .code
7259 2250.dates.fict.example
7260 *.2250.dates.fict.example
7261 *.dates.fict.example
7262 *.fict.example
7263 .endd
7264 As soon as one key in the sequence is successfully looked up, the lookup
7265 finishes.
7266
7267 .cindex "lookup" "partial matching &-- changing prefix"
7268 .cindex "prefix" "for partial matching"
7269 The use of &"*."& as the partial matching prefix is a default that can be
7270 changed. The motivation for this feature is to allow Exim to operate with file
7271 formats that are used by other MTAs. A different prefix can be supplied in
7272 parentheses instead of the hyphen after &"partial"&. For example:
7273 .code
7274 domains = partial(.)lsearch;/some/file
7275 .endd
7276 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7277 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7278 components is unchanged). The prefix may consist of any punctuation characters
7279 other than a closing parenthesis. It may be empty, for example:
7280 .code
7281 domains = partial1()cdb;/some/file
7282 .endd
7283 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7284 &`a.b.c`&, &`b.c`&, and &`c`&.
7285
7286 If &"partial0"& is specified, what happens at the end (when the lookup with
7287 just one non-wild component has failed, and the original key is shortened right
7288 down to the null string) depends on the prefix:
7289
7290 .ilist
7291 If the prefix has zero length, the whole lookup fails.
7292 .next
7293 If the prefix has length 1, a lookup for just the prefix is done. For
7294 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7295 .next
7296 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7297 remainder is looked up. With the default prefix, therefore, the final lookup is
7298 for &"*"& on its own.
7299 .next
7300 Otherwise, the whole prefix is looked up.
7301 .endlist
7302
7303
7304 If the search type ends in &"*"& or &"*@"& (see section
7305 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7306 this implies happens after all partial lookups have failed. If &"partial0"& is
7307 specified, adding &"*"& to the search type has no effect with the default
7308 prefix, because the &"*"& key is already included in the sequence of partial
7309 lookups. However, there might be a use for lookup types such as
7310 &"partial0(.)lsearch*"&.
7311
7312 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7313 in domain lists and the like. Partial matching works only in terms of
7314 dot-separated components; a key such as &`*fict.example`&
7315 in a database file is useless, because the asterisk in a partial matching
7316 subject key is always followed by a dot.
7317
7318
7319
7320
7321 .section "Lookup caching" "SECID64"
7322 .cindex "lookup" "caching"
7323 .cindex "caching" "lookup data"
7324 Exim caches all lookup results in order to avoid needless repetition of
7325 lookups. However, because (apart from the daemon) Exim operates as a collection
7326 of independent, short-lived processes, this caching applies only within a
7327 single Exim process. There is no inter-process lookup caching facility.
7328
7329 For single-key lookups, Exim keeps the relevant files open in case there is
7330 another lookup that needs them. In some types of configuration this can lead to
7331 many files being kept open for messages with many recipients. To avoid hitting
7332 the operating system limit on the number of simultaneously open files, Exim
7333 closes the least recently used file when it needs to open more files than its
7334 own internal limit, which can be changed via the &%lookup_open_max%& option.
7335
7336 The single-key lookup files are closed and the lookup caches are flushed at
7337 strategic points during delivery &-- for example, after all routing is
7338 complete.
7339
7340
7341
7342
7343 .section "Quoting lookup data" "SECID65"
7344 .cindex "lookup" "quoting"
7345 .cindex "quoting" "in lookups"
7346 When data from an incoming message is included in a query-style lookup, there
7347 is the possibility of special characters in the data messing up the syntax of
7348 the query. For example, a NIS+ query that contains
7349 .code
7350 [name=$local_part]
7351 .endd
7352 will be broken if the local part happens to contain a closing square bracket.
7353 For NIS+, data can be enclosed in double quotes like this:
7354 .code
7355 [name="$local_part"]
7356 .endd
7357 but this still leaves the problem of a double quote in the data. The rule for
7358 NIS+ is that double quotes must be doubled. Other lookup types have different
7359 rules, and to cope with the differing requirements, an expansion operator
7360 of the following form is provided:
7361 .code
7362 ${quote_<lookup-type>:<string>}
7363 .endd
7364 For example, the safest way to write the NIS+ query is
7365 .code
7366 [name="${quote_nisplus:$local_part}"]
7367 .endd
7368 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7369 operator can be used for all lookup types, but has no effect for single-key
7370 lookups, since no quoting is ever needed in their key strings.
7371
7372
7373
7374
7375 .section "More about dnsdb" "SECTdnsdb"
7376 .cindex "dnsdb lookup"
7377 .cindex "lookup" "dnsdb"
7378 .cindex "DNS" "as a lookup type"
7379 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7380 of a record type and a domain name, separated by an equals sign. For example,
7381 an expansion string could contain:
7382 .code
7383 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7384 .endd
7385 If the lookup succeeds, the result is placed in &$value$&, which in this case
7386 is used on its own as the result. If the lookup does not succeed, the
7387 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7388 &<<SECTforexpfai>>& for an explanation of what this means.
7389
7390 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7391 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7392 If no type is given, TXT is assumed.
7393
7394 For any record type, if multiple records are found, the data is returned as a
7395 concatenation, with newline as the default separator. The order, of course,
7396 depends on the DNS resolver. You can specify a different separator character
7397 between multiple records by putting a right angle-bracket followed immediately
7398 by the new separator at the start of the query. For example:
7399 .code
7400 ${lookup dnsdb{>: a=host1.example}}
7401 .endd
7402 It is permitted to specify a space as the separator character. Further
7403 white space is ignored.
7404 For lookup types that return multiple fields per record,
7405 an alternate field separator can be specified using a comma after the main
7406 separator character, followed immediately by the field separator.
7407
7408 .cindex "PTR record" "in &(dnsdb)& lookup"
7409 When the type is PTR,
7410 the data can be an IP address, written as normal; inversion and the addition of
7411 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7412 .code
7413 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7414 .endd
7415 If the data for a PTR record is not a syntactically valid IP address, it is not
7416 altered and nothing is added.
7417
7418 .cindex "MX record" "in &(dnsdb)& lookup"
7419 .cindex "SRV record" "in &(dnsdb)& lookup"
7420 For an MX lookup, both the preference value and the host name are returned for
7421 each record, separated by a space. For an SRV lookup, the priority, weight,
7422 port, and host name are returned for each record, separated by spaces.
7423 The field separator can be modified as above.
7424
7425 .cindex "TXT record" "in &(dnsdb)& lookup"
7426 .cindex "SPF record" "in &(dnsdb)& lookup"
7427 For TXT records with multiple items of data, only the first item is returned,
7428 unless a field separator is specified.
7429 To concatenate items without a separator, use a semicolon instead.
7430 For SPF records the
7431 default behaviour is to concatenate multiple items without using a separator.
7432 .code
7433 ${lookup dnsdb{>\n,: txt=a.b.example}}
7434 ${lookup dnsdb{>\n; txt=a.b.example}}
7435 ${lookup dnsdb{spf=example.org}}
7436 .endd
7437 It is permitted to specify a space as the separator character. Further
7438 white space is ignored.
7439
7440 .cindex "SOA record" "in &(dnsdb)& lookup"
7441 For an SOA lookup, while no result is obtained the lookup is redone with
7442 successively more leading components dropped from the given domain.
7443 Only the primary-nameserver field is returned unless a field separator is
7444 specified.
7445 .code
7446 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7447 .endd
7448
7449 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7450 .cindex "dnsdb modifiers"
7451 .cindex "modifiers" "dnsdb"
7452 .cindex "options" "dnsdb"
7453 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7454 each followed by a comma,
7455 that may appear before the record type.
7456
7457 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7458 temporary DNS error for any of them, the behaviour is controlled by
7459 a defer-option modifier.
7460 The possible keywords are
7461 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7462 With &"strict"& behaviour, any temporary DNS error causes the
7463 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7464 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7465 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7466 error causes the whole lookup to defer only if none of the other lookups
7467 succeed. The default is &"lax"&, so the following lookups are equivalent:
7468 .code
7469 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7470 ${lookup dnsdb{a=one.host.com:two.host.com}}
7471 .endd
7472 Thus, in the default case, as long as at least one of the DNS lookups
7473 yields some data, the lookup succeeds.
7474
7475 .cindex "DNSSEC" "dns lookup"
7476 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7477 The possible keywords are
7478 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7479 With &"strict"& or &"lax"& DNSSEC information is requested
7480 with the lookup.
7481 With &"strict"& a response from the DNS resolver that
7482 is not labelled as authenticated data
7483 is treated as equivalent to a temporary DNS error.
7484 The default is &"lax"&.
7485
7486 See also the &$lookup_dnssec_authenticated$& variable.
7487
7488 .cindex timeout "dns lookup"
7489 .cindex "DNS" timeout
7490 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7491 The form is &"retrans_VAL"& where VAL is an Exim time specification
7492 (e.g. &"5s"&).
7493 The default value is set by the main configuration option &%dns_retrans%&.
7494
7495 Retries for the dnsdb lookup can be controlled by a retry modifier.
7496 The form if &"retry_VAL"& where VAL is an integer.
7497 The default count is set by the main configuration option &%dns_retry%&.
7498
7499 .cindex caching "of dns lookup"
7500 .cindex TTL "of dns lookup"
7501 .cindex DNS TTL
7502 Dnsdb lookup results are cached within a single process (and its children).
7503 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7504 value of the set of returned DNS records.
7505
7506
7507 .section "Pseudo dnsdb record types" "SECID66"
7508 .cindex "MX record" "in &(dnsdb)& lookup"
7509 By default, both the preference value and the host name are returned for
7510 each MX record, separated by a space. If you want only host names, you can use
7511 the pseudo-type MXH:
7512 .code
7513 ${lookup dnsdb{mxh=a.b.example}}
7514 .endd
7515 In this case, the preference values are omitted, and just the host names are
7516 returned.
7517
7518 .cindex "name server for enclosing domain"
7519 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7520 records on the given domain, but if none are found, it removes the first
7521 component of the domain name, and tries again. This process continues until NS
7522 records are found or there are no more components left (or there is a DNS
7523 error). In other words, it may return the name servers for a top-level domain,
7524 but it never returns the root name servers. If there are no NS records for the
7525 top-level domain, the lookup fails. Consider these examples:
7526 .code
7527 ${lookup dnsdb{zns=xxx.quercite.com}}
7528 ${lookup dnsdb{zns=xxx.edu}}
7529 .endd
7530 Assuming that in each case there are no NS records for the full domain name,
7531 the first returns the name servers for &%quercite.com%&, and the second returns
7532 the name servers for &%edu%&.
7533
7534 You should be careful about how you use this lookup because, unless the
7535 top-level domain does not exist, the lookup always returns some host names. The
7536 sort of use to which this might be put is for seeing if the name servers for a
7537 given domain are on a blacklist. You can probably assume that the name servers
7538 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7539 such a list.
7540
7541 .cindex "CSA" "in &(dnsdb)& lookup"
7542 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7543 records according to the CSA rules, which are described in section
7544 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7545 not sufficient because of the extra parent domain search behaviour of CSA. The
7546 result of a successful lookup such as:
7547 .code
7548 ${lookup dnsdb {csa=$sender_helo_name}}
7549 .endd
7550 has two space-separated fields: an authorization code and a target host name.
7551 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7552 authorization required but absent, or &"?"& for unknown.
7553
7554 .cindex "A+" "in &(dnsdb)& lookup"
7555 The pseudo-type A+ performs an AAAA
7556 and then an A lookup.  All results are returned; defer processing
7557 (see below) is handled separately for each lookup.  Example:
7558 .code
7559 ${lookup dnsdb {>; a+=$sender_helo_name}}
7560 .endd
7561
7562
7563 .section "Multiple dnsdb lookups" "SECID67"
7564 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7565 However, you can specify a list of domains or IP addresses in a single
7566 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7567 the default separator, but with the ability to change this. For example:
7568 .code
7569 ${lookup dnsdb{one.domain.com:two.domain.com}}
7570 ${lookup dnsdb{a=one.host.com:two.host.com}}
7571 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7572 .endd
7573 In order to retain backwards compatibility, there is one special case: if
7574 the lookup type is PTR and no change of separator is specified, Exim looks
7575 to see if the rest of the string is precisely one IPv6 address. In this
7576 case, it does not treat it as a list.
7577
7578 The data from each lookup is concatenated, with newline separators by default,
7579 in the same way that multiple DNS records for a single item are handled. A
7580 different separator can be specified, as described above.
7581
7582
7583
7584
7585 .section "More about LDAP" "SECTldap"
7586 .cindex "LDAP" "lookup, more about"
7587 .cindex "lookup" "LDAP"
7588 .cindex "Solaris" "LDAP"
7589 The original LDAP implementation came from the University of Michigan; this has
7590 become &"Open LDAP"&, and there are now two different releases. Another
7591 implementation comes from Netscape, and Solaris 7 and subsequent releases
7592 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7593 the lookup function level, their error handling is different. For this reason
7594 it is necessary to set a compile-time variable when building Exim with LDAP, to
7595 indicate which LDAP library is in use. One of the following should appear in
7596 your &_Local/Makefile_&:
7597 .code
7598 LDAP_LIB_TYPE=UMICHIGAN
7599 LDAP_LIB_TYPE=OPENLDAP1
7600 LDAP_LIB_TYPE=OPENLDAP2
7601 LDAP_LIB_TYPE=NETSCAPE
7602 LDAP_LIB_TYPE=SOLARIS
7603 .endd
7604 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7605 same interface as the University of Michigan version.
7606
7607 There are three LDAP lookup types in Exim. These behave slightly differently in
7608 the way they handle the results of a query:
7609
7610 .ilist
7611 &(ldap)& requires the result to contain just one entry; if there are more, it
7612 gives an error.
7613 .next
7614 &(ldapdn)& also requires the result to contain just one entry, but it is the
7615 Distinguished Name that is returned rather than any attribute values.
7616 .next
7617 &(ldapm)& permits the result to contain more than one entry; the attributes
7618 from all of them are returned.
7619 .endlist
7620
7621
7622 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7623 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7624 the data returned by a successful lookup is described in the next section.
7625 First we explain how LDAP queries are coded.
7626
7627
7628 .section "Format of LDAP queries" "SECTforldaque"
7629 .cindex "LDAP" "query format"
7630 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7631 the configuration of a &(redirect)& router one might have this setting:
7632 .code
7633 data = ${lookup ldap \
7634   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7635   c=UK?mailbox?base?}}
7636 .endd
7637 .cindex "LDAP" "with TLS"
7638 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7639 secure (encrypted) LDAP connections. The second of these ensures that an
7640 encrypted TLS connection is used.
7641
7642 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7643 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7644 See the &%ldap_start_tls%& option.
7645
7646 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7647 controlled. Every part of the TLS configuration can be configured by settings in
7648 &_exim.conf_&. Depending on the version of the client libraries installed on
7649 your system, some of the initialization may have required setting options in
7650 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7651 certificates. This revealed a nuance where the current UID that exim was
7652 running as could affect which config files it read. With Exim 4.83, these
7653 methods become optional, only taking effect if not specifically set in
7654 &_exim.conf_&.
7655
7656
7657 .section "LDAP quoting" "SECID68"
7658 .cindex "LDAP" "quoting"
7659 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7660 and the second because the LDAP query is represented as a URL. Furthermore,
7661 within an LDAP query, two different kinds of quoting are required. For this
7662 reason, there are two different LDAP-specific quoting operators.
7663
7664 The &%quote_ldap%& operator is designed for use on strings that are part of
7665 filter specifications. Conceptually, it first does the following conversions on
7666 the string:
7667 .code
7668 *   =>   \2A
7669 (   =>   \28
7670 )   =>   \29
7671 \   =>   \5C
7672 .endd
7673 in accordance with RFC 2254. The resulting string is then quoted according
7674 to the rules for URLs, that is, all non-alphanumeric characters except
7675 .code
7676 ! $ ' - . _ ( ) * +
7677 .endd
7678 are converted to their hex values, preceded by a percent sign. For example:
7679 .code
7680 ${quote_ldap: a(bc)*, a<yz>; }
7681 .endd
7682 yields
7683 .code
7684 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7685 .endd
7686 Removing the URL quoting, this is (with a leading and a trailing space):
7687 .code
7688 a\28bc\29\2A, a<yz>;
7689 .endd
7690 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7691 base DN specifications in queries. Conceptually, it first converts the string
7692 by inserting a backslash in front of any of the following characters:
7693 .code
7694 , + " \ < > ;
7695 .endd
7696 It also inserts a backslash before any leading spaces or # characters, and
7697 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7698 is then quoted according to the rules for URLs. For example:
7699 .code
7700 ${quote_ldap_dn: a(bc)*, a<yz>; }
7701 .endd
7702 yields
7703 .code
7704 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7705 .endd
7706 Removing the URL quoting, this is (with a trailing space):
7707 .code
7708 \ a(bc)*\, a\<yz\>\;\
7709 .endd
7710 There are some further comments about quoting in the section on LDAP
7711 authentication below.
7712
7713
7714 .section "LDAP connections" "SECID69"
7715 .cindex "LDAP" "connections"
7716 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7717 is in use, via a Unix domain socket. The example given above does not specify
7718 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7719 by starting it with
7720 .code
7721 ldap://<hostname>:<port>/...
7722 .endd
7723 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7724 used. When no server is specified in a query, a list of default servers is
7725 taken from the &%ldap_default_servers%& configuration option. This supplies a
7726 colon-separated list of servers which are tried in turn until one successfully
7727 handles a query, or there is a serious error. Successful handling either
7728 returns the requested data, or indicates that it does not exist. Serious errors
7729 are syntactical, or multiple values when only a single value is expected.
7730 Errors which cause the next server to be tried are connection failures, bind
7731 failures, and timeouts.
7732
7733 For each server name in the list, a port number can be given. The standard way
7734 of specifying a host and port is to use a colon separator (RFC 1738). Because
7735 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7736 doubled. For example
7737 .code
7738 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7739 .endd
7740 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7741 to the LDAP library with no server name, and the library's default (normally
7742 the local host) is used.
7743
7744 If you are using the OpenLDAP library, you can connect to an LDAP server using
7745 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7746 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7747 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7748 not available.
7749
7750 For this type of connection, instead of a host name for the server, a pathname
7751 for the socket is required, and the port number is not relevant. The pathname
7752 can be specified either as an item in &%ldap_default_servers%&, or inline in
7753 the query. In the former case, you can have settings such as
7754 .code
7755 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7756 .endd
7757 When the pathname is given in the query, you have to escape the slashes as
7758 &`%2F`& to fit in with the LDAP URL syntax. For example:
7759 .code
7760 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7761 .endd
7762 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7763 a pathname, it uses the Unix domain socket code, even if the query actually
7764 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7765 socket connection. This behaviour means that you can use a setting of
7766 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7767 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7768 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7769 backup host.
7770
7771 If an explicit &`ldapi`& type is given in a query when a host name is
7772 specified, an error is diagnosed. However, if there are more items in
7773 &%ldap_default_servers%&, they are tried. In other words:
7774
7775 .ilist
7776 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7777 interface.
7778 .next
7779 Using &`ldapi`& with a host name causes an error.
7780 .endlist
7781
7782
7783 Using &`ldapi`& with no host or path in the query, and no setting of
7784 &%ldap_default_servers%&, does whatever the library does by default.
7785
7786
7787
7788 .section "LDAP authentication and control information" "SECID70"
7789 .cindex "LDAP" "authentication"
7790 The LDAP URL syntax provides no way of passing authentication and other control
7791 information to the server. To make this possible, the URL in an LDAP query may
7792 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7793 spaces. If a value contains spaces it must be enclosed in double quotes, and
7794 when double quotes are used, backslash is interpreted in the usual way inside
7795 them. The following names are recognized:
7796 .display
7797 &`DEREFERENCE`&  set the dereferencing parameter
7798 &`NETTIME    `&  set a timeout for a network operation
7799 &`USER       `&  set the DN, for authenticating the LDAP bind
7800 &`PASS       `&  set the password, likewise
7801 &`REFERRALS  `&  set the referrals parameter
7802 &`SERVERS    `&  set alternate server list for this query only
7803 &`SIZE       `&  set the limit for the number of entries returned
7804 &`TIME       `&  set the maximum waiting time for a query
7805 .endd
7806 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7807 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7808 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7809 library from trying to follow referrals issued by the LDAP server.
7810
7811 .cindex LDAP timeout
7812 .cindex timeout "LDAP lookup"
7813 The name CONNECT is an obsolete name for NETTIME, retained for
7814 backwards compatibility. This timeout (specified as a number of seconds) is
7815 enforced from the client end for operations that can be carried out over a
7816 network. Specifically, it applies to network connections and calls to the
7817 &'ldap_result()'& function. If the value is greater than zero, it is used if
7818 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7819 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7820 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7821 Netscape SDK; for OpenLDAP no action is taken.
7822
7823 The TIME parameter (also a number of seconds) is passed to the server to
7824 set a server-side limit on the time taken to complete a search.
7825
7826 The SERVERS parameter allows you to specify an alternate list of ldap servers
7827 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7828 default list of ldap servers, and a single lookup can specify a single ldap
7829 server to use.  But when you need to do a lookup with a list of servers that is
7830 different than the default list (maybe different order, maybe a completely
7831 different set of servers), the SERVERS parameter allows you to specify this
7832 alternate list (colon-separated).
7833
7834 Here is an example of an LDAP query in an Exim lookup that uses some of these
7835 values. This is a single line, folded to fit on the page:
7836 .code
7837 ${lookup ldap
7838   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7839   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7840   {$value}fail}
7841 .endd
7842 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7843 any of the auxiliary data. Exim configuration settings that include lookups
7844 which contain password information should be preceded by &"hide"& to prevent
7845 non-admin users from using the &%-bP%& option to see their values.
7846
7847 The auxiliary data items may be given in any order. The default is no
7848 connection timeout (the system timeout is used), no user or password, no limit
7849 on the number of entries returned, and no time limit on queries.
7850
7851 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7852 removes any URL quoting that it may contain before passing it LDAP. Apparently
7853 some libraries do this for themselves, but some do not. Removing the URL
7854 quoting has two advantages:
7855
7856 .ilist
7857 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7858 DNs as with DNs inside actual queries.
7859 .next
7860 It permits spaces inside USER= DNs.
7861 .endlist
7862
7863 For example, a setting such as
7864 .code
7865 USER=cn=${quote_ldap_dn:$1}
7866 .endd
7867 should work even if &$1$& contains spaces.
7868
7869 Expanded data for the PASS= value should be quoted using the &%quote%&
7870 expansion operator, rather than the LDAP quote operators. The only reason this
7871 field needs quoting is to ensure that it conforms to the Exim syntax, which
7872 does not allow unquoted spaces. For example:
7873 .code
7874 PASS=${quote:$3}
7875 .endd
7876 The LDAP authentication mechanism can be used to check passwords as part of
7877 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7878 &<<CHAPexpand>>&.
7879
7880
7881
7882 .section "Format of data returned by LDAP" "SECID71"
7883 .cindex "LDAP" "returned data formats"
7884 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7885 as a sequence of values, for example
7886 .code
7887 cn=manager,o=University of Cambridge,c=UK
7888 .endd
7889 The &(ldap)& lookup type generates an error if more than one entry matches the
7890 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7891 the result between the data from different entries. It is possible for multiple
7892 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7893 you know that whatever values are returned all came from a single entry in the
7894 directory.
7895
7896 In the common case where you specify a single attribute in your LDAP query, the
7897 result is not quoted, and does not contain the attribute name. If the attribute
7898 has multiple values, they are separated by commas. Any comma that is
7899 part of an attribute's value is doubled.
7900
7901 If you specify multiple attributes, the result contains space-separated, quoted
7902 strings, each preceded by the attribute name and an equals sign. Within the
7903 quotes, the quote character, backslash, and newline are escaped with
7904 backslashes, and commas are used to separate multiple values for the attribute.
7905 Any commas in attribute values are doubled
7906 (permitting treatment of the values as a comma-separated list).
7907 Apart from the escaping, the string within quotes takes the same form as the
7908 output when a single attribute is requested. Specifying no attributes is the
7909 same as specifying all of an entry's attributes.
7910
7911 Here are some examples of the output format. The first line of each pair is an
7912 LDAP query, and the second is the data that is returned. The attribute called
7913 &%attr1%& has two values, one of them with an embedded comma, whereas
7914 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7915 (they have SUP &%attr%& in their schema definitions).
7916
7917 .code
7918 ldap:///o=base?attr1?sub?(uid=fred)
7919 value1.1,value1,,2
7920
7921 ldap:///o=base?attr2?sub?(uid=fred)
7922 value two
7923
7924 ldap:///o=base?attr?sub?(uid=fred)
7925 value1.1,value1,,2,value two
7926
7927 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7928 attr1="value1.1,value1,,2" attr2="value two"
7929
7930 ldap:///o=base??sub?(uid=fred)
7931 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7932 .endd
7933 You can
7934 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7935 results of LDAP lookups.
7936 The &%extract%& operator in string expansions can be used to pick out
7937 individual fields from data that consists of &'key'&=&'value'& pairs.
7938 The &%listextract%& operator should be used to pick out individual values
7939 of attributes, even when only a single value is expected.
7940 The doubling of embedded commas allows you to use the returned data as a
7941 comma separated list (using the "<," syntax for changing the input list separator).
7942
7943
7944
7945
7946 .section "More about NIS+" "SECTnisplus"
7947 .cindex "NIS+ lookup type"
7948 .cindex "lookup" "NIS+"
7949 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7950 and field name. If this is given, the result of a successful query is the
7951 contents of the named field; otherwise the result consists of a concatenation
7952 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7953 values containing spaces are quoted. For example, the query
7954 .code
7955 [name=mg1456],passwd.org_dir
7956 .endd
7957 might return the string
7958 .code
7959 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7960 home=/home/mg1456 shell=/bin/bash shadow=""
7961 .endd
7962 (split over two lines here to fit on the page), whereas
7963 .code
7964 [name=mg1456],passwd.org_dir:gcos
7965 .endd
7966 would just return
7967 .code
7968 Martin Guerre
7969 .endd
7970 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7971 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7972 operator is to double any quote characters within the text.
7973
7974
7975
7976 .section "SQL lookups" "SECTsql"
7977 .cindex "SQL lookup types"
7978 .cindex "MySQL" "lookup type"
7979 .cindex "PostgreSQL lookup type"
7980 .cindex "lookup" "MySQL"
7981 .cindex "lookup" "PostgreSQL"
7982 .cindex "Oracle" "lookup type"
7983 .cindex "lookup" "Oracle"
7984 .cindex "InterBase lookup type"
7985 .cindex "lookup" "InterBase"
7986 .cindex "Redis lookup type"
7987 .cindex lookup Redis
7988 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7989 and SQLite
7990 databases. Queries for these databases contain SQL statements, so an example
7991 might be
7992 .code
7993 ${lookup mysql{select mailbox from users where id='userx'}\
7994   {$value}fail}
7995 .endd
7996 If the result of the query contains more than one field, the data for each
7997 field in the row is returned, preceded by its name, so the result of
7998 .code
7999 ${lookup pgsql{select home,name from users where id='userx'}\
8000   {$value}}
8001 .endd
8002 might be
8003 .code
8004 home=/home/userx name="Mister X"
8005 .endd
8006 Empty values and values containing spaces are double quoted, with embedded
8007 quotes escaped by a backslash. If the result of the query contains just one
8008 field, the value is passed back verbatim, without a field name, for example:
8009 .code
8010 Mister X
8011 .endd
8012 If the result of the query yields more than one row, it is all concatenated,
8013 with a newline between the data for each row.
8014
8015
8016 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
8017 .cindex "MySQL" "lookup type"
8018 .cindex "PostgreSQL lookup type"
8019 .cindex "lookup" "MySQL"
8020 .cindex "lookup" "PostgreSQL"
8021 .cindex "Oracle" "lookup type"
8022 .cindex "lookup" "Oracle"
8023 .cindex "InterBase lookup type"
8024 .cindex "lookup" "InterBase"
8025 .cindex "Redis lookup type"
8026 .cindex lookup Redis
8027 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8028 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8029 or &%redis_servers%&
8030 option (as appropriate) must be set to a colon-separated list of server
8031 information.
8032 .oindex &%mysql_servers%&
8033 .oindex &%pgsql_servers%&
8034 .oindex &%oracle_servers%&
8035 .oindex &%ibase_servers%&
8036 .oindex &%redis_servers%&
8037 (For MySQL and PostgreSQL, the global option need not be set if all
8038 queries contain their own server information &-- see section
8039 &<<SECTspeserque>>&.)
8040 For all but Redis
8041 each item in the list is a slash-separated list of four
8042 items: host name, database name, user name, and password. In the case of
8043 Oracle, the host name field is used for the &"service name"&, and the database
8044 name field is not used and should be empty. For example:
8045 .code
8046 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8047 .endd
8048 Because password data is sensitive, you should always precede the setting with
8049 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8050 option. Here is an example where two MySQL servers are listed:
8051 .code
8052 hide mysql_servers = localhost/users/root/secret:\
8053                      otherhost/users/root/othersecret
8054 .endd
8055 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8056 because this is a colon-separated list, the colon has to be doubled. For each
8057 query, these parameter groups are tried in order until a connection is made and
8058 a query is successfully processed. The result of a query may be that no data is
8059 found, but that is still a successful query. In other words, the list of
8060 servers provides a backup facility, not a list of different places to look.
8061
8062 For Redis the global option need not be specified if all queries contain their
8063 own server information &-- see section &<<SECTspeserque>>&.
8064 If specified, the option must be set to a colon-separated list of server
8065 information.
8066 Each item in the list is a slash-separated list of three items:
8067 host, database number, and password.
8068 .olist
8069 The host is required and may be either an IPv4 address and optional
8070 port number (separated by a colon, which needs doubling due to the
8071 higher-level list), or a Unix socket pathname enclosed in parentheses
8072 .next
8073 The database number is optional; if present that number is selected in the backend
8074 .next
8075 The password is optional; if present it is used to authenticate to the backend
8076 .endlist
8077
8078 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8079 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8080 respectively, and the characters single-quote, double-quote, and backslash
8081 itself are escaped with backslashes.
8082
8083 The &%quote_redis%& expansion operator
8084 escapes whitespace and backslash characters with a backslash.
8085
8086 .section "Specifying the server in the query" "SECTspeserque"
8087 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8088 it is possible to specify a list of servers with an individual query. This is
8089 done by appending a comma-separated option to the query type:
8090 .display
8091 &`,servers=`&&'server1:server2:server3:...'&
8092 .endd
8093 Each item in the list may take one of two forms:
8094 .olist
8095 If it contains no slashes it is assumed to be just a host name. The appropriate
8096 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8097 of the same name, and the remaining parameters (database, user, password) are
8098 taken from there.
8099 .next
8100 If it contains any slashes, it is taken as a complete parameter set.
8101 .endlist
8102 The list of servers is used in exactly the same way as the global list.
8103 Once a connection to a server has happened and a query has been
8104 successfully executed, processing of the lookup ceases.
8105
8106 This feature is intended for use in master/slave situations where updates
8107 are occurring and you want to update the master rather than a slave. If the
8108 master is in the list as a backup for reading, you might have a global setting
8109 like this:
8110 .code
8111 mysql_servers = slave1/db/name/pw:\
8112                 slave2/db/name/pw:\
8113                 master/db/name/pw
8114 .endd
8115 In an updating lookup, you could then write:
8116 .code
8117 ${lookup mysql,servers=master {UPDATE ...} }
8118 .endd
8119 That query would then be sent only to the master server. If, on the other hand,
8120 the master is not to be used for reading, and so is not present in the global
8121 option, you can still update it by a query of this form:
8122 .code
8123 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8124 .endd
8125
8126 An older syntax places the servers specification before the query,
8127 semicolon separated:
8128 .code
8129 ${lookup mysql{servers=master; UPDATE ...} }
8130 .endd
8131 The new version avoids potential issues with tainted
8132 arguments in the query, for explicit expansion.
8133 &*Note*&: server specifications in list-style lookups are still problematic.
8134
8135
8136 .section "Special MySQL features" "SECID73"
8137 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8138 causes a connection to the server on the local host by means of a Unix domain
8139 socket. An alternate socket can be specified in parentheses.
8140 An option group name for MySQL option files can be specified in square brackets;
8141 the default value is &"exim"&.
8142 The full syntax of each item in &%mysql_servers%& is:
8143 .display
8144 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8145   <&'database'&>/<&'user'&>/<&'password'&>
8146 .endd
8147 Any of the four sub-parts of the first field can be omitted. For normal use on
8148 the local host it can be left blank or set to just &"localhost"&.
8149
8150 No database need be supplied &-- but if it is absent here, it must be given in
8151 the queries.
8152
8153 If a MySQL query is issued that does not request any data (an insert, update,
8154 or delete command), the result of the lookup is the number of rows affected.
8155
8156 &*Warning*&: This can be misleading. If an update does not actually change
8157 anything (for example, setting a field to the value it already has), the result
8158 is zero because no rows are affected.
8159
8160
8161 .section "Special PostgreSQL features" "SECID74"
8162 PostgreSQL lookups can also use Unix domain socket connections to the database.
8163 This is usually faster and costs less CPU time than a TCP/IP connection.
8164 However it can be used only if the mail server runs on the same machine as the
8165 database server. A configuration line for PostgreSQL via Unix domain sockets
8166 looks like this:
8167 .code
8168 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8169 .endd
8170 In other words, instead of supplying a host name, a path to the socket is
8171 given. The path name is enclosed in parentheses so that its slashes aren't
8172 visually confused with the delimiters for the other server parameters.
8173
8174 If a PostgreSQL query is issued that does not request any data (an insert,
8175 update, or delete command), the result of the lookup is the number of rows
8176 affected.
8177
8178 .section "More about SQLite" "SECTsqlite"
8179 .cindex "lookup" "SQLite"
8180 .cindex "sqlite lookup type"
8181 SQLite is different to the other SQL lookups because a filename is required in
8182 addition to the SQL query. An SQLite database is a single file, and there is no
8183 daemon as in the other SQL databases.
8184
8185 .new
8186 .oindex &%sqlite_dbfile%&
8187 There are two ways of
8188 specifying the file.
8189 The first is is by using the &%sqlite_dbfile%& main option.
8190 The second, which allows separate files for each query,
8191 is to use an option appended, comma-separated, to the &"sqlite"&
8192 lookup type word.  The option is the word &"file"&, then an equals,
8193 then the filename.
8194 The filename in this case cannot contain whitespace or open-brace charachters.
8195 .wen
8196
8197 A deprecated method is available, prefixing the query with the filename
8198 separated by white space.
8199 This means that
8200 .cindex "tainted data" "sqlite file"
8201 the query cannot use any tainted values, as that taints
8202 the entire query including the filename - resulting in a refusal to open
8203 the file.
8204
8205 In all the above cases the filename must be an absolute path.
8206
8207 Here is a lookup expansion example:
8208 .code
8209 sqlite_dbfile = /some/thing/sqlitedb
8210 ...
8211 ${lookup sqlite {select name from aliases where id='userx';}}
8212 .endd
8213 In a list, the syntax is similar. For example:
8214 .code
8215 domainlist relay_to_domains = sqlite;\
8216    select * from relays where ip='$sender_host_address';
8217 .endd
8218 The only character affected by the &%quote_sqlite%& operator is a single
8219 quote, which it doubles.
8220
8221 .cindex timeout SQLite
8222 .cindex sqlite "lookup timeout"
8223 The SQLite library handles multiple simultaneous accesses to the database
8224 internally. Multiple readers are permitted, but only one process can
8225 update at once. Attempts to access the database while it is being updated
8226 are rejected after a timeout period, during which the SQLite library
8227 waits for the lock to be released. In Exim, the default timeout is set
8228 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8229 option.
8230
8231 .section "More about Redis" "SECTredis"
8232 .cindex "lookup" "Redis"
8233 .cindex "redis lookup type"
8234 Redis is a non-SQL database. Commands are simple get and set.
8235 Examples:
8236 .code
8237 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8238 ${lookup redis{get keyname}}
8239 .endd
8240
8241 As of release 4.91, "lightweight" support for Redis Cluster is available.
8242 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8243 of which must be reachable from the running exim instance. If the cluster has
8244 master/slave replication, the list must contain all the master and slave
8245 servers.
8246
8247 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8248 immediately follow the redirection but treats the response as a DEFER, moving on
8249 to the next server in the &%redis_servers%& list until the correct server is
8250 reached.
8251
8252 .ecindex IIDfidalo1
8253 .ecindex IIDfidalo2
8254
8255
8256 . ////////////////////////////////////////////////////////////////////////////
8257 . ////////////////////////////////////////////////////////////////////////////
8258
8259 .chapter "Domain, host, address, and local part lists" &&&
8260          "CHAPdomhosaddlists" &&&
8261          "Domain, host, and address lists"
8262 .scindex IIDdohoadli "lists of domains; hosts; etc."
8263 A number of Exim configuration options contain lists of domains, hosts,
8264 email addresses, or local parts. For example, the &%hold_domains%& option
8265 contains a list of domains whose delivery is currently suspended. These lists
8266 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8267 arguments to expansion conditions such as &%match_domain%&.
8268
8269 Each item in one of these lists is a pattern to be matched against a domain,
8270 host, email address, or local part, respectively. In the sections below, the
8271 different types of pattern for each case are described, but first we cover some
8272 general facilities that apply to all four kinds of list.
8273
8274 Note that other parts of Exim use a &'string list'& which does not
8275 support all the complexity available in
8276 domain, host, address and local part lists.
8277
8278
8279
8280 .section "Expansion of lists" "SECTlistexpand"
8281 .cindex "expansion" "of lists"
8282 Each list is expanded as a single string before it is used.
8283
8284 &'Exception: the router headers_remove option, where list-item
8285 splitting is done before string-expansion.'&
8286
8287 The result of
8288 expansion must be a list, possibly containing empty items, which is split up
8289 into separate items for matching. By default, colon is the separator character,
8290 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8291 &<<SECTempitelis>>& for details of the list syntax; the second of these
8292 discusses the way to specify empty list items.
8293
8294
8295 If the string expansion is forced to fail, Exim behaves as if the item it is
8296 testing (domain, host, address, or local part) is not in the list. Other
8297 expansion failures cause temporary errors.
8298
8299 If an item in a list is a regular expression, backslashes, dollars and possibly
8300 other special characters in the expression must be protected against
8301 misinterpretation by the string expander. The easiest way to do this is to use
8302 the &`\N`& expansion feature to indicate that the contents of the regular
8303 expression should not be expanded. For example, in an ACL you might have:
8304 .code
8305 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8306                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8307 .endd
8308 The first item is a regular expression that is protected from expansion by
8309 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8310 senders based on the receiving domain.
8311
8312
8313
8314
8315 .section "Negated items in lists" "SECID76"
8316 .cindex "list" "negation"
8317 .cindex "negation" "in lists"
8318 Items in a list may be positive or negative. Negative items are indicated by a
8319 leading exclamation mark, which may be followed by optional white space. A list
8320 defines a set of items (domains, etc). When Exim processes one of these lists,
8321 it is trying to find out whether a domain, host, address, or local part
8322 (respectively) is in the set that is defined by the list. It works like this:
8323
8324 The list is scanned from left to right. If a positive item is matched, the
8325 subject that is being checked is in the set; if a negative item is matched, the
8326 subject is not in the set. If the end of the list is reached without the
8327 subject having matched any of the patterns, it is in the set if the last item
8328 was a negative one, but not if it was a positive one. For example, the list in
8329 .code
8330 domainlist relay_to_domains = !a.b.c : *.b.c
8331 .endd
8332 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8333 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8334 list is positive. However, if the setting were
8335 .code
8336 domainlist relay_to_domains = !a.b.c
8337 .endd
8338 then all domains other than &'a.b.c'& would match because the last item in the
8339 list is negative. In other words, a list that ends with a negative item behaves
8340 as if it had an extra item &`:*`& on the end.
8341
8342 Another way of thinking about positive and negative items in lists is to read
8343 the connector as &"or"& after a positive item and as &"and"& after a negative
8344 item.
8345
8346
8347
8348 .section "File names in lists" "SECTfilnamlis"
8349 .cindex "list" "filename in"
8350 If an item in a domain, host, address, or local part list is an absolute
8351 filename (beginning with a slash character), each line of the file is read and
8352 processed as if it were an independent item in the list, except that further
8353 filenames are not allowed,
8354 and no expansion of the data from the file takes place.
8355 Empty lines in the file are ignored, and the file may also contain comment
8356 lines:
8357
8358 .ilist
8359 For domain and host lists, if a # character appears anywhere in a line of the
8360 file, it and all following characters are ignored.
8361 .next
8362 Because local parts may legitimately contain # characters, a comment in an
8363 address list or local part list file is recognized only if # is preceded by
8364 white space or the start of the line. For example:
8365 .code
8366 not#comment@x.y.z   # but this is a comment
8367 .endd
8368 .endlist
8369
8370 Putting a filename in a list has the same effect as inserting each line of the
8371 file as an item in the list (blank lines and comments excepted). However, there
8372 is one important difference: the file is read each time the list is processed,
8373 so if its contents vary over time, Exim's behaviour changes.
8374
8375 If a filename is preceded by an exclamation mark, the sense of any match
8376 within the file is inverted. For example, if
8377 .code
8378 hold_domains = !/etc/nohold-domains
8379 .endd
8380 and the file contains the lines
8381 .code
8382 !a.b.c
8383 *.b.c
8384 .endd
8385 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8386 any domain matching &`*.b.c`& is not.
8387
8388
8389
8390 .section "An lsearch file is not an out-of-line list" "SECID77"
8391 As will be described in the sections that follow, lookups can be used in lists
8392 to provide indexed methods of checking list membership. There has been some
8393 confusion about the way &(lsearch)& lookups work in lists. Because
8394 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8395 sometimes thought that it is allowed to contain wild cards and other kinds of
8396 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8397 always fixed strings, just as for any other single-key lookup type.
8398
8399 If you want to use a file to contain wild-card patterns that form part of a
8400 list, just give the filename on its own, without a search type, as described
8401 in the previous section. You could also use the &(wildlsearch)& or
8402 &(nwildlsearch)&, but there is no advantage in doing this.
8403
8404
8405
8406
8407 .section "Results of list checking" SECTlistresults
8408 The primary result of doing a list check is a truth value.
8409 In some contexts additional information is stored
8410 about the list element that matched:
8411 .vlist
8412 .vitem hosts
8413 A &%hosts%& ACL condition
8414 will store a result in the &$host_data$& variable.
8415 .vitem local_parts
8416 A &%local_parts%& router option or &%local_parts%& ACL condition
8417 will store a result in the &$local_part_data$& variable.
8418 .vitem domains
8419 A &%domains%& router option or &%domains%& ACL condition
8420 .vitem senders
8421 A &%senders%& router option or &%senders%& ACL condition
8422 will store a result in the &$sender_data$& variable.
8423 .vitem recipients
8424 A &%recipients%& ACL condition
8425 will store a result in the &$recipient_data$& variable.
8426 .endlist
8427
8428 The detail of the additional information depends on the
8429 type of match and is given below as the &*value*& information.
8430
8431
8432
8433
8434 .section "Named lists" "SECTnamedlists"
8435 .cindex "named lists"
8436 .cindex "list" "named"
8437 A list of domains, hosts, email addresses, or local parts can be given a name
8438 which is then used to refer to the list elsewhere in the configuration. This is
8439 particularly convenient if the same list is required in several different
8440 places. It also allows lists to be given meaningful names, which can improve
8441 the readability of the configuration. For example, it is conventional to define
8442 a domain list called &'local_domains'& for all the domains that are handled
8443 locally on a host, using a configuration line such as
8444 .code
8445 domainlist local_domains = localhost:my.dom.example
8446 .endd
8447 Named lists are referenced by giving their name preceded by a plus sign, so,
8448 for example, a router that is intended to handle local domains would be
8449 configured with the line
8450 .code
8451 domains = +local_domains
8452 .endd
8453 The first router in a configuration is often one that handles all domains
8454 except the local ones, using a configuration with a negated item like this:
8455 .code
8456 dnslookup:
8457   driver = dnslookup
8458   domains = ! +local_domains
8459   transport = remote_smtp
8460   no_more
8461 .endd
8462 The four kinds of named list are created by configuration lines starting with
8463 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8464 respectively. Then there follows the name that you are defining, followed by an
8465 equals sign and the list itself. For example:
8466 .code
8467 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8468 addresslist bad_senders = cdb;/etc/badsenders
8469 .endd
8470 A named list may refer to other named lists:
8471 .code
8472 domainlist  dom1 = first.example : second.example
8473 domainlist  dom2 = +dom1 : third.example
8474 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8475 .endd
8476 &*Warning*&: If the last item in a referenced list is a negative one, the
8477 effect may not be what you intended, because the negation does not propagate
8478 out to the higher level. For example, consider:
8479 .code
8480 domainlist  dom1 = !a.b
8481 domainlist  dom2 = +dom1 : *.b
8482 .endd
8483 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8484 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8485 means it matches the second list as well. The effect is not the same as
8486 .code
8487 domainlist  dom2 = !a.b : *.b
8488 .endd
8489 where &'x.y'& does not match. It's best to avoid negation altogether in
8490 referenced lists if you can.
8491
8492 .cindex "hiding named list values"
8493 .cindex "named lists" "hiding value of"
8494 Some named list definitions may contain sensitive data, for example, passwords for
8495 accessing databases. To stop non-admin users from using the &%-bP%& command
8496 line option to read these values, you can precede the definition with the
8497 word &"hide"&. For example:
8498 .code
8499 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8500 .endd
8501
8502
8503 Named lists may have a performance advantage. When Exim is routing an
8504 address or checking an incoming message, it caches the result of tests on named
8505 lists. So, if you have a setting such as
8506 .code
8507 domains = +local_domains
8508 .endd
8509 on several of your routers
8510 or in several ACL statements,
8511 the actual test is done only for the first one. However, the caching works only
8512 if there are no expansions within the list itself or any sublists that it
8513 references. In other words, caching happens only for lists that are known to be
8514 the same each time they are referenced.
8515
8516 By default, there may be up to 16 named lists of each type. This limit can be
8517 extended by changing a compile-time variable. The use of domain and host lists
8518 is recommended for concepts such as local domains, relay domains, and relay
8519 hosts. The default configuration is set up like this.
8520
8521
8522
8523 .section "Named lists compared with macros" "SECID78"
8524 .cindex "list" "named compared with macro"
8525 .cindex "macro" "compared with named list"
8526 At first sight, named lists might seem to be no different from macros in the
8527 configuration file. However, macros are just textual substitutions. If you
8528 write
8529 .code
8530 ALIST = host1 : host2
8531 auth_advertise_hosts = !ALIST
8532 .endd
8533 it probably won't do what you want, because that is exactly the same as
8534 .code
8535 auth_advertise_hosts = !host1 : host2
8536 .endd
8537 Notice that the second host name is not negated. However, if you use a host
8538 list, and write
8539 .code
8540 hostlist alist = host1 : host2
8541 auth_advertise_hosts = ! +alist
8542 .endd
8543 the negation applies to the whole list, and so that is equivalent to
8544 .code
8545 auth_advertise_hosts = !host1 : !host2
8546 .endd
8547
8548
8549 .section "Named list caching" "SECID79"
8550 .cindex "list" "caching of named"
8551 .cindex "caching" "named lists"
8552 While processing a message, Exim caches the result of checking a named list if
8553 it is sure that the list is the same each time. In practice, this means that
8554 the cache operates only if the list contains no $ characters, which guarantees
8555 that it will not change when it is expanded. Sometimes, however, you may have
8556 an expanded list that you know will be the same each time within a given
8557 message. For example:
8558 .code
8559 domainlist special_domains = \
8560            ${lookup{$sender_host_address}cdb{/some/file}}
8561 .endd
8562 This provides a list of domains that depends only on the sending host's IP
8563 address. If this domain list is referenced a number of times (for example,
8564 in several ACL lines, or in several routers) the result of the check is not
8565 cached by default, because Exim does not know that it is going to be the
8566 same list each time.
8567
8568 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8569 cache the result anyway. For example:
8570 .code
8571 domainlist_cache special_domains = ${lookup{...
8572 .endd
8573 If you do this, you should be absolutely sure that caching is going to do
8574 the right thing in all cases. When in doubt, leave it out.
8575
8576
8577
8578 .section "Domain lists" "SECTdomainlist"
8579 .cindex "domain list" "patterns for"
8580 .cindex "list" "domain list"
8581 Domain lists contain patterns that are to be matched against a mail domain.
8582 The following types of item may appear in domain lists:
8583
8584 .ilist
8585 .cindex "primary host name"
8586 .cindex "host name" "matched in domain list"
8587 .oindex "&%primary_hostname%&"
8588 .cindex "domain list" "matching primary host name"
8589 .cindex "@ in a domain list"
8590 If a pattern consists of a single @ character, it matches the local host name,
8591 as set by the &%primary_hostname%& option (or defaulted). This makes it
8592 possible to use the same configuration file on several different hosts that
8593 differ only in their names.
8594
8595 The value for a match will be the primary host name.
8596
8597
8598 .next
8599 .cindex "@[] in a domain list"
8600 .cindex "domain list" "matching local IP interfaces"
8601 .cindex "domain literal"
8602 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8603 in square brackets (as in an email address that contains a domain literal), but
8604 only if that IP address is recognized as local for email routing purposes. The
8605 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8606 control which of a host's several IP addresses are treated as local.
8607 In today's Internet, the use of domain literals is controversial;
8608 see the &%allow_domain_literals%& main option.
8609
8610 The value for a match will be the string &`@[]`&.
8611
8612
8613 .next
8614 .cindex "@mx_any"
8615 .cindex "@mx_primary"
8616 .cindex "@mx_secondary"
8617 .cindex "domain list" "matching MX pointers to local host"
8618 If a pattern consists of the string &`@mx_any`& it matches any domain that
8619 has an MX record pointing to the local host or to any host that is listed in
8620 .oindex "&%hosts_treat_as_local%&"
8621 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8622 are similar, except that the first matches only when a primary MX target is the
8623 local host, and the second only when no primary MX target is the local host,
8624 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8625 preference value &-- there may of course be more than one of them.
8626
8627 The MX lookup that takes place when matching a pattern of this type is
8628 performed with the resolver options for widening names turned off. Thus, for
8629 example, a single-component domain will &'not'& be expanded by adding the
8630 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8631 options of the &(dnslookup)& router for a discussion of domain widening.
8632
8633 Sometimes you may want to ignore certain IP addresses when using one of these
8634 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8635 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8636 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8637 on a router). For example:
8638 .code
8639 domains = @mx_any/ignore=127.0.0.1
8640 .endd
8641 This example matches any domain that has an MX record pointing to one of
8642 the local host's IP addresses other than 127.0.0.1.
8643
8644 The list of IP addresses is in fact processed by the same code that processes
8645 host lists, so it may contain CIDR-coded network specifications and it may also
8646 contain negative items.
8647
8648 Because the list of IP addresses is a sublist within a domain list, you have to
8649 be careful about delimiters if there is more than one address. Like any other
8650 list, the default delimiter can be changed. Thus, you might have:
8651 .code
8652 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8653           an.other.domain : ...
8654 .endd
8655 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8656 involved, it is easiest to change the delimiter for the main list as well:
8657 .code
8658 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8659           an.other.domain ? ...
8660 .endd
8661 The value for a match will be the list element string (starting &`@mx_`&).
8662
8663
8664 .next
8665 .cindex "asterisk" "in domain list"
8666 .cindex "domain list" "asterisk in"
8667 .cindex "domain list" "matching &""ends with""&"
8668 If a pattern starts with an asterisk, the remaining characters of the pattern
8669 are compared with the terminating characters of the domain. The use of &"*"& in
8670 domain lists differs from its use in partial matching lookups. In a domain
8671 list, the character following the asterisk need not be a dot, whereas partial
8672 matching works only in terms of dot-separated components. For example, a domain
8673 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8674 &'cipher.key.ex'&.
8675
8676 The value for a match will be the list element string (starting with the asterisk).
8677 Additionally, &$0$& will be set to the matched string
8678 and &$1$& to the variable portion which the asterisk matched.
8679
8680 .next
8681 .cindex "regular expressions" "in domain list"
8682 .cindex "domain list" "matching regular expression"
8683 If a pattern starts with a circumflex character, it is treated as a regular
8684 expression, and matched against the domain using a regular expression matching
8685 function. The circumflex is treated as part of the regular expression.
8686 Email domains are case-independent, so this regular expression match is by
8687 default case-independent, but you can make it case-dependent by starting it
8688 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8689 are given in chapter &<<CHAPregexp>>&.
8690
8691 &*Warning*&: Because domain lists are expanded before being processed, you
8692 must escape any backslash and dollar characters in the regular expression, or
8693 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8694 it is not to be expanded (unless you really do want to build a regular
8695 expression by expansion, of course).
8696
8697 The value for a match will be the list element string (starting with the circumflex).
8698 Additionally, &$0$& will be set to the string matching the regular expression,
8699 and &$1$& (onwards) to any submatches identified by parentheses.
8700
8701
8702
8703 .next
8704 .cindex "lookup" "in domain list"
8705 .cindex "domain list" "matching by lookup"
8706 If a pattern starts with the name of a single-key lookup type followed by a
8707 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8708 must be a filename in a suitable format for the lookup type. For example, for
8709 &"cdb;"& it must be an absolute path:
8710 .code
8711 domains = cdb;/etc/mail/local_domains.cdb
8712 .endd
8713 The appropriate type of lookup is done on the file using the domain name as the
8714 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8715 only in whether or not the key is present in the file. However, when a lookup
8716 is used for the &%domains%& option on a router
8717 or a &%domains%& condition in an ACL statement, the value is preserved in the
8718 &$domain_data$& variable and can be referred to in other router options or
8719 other statements in the same ACL.
8720 .cindex "tainted data" "de-tainting"
8721 The value will be untainted.
8722
8723
8724 .next
8725 Any of the single-key lookup type names may be preceded by
8726 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8727 .code
8728 domains = partial-dbm;/partial/domains
8729 .endd
8730 This causes partial matching logic to be invoked; a description of how this
8731 works is given in section &<<SECTpartiallookup>>&.
8732
8733 .next
8734 .cindex "asterisk" "in lookup type"
8735 Any of the single-key lookup types may be followed by an asterisk. This causes
8736 a default lookup for a key consisting of a single asterisk to be done if the
8737 original lookup fails. This is not a useful feature when using a domain list to
8738 select particular domains (because any domain would match), but it might have
8739 value if the result of the lookup is being used via the &$domain_data$&
8740 expansion variable.
8741
8742 .next
8743 If the pattern starts with the name of a query-style lookup type followed by a
8744 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8745 pattern must be an appropriate query for the lookup type, as described in
8746 chapter &<<CHAPfdlookup>>&. For example:
8747 .code
8748 hold_domains = mysql;select domain from holdlist \
8749   where domain = '${quote_mysql:$domain}';
8750 .endd
8751 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8752 example, it doesn't matter what field you select). Exim is interested only in
8753 whether or not the query succeeds. However, when a lookup is used for the
8754 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8755 variable and can be referred to in other options.
8756 .cindex "tainted data" "de-tainting"
8757 The value will be untainted.
8758
8759 .next
8760 If the pattern starts with the name of a lookup type
8761 of either kind (single-key or query-style) it may be
8762 followed by a comma and options,
8763 The options are lookup-type specific and consist of a comma-separated list.
8764 Each item starts with a tag and and equals "=".
8765
8766 .next
8767 .cindex "domain list" "matching literal domain name"
8768 If none of the above cases apply, a caseless textual comparison is made
8769 between the pattern and the domain.
8770
8771 The value for a match will be the list element string.
8772 .cindex "tainted data" "de-tainting"
8773 Note that this is commonly untainted
8774 (depending on the way the list was created).
8775 Specifically, explicit text in the configuration file in not tainted.
8776 This is a useful way of obtaining an untainted equivalent to
8777 the domain, for later operations.
8778
8779 However if the list (including one-element lists)
8780 is created by expanding a variable containing tainted data,
8781 it is tainted and so will the match value be.
8782 .endlist
8783
8784
8785 Here is an example that uses several different kinds of pattern:
8786 .code
8787 domainlist funny_domains = \
8788   @ : \
8789   lib.unseen.edu : \
8790   *.foundation.fict.example : \
8791   \N^[1-2]\d{3}\.fict\.example$\N : \
8792   partial-dbm;/opt/data/penguin/book : \
8793   nis;domains.byname : \
8794   nisplus;[name=$domain,status=local],domains.org_dir
8795 .endd
8796 There are obvious processing trade-offs among the various matching modes. Using
8797 an asterisk is faster than a regular expression, and listing a few names
8798 explicitly probably is too. The use of a file or database lookup is expensive,
8799 but may be the only option if hundreds of names are required. Because the
8800 patterns are tested in order, it makes sense to put the most commonly matched
8801 patterns earlier.
8802
8803
8804
8805 .section "Host lists" "SECThostlist"
8806 .cindex "host list" "patterns in"
8807 .cindex "list" "host list"
8808 Host lists are used to control what remote hosts are allowed to do. For
8809 example, some hosts may be allowed to use the local host as a relay, and some
8810 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8811 two different ways, by name or by IP address. In a host list, some types of
8812 pattern are matched to a host name, and some are matched to an IP address.
8813 You need to be particularly careful with this when single-key lookups are
8814 involved, to ensure that the right value is being used as the key.
8815
8816
8817 .section "Special host list patterns" "SECID80"
8818 .cindex "empty item in hosts list"
8819 .cindex "host list" "empty string in"
8820 If a host list item is the empty string, it matches only when no remote host is
8821 involved. This is the case when a message is being received from a local
8822 process using SMTP on the standard input, that is, when a TCP/IP connection is
8823 not used.
8824
8825 .cindex "asterisk" "in host list"
8826 The special pattern &"*"& in a host list matches any host or no host. Neither
8827 the IP address nor the name is actually inspected.
8828
8829
8830
8831 .section "Host list patterns that match by IP address" "SECThoslispatip"
8832 .cindex "host list" "matching IP addresses"
8833 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8834 the incoming address actually appears in the IPv6 host as
8835 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8836 list, it is converted into a traditional IPv4 address first. (Not all operating
8837 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8838 concerns.)
8839
8840 The following types of pattern in a host list check the remote host by
8841 inspecting its IP address:
8842
8843 .ilist
8844 If the pattern is a plain domain name (not a regular expression, not starting
8845 with *, not a lookup of any kind), Exim calls the operating system function
8846 to find the associated IP address(es). Exim uses the newer
8847 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8848 This typically causes a forward DNS lookup of the name. The result is compared
8849 with the IP address of the subject host.
8850
8851 If there is a temporary problem (such as a DNS timeout) with the host name
8852 lookup, a temporary error occurs. For example, if the list is being used in an
8853 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8854 temporary SMTP error code. If no IP address can be found for the host name,
8855 what happens is described in section &<<SECTbehipnot>>& below.
8856
8857 .next
8858 .cindex "@ in a host list"
8859 If the pattern is &"@"&, the primary host name is substituted and used as a
8860 domain name, as just described.
8861
8862 .next
8863 If the pattern is an IP address, it is matched against the IP address of the
8864 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8865 IPv6 addresses can be given in colon-separated format, but the colons have to
8866 be doubled so as not to be taken as item separators when the default list
8867 separator is used. IPv6 addresses are recognized even when Exim is compiled
8868 without IPv6 support. This means that if they appear in a host list on an
8869 IPv4-only host, Exim will not treat them as host names. They are just addresses
8870 that can never match a client host.
8871
8872 .next
8873 .cindex "@[] in a host list"
8874 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8875 the local host. For example, if the local host is an IPv4 host with one
8876 interface address 10.45.23.56, these two ACL statements have the same effect:
8877 .code
8878 accept hosts = 127.0.0.1 : 10.45.23.56
8879 accept hosts = @[]
8880 .endd
8881 .next
8882 .cindex "CIDR notation"
8883 If the pattern is an IP address followed by a slash and a mask length (for
8884 example 10.11.42.0/24), it is matched against the IP address of the subject
8885 host under the given mask. This allows, an entire network of hosts to be
8886 included (or excluded) by a single item. The mask uses CIDR notation; it
8887 specifies the number of address bits that must match, starting from the most
8888 significant end of the address.
8889
8890 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8891 of a range of addresses. It is the number of bits in the network portion of the
8892 address. The above example specifies a 24-bit netmask, so it matches all 256
8893 addresses in the 10.11.42.0 network. An item such as
8894 .code
8895 192.168.23.236/31
8896 .endd
8897 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8898 32 for an IPv4 address is the same as no mask at all; just a single address
8899 matches.
8900
8901 Here is another example which shows an IPv4 and an IPv6 network:
8902 .code
8903 recipient_unqualified_hosts = 192.168.0.0/16: \
8904                               3ffe::ffff::836f::::/48
8905 .endd
8906 The doubling of list separator characters applies only when these items
8907 appear inline in a host list. It is not required when indirecting via a file.
8908 For example:
8909 .code
8910 recipient_unqualified_hosts = /opt/exim/unqualnets
8911 .endd
8912 could make use of a file containing
8913 .code
8914 172.16.0.0/12
8915 3ffe:ffff:836f::/48
8916 .endd
8917 to have exactly the same effect as the previous example. When listing IPv6
8918 addresses inline, it is usually more convenient to use the facility for
8919 changing separator characters. This list contains the same two networks:
8920 .code
8921 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8922                                  3ffe:ffff:836f::/48
8923 .endd
8924 The separator is changed to semicolon by the leading &"<;"& at the start of the
8925 list.
8926 .endlist
8927
8928
8929
8930 .section "Host list patterns for single-key lookups by host address" &&&
8931          "SECThoslispatsikey"
8932 .cindex "host list" "lookup of IP address"
8933 When a host is to be identified by a single-key lookup of its complete IP
8934 address, the pattern takes this form:
8935 .display
8936 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8937 .endd
8938 For example:
8939 .code
8940 hosts_lookup = net-cdb;/hosts-by-ip.db
8941 .endd
8942 The text form of the IP address of the subject host is used as the lookup key.
8943 IPv6 addresses are converted to an unabbreviated form, using lower case
8944 letters, with dots as separators because colon is the key terminator in
8945 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8946 quoting the keys, but this is a facility that was added later.] The data
8947 returned by the lookup is not used.
8948
8949 .cindex "IP address" "masking"
8950 .cindex "host list" "masked IP address"
8951 Single-key lookups can also be performed using masked IP addresses, using
8952 patterns of this form:
8953 .display
8954 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8955 .endd
8956 For example:
8957 .code
8958 net24-dbm;/networks.db
8959 .endd
8960 The IP address of the subject host is masked using <&'number'&> as the mask
8961 length. A textual string is constructed from the masked value, followed by the
8962 mask, and this is used as the lookup key. For example, if the host's IP address
8963 is 192.168.34.6, the key that is looked up for the above example is
8964 &"192.168.34.0/24"&.
8965
8966 When an IPv6 address is converted to a string, dots are normally used instead
8967 of colons, so that keys in &(lsearch)& files need not contain colons (which
8968 terminate &(lsearch)& keys). This was implemented some time before the ability
8969 to quote keys was made available in &(lsearch)& files. However, the more
8970 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8971 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8972 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8973 converted using colons and not dots.
8974 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8975 addresses are always used.
8976 The latter are converted to IPv4 addresses, in dotted-quad form.
8977
8978 Ideally, it would be nice to tidy up this anomalous situation by changing to
8979 colons in all cases, given that quoting is now available for &(lsearch)&.
8980 However, this would be an incompatible change that might break some existing
8981 configurations.
8982
8983 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8984 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8985 the former case the key strings include the mask value, whereas in the latter
8986 case the IP address is used on its own.
8987
8988
8989
8990 .section "Host list patterns that match by host name" "SECThoslispatnam"
8991 .cindex "host" "lookup failures"
8992 .cindex "unknown host name"
8993 .cindex "host list" "matching host name"
8994 There are several types of pattern that require Exim to know the name of the
8995 remote host. These are either wildcard patterns or lookups by name. (If a
8996 complete hostname is given without any wildcarding, it is used to find an IP
8997 address to match against, as described in section &<<SECThoslispatip>>&
8998 above.)
8999
9000 If the remote host name is not already known when Exim encounters one of these
9001 patterns, it has to be found from the IP address.
9002 Although many sites on the Internet are conscientious about maintaining reverse
9003 DNS data for their hosts, there are also many that do not do this.
9004 Consequently, a name cannot always be found, and this may lead to unwanted
9005 effects. Take care when configuring host lists with wildcarded name patterns.
9006 Consider what will happen if a name cannot be found.
9007
9008 Because of the problems of determining host names from IP addresses, matching
9009 against host names is not as common as matching against IP addresses.
9010
9011 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9012 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9013 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9014 are done can be changed by setting the &%host_lookup_order%& option. For
9015 security, once Exim has found one or more names, it looks up the IP addresses
9016 for these names and compares them with the IP address that it started with.
9017 Only those names whose IP addresses match are accepted. Any other names are
9018 discarded. If no names are left, Exim behaves as if the host name cannot be
9019 found. In the most common case there is only one name and one IP address.
9020
9021 There are some options that control what happens if a host name cannot be
9022 found. These are described in section &<<SECTbehipnot>>& below.
9023
9024 .cindex "host" "alias for"
9025 .cindex "alias for host"
9026 As a result of aliasing, hosts may have more than one name. When processing any
9027 of the following types of pattern, all the host's names are checked:
9028
9029 .ilist
9030 .cindex "asterisk" "in host list"
9031 If a pattern starts with &"*"& the remainder of the item must match the end of
9032 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9033 &'.b.c'&. This special simple form is provided because this is a very common
9034 requirement. Other kinds of wildcarding require the use of a regular
9035 expression.
9036 .next
9037 .cindex "regular expressions" "in host list"
9038 .cindex "host list" "regular expression in"
9039 If the item starts with &"^"& it is taken to be a regular expression which is
9040 matched against the host name. Host names are case-independent, so this regular
9041 expression match is by default case-independent, but you can make it
9042 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9043 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9044 example,
9045 .code
9046 ^(a|b)\.c\.d$
9047 .endd
9048 is a regular expression that matches either of the two hosts &'a.c.d'& or
9049 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9050 that backslash and dollar characters are not misinterpreted as part of the
9051 string expansion. The simplest way to do this is to use &`\N`& to mark that
9052 part of the string as non-expandable. For example:
9053 .code
9054 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9055 .endd
9056 &*Warning*&: If you want to match a complete host name, you must include the
9057 &`$`& terminating metacharacter in the regular expression, as in the above
9058 example. Without it, a match at the start of the host name is all that is
9059 required.
9060 .endlist
9061
9062
9063
9064
9065 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9066 .cindex "host" "lookup failures, permanent"
9067 While processing a host list, Exim may need to look up an IP address from a
9068 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9069 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9070 behaviour when it fails to find the information it is seeking is the same.
9071
9072 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9073 apply to temporary DNS errors, whose handling is described in the next section.
9074
9075 .cindex "&`+include_unknown`&"
9076 .cindex "&`+ignore_unknown`&"
9077 Exim parses a host list from left to right. If it encounters a permanent
9078 lookup failure in any item in the host list before it has found a match,
9079 Exim treats it as a failure and the default behavior is as if the host
9080 does not match the list. This may not always be what you want to happen.
9081 To change Exim's behaviour, the special items &`+include_unknown`& or
9082 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9083 not recognized in an indirected file).
9084
9085 .ilist
9086 If any item that follows &`+include_unknown`& requires information that
9087 cannot found, Exim behaves as if the host does match the list. For example,
9088 .code
9089 host_reject_connection = +include_unknown:*.enemy.ex
9090 .endd
9091 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9092 any hosts whose name it cannot find.
9093
9094 .next
9095 If any item that follows &`+ignore_unknown`& requires information that cannot
9096 be found, Exim ignores that item and proceeds to the rest of the list. For
9097 example:
9098 .code
9099 accept hosts = +ignore_unknown : friend.example : \
9100                192.168.4.5
9101 .endd
9102 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9103 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9104 name can be found for 192.168.4.5, it is rejected.
9105 .endlist
9106
9107 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9108 list. The effect of each one lasts until the next, or until the end of the
9109 list.
9110
9111 .section "Mixing wildcarded host names and addresses in host lists" &&&
9112          "SECTmixwilhos"
9113 .cindex "host list" "mixing names and addresses in"
9114
9115 This section explains the host/ip processing logic with the same concepts
9116 as the previous section, but specifically addresses what happens when a
9117 wildcarded hostname is one of the items in the hostlist.
9118
9119 .ilist
9120 If you have name lookups or wildcarded host names and
9121 IP addresses in the same host list, you should normally put the IP
9122 addresses first. For example, in an ACL you could have:
9123 .code
9124 accept hosts = 10.9.8.7 : *.friend.example
9125 .endd
9126 The reason you normally would order it this way lies in the
9127 left-to-right way that Exim processes lists.  It can test IP addresses
9128 without doing any DNS lookups, but when it reaches an item that requires
9129 a host name, it fails if it cannot find a host name to compare with the
9130 pattern. If the above list is given in the opposite order, the
9131 &%accept%& statement fails for a host whose name cannot be found, even
9132 if its IP address is 10.9.8.7.
9133
9134 .next
9135 If you really do want to do the name check first, and still recognize the IP
9136 address, you can rewrite the ACL like this:
9137 .code
9138 accept hosts = *.friend.example
9139 accept hosts = 10.9.8.7
9140 .endd
9141 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9142 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9143 &`+ignore_unknown`&, which was discussed in depth in the first example in
9144 this section.
9145 .endlist
9146
9147
9148 .section "Temporary DNS errors when looking up host information" &&&
9149          "SECTtemdnserr"
9150 .cindex "host" "lookup failures, temporary"
9151 .cindex "&`+include_defer`&"
9152 .cindex "&`+ignore_defer`&"
9153 A temporary DNS lookup failure normally causes a defer action (except when
9154 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9155 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9156 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9157 section. These options should be used with care, probably only in non-critical
9158 host lists such as whitelists.
9159
9160
9161
9162 .section "Host list patterns for single-key lookups by host name" &&&
9163          "SECThoslispatnamsk"
9164 .cindex "unknown host name"
9165 .cindex "host list" "matching host name"
9166 If a pattern is of the form
9167 .display
9168 <&'single-key-search-type'&>;<&'search-data'&>
9169 .endd
9170 for example
9171 .code
9172 dbm;/host/accept/list
9173 .endd
9174 a single-key lookup is performed, using the host name as its key. If the
9175 lookup succeeds, the host matches the item. The actual data that is looked up
9176 is not used.
9177
9178 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9179 keys in the file, not IP addresses. If you want to do lookups based on IP
9180 addresses, you must precede the search type with &"net-"& (see section
9181 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9182 two items in the same list, one doing an address lookup and one doing a name
9183 lookup, both using the same file.
9184
9185
9186
9187 .section "Host list patterns for query-style lookups" "SECID81"
9188 If a pattern is of the form
9189 .display
9190 <&'query-style-search-type'&>;<&'query'&>
9191 .endd
9192 the query is obeyed, and if it succeeds, the host matches the item. The actual
9193 data that is looked up is not used. The variables &$sender_host_address$& and
9194 &$sender_host_name$& can be used in the query. For example:
9195 .code
9196 hosts_lookup = pgsql;\
9197   select ip from hostlist where ip='$sender_host_address'
9198 .endd
9199 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9200 can use the &%sg%& expansion item to change this if you need to. If you want to
9201 use masked IP addresses in database queries, you can use the &%mask%& expansion
9202 operator.
9203
9204 If the query contains a reference to &$sender_host_name$&, Exim automatically
9205 looks up the host name if it has not already done so. (See section
9206 &<<SECThoslispatnam>>& for comments on finding host names.)
9207
9208 Historical note: prior to release 4.30, Exim would always attempt to find a
9209 host name before running the query, unless the search type was preceded by
9210 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9211 still recognized for query-style lookups, but its presence or absence has no
9212 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9213 See section &<<SECThoslispatsikey>>&.)
9214
9215
9216
9217
9218
9219 .section "Address lists" "SECTaddresslist"
9220 .cindex "list" "address list"
9221 .cindex "address list" "empty item"
9222 .cindex "address list" "patterns"
9223 Address lists contain patterns that are matched against mail addresses. There
9224 is one special case to be considered: the sender address of a bounce message is
9225 always empty. You can test for this by providing an empty item in an address
9226 list. For example, you can set up a router to process bounce messages by
9227 using this option setting:
9228 .code
9229 senders = :
9230 .endd
9231 The presence of the colon creates an empty item. If you do not provide any
9232 data, the list is empty and matches nothing. The empty sender can also be
9233 detected by a regular expression that matches an empty string,
9234 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9235
9236 Non-empty items in an address list can be straightforward email addresses. For
9237 example:
9238 .code
9239 senders = jbc@askone.example : hs@anacreon.example
9240 .endd
9241 A certain amount of wildcarding is permitted. If a pattern contains an @
9242 character, but is not a regular expression and does not begin with a
9243 semicolon-terminated lookup type (described below), the local part of the
9244 subject address is compared with the local part of the pattern, which may start
9245 with an asterisk. If the local parts match, the domain is checked in exactly
9246 the same way as for a pattern in a domain list. For example, the domain can be
9247 wildcarded, refer to a named list, or be a lookup:
9248 .code
9249 deny senders = *@*.spamming.site:\
9250                *@+hostile_domains:\
9251                bozo@partial-lsearch;/list/of/dodgy/sites:\
9252                *@dbm;/bad/domains.db
9253 .endd
9254 .cindex "local part" "starting with !"
9255 .cindex "address list" "local part starting with !"
9256 If a local part that begins with an exclamation mark is required, it has to be
9257 specified using a regular expression, because otherwise the exclamation mark is
9258 treated as a sign of negation, as is standard in lists.
9259
9260 If a non-empty pattern that is not a regular expression or a lookup does not
9261 contain an @ character, it is matched against the domain part of the subject
9262 address. The only two formats that are recognized this way are a literal
9263 domain, or a domain pattern that starts with *. In both these cases, the effect
9264 is the same as if &`*@`& preceded the pattern. For example:
9265 .code
9266 deny senders = enemy.domain : *.enemy.domain
9267 .endd
9268
9269 The following kinds of more complicated address list pattern can match any
9270 address, including the empty address that is characteristic of bounce message
9271 senders:
9272
9273 .ilist
9274 .cindex "regular expressions" "in address list"
9275 .cindex "address list" "regular expression in"
9276 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9277 done against the complete address, with the pattern as the regular expression.
9278 You must take care that backslash and dollar characters are not misinterpreted
9279 as part of the string expansion. The simplest way to do this is to use &`\N`&
9280 to mark that part of the string as non-expandable. For example:
9281 .code
9282 deny senders = \N^.*this.*@example\.com$\N : \
9283                \N^\d{8}.+@spamhaus.example$\N : ...
9284 .endd
9285 The &`\N`& sequences are removed by the expansion, so these items do indeed
9286 start with &"^"& by the time they are being interpreted as address patterns.
9287
9288 .next
9289 .cindex "address list" "lookup for complete address"
9290 Complete addresses can be looked up by using a pattern that starts with a
9291 lookup type terminated by a semicolon, followed by the data for the lookup. For
9292 example:
9293 .code
9294 deny senders = cdb;/etc/blocked.senders : \
9295   mysql;select address from blocked where \
9296   address='${quote_mysql:$sender_address}'
9297 .endd
9298 Both query-style and single-key lookup types can be used. For a single-key
9299 lookup type, Exim uses the complete address as the key. However, empty keys are
9300 not supported for single-key lookups, so a match against the empty address
9301 always fails. This restriction does not apply to query-style lookups.
9302
9303 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9304 cannot be used, and is ignored if specified, with an entry being written to the
9305 panic log.
9306 .cindex "*@ with single-key lookup"
9307 However, you can configure lookup defaults, as described in section
9308 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9309 default. For example, with this lookup:
9310 .code
9311 accept senders = lsearch*@;/some/file
9312 .endd
9313 the file could contains lines like this:
9314 .code
9315 user1@domain1.example
9316 *@domain2.example
9317 .endd
9318 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9319 that are tried is:
9320 .code
9321 nimrod@jaeger.example
9322 *@jaeger.example
9323 *
9324 .endd
9325 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9326 would mean that every address matches, thus rendering the test useless.
9327
9328 &*Warning 2*&: Do not confuse these two kinds of item:
9329 .code
9330 deny recipients = dbm*@;/some/file
9331 deny recipients = *@dbm;/some/file
9332 .endd
9333 The first does a whole address lookup, with defaulting, as just described,
9334 because it starts with a lookup type. The second matches the local part and
9335 domain independently, as described in a bullet point below.
9336 .endlist
9337
9338
9339 The following kinds of address list pattern can match only non-empty addresses.
9340 If the subject address is empty, a match against any of these pattern types
9341 always fails.
9342
9343
9344 .ilist
9345 .cindex "@@ with single-key lookup"
9346 .cindex "address list" "@@ lookup type"
9347 .cindex "address list" "split local part and domain"
9348 If a pattern starts with &"@@"& followed by a single-key lookup item
9349 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9350 split into a local part and a domain. The domain is looked up in the file. If
9351 it is not found, there is no match. If it is found, the data that is looked up
9352 from the file is treated as a colon-separated list of local part patterns, each
9353 of which is matched against the subject local part in turn.
9354
9355 .cindex "asterisk" "in address list"
9356 The lookup may be a partial one, and/or one involving a search for a default
9357 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9358 patterns that are looked up can be regular expressions or begin with &"*"&, or
9359 even be further lookups. They may also be independently negated. For example,
9360 with
9361 .code
9362 deny senders = @@dbm;/etc/reject-by-domain
9363 .endd
9364 the data from which the DBM file is built could contain lines like
9365 .code
9366 baddomain.com:  !postmaster : *
9367 .endd
9368 to reject all senders except &%postmaster%& from that domain.
9369
9370 .cindex "local part" "starting with !"
9371 If a local part that actually begins with an exclamation mark is required, it
9372 has to be specified using a regular expression. In &(lsearch)& files, an entry
9373 may be split over several lines by indenting the second and subsequent lines,
9374 but the separating colon must still be included at line breaks. White space
9375 surrounding the colons is ignored. For example:
9376 .code
9377 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9378   spammer3 : spammer4
9379 .endd
9380 As in all colon-separated lists in Exim, a colon can be included in an item by
9381 doubling.
9382
9383 If the last item in the list starts with a right angle-bracket, the remainder
9384 of the item is taken as a new key to look up in order to obtain a continuation
9385 list of local parts. The new key can be any sequence of characters. Thus one
9386 might have entries like
9387 .code
9388 aol.com: spammer1 : spammer 2 : >*
9389 xyz.com: spammer3 : >*
9390 *:       ^\d{8}$
9391 .endd
9392 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9393 local parts for all domains, in addition to the specific local parts listed for
9394 each domain. Of course, using this feature costs another lookup each time a
9395 chain is followed, but the effort needed to maintain the data is reduced.
9396
9397 .cindex "loop" "in lookups"
9398 It is possible to construct loops using this facility, and in order to catch
9399 them, the chains may be no more than fifty items long.
9400
9401 .next
9402 The @@<&'lookup'&> style of item can also be used with a query-style
9403 lookup, but in this case, the chaining facility is not available. The lookup
9404 can only return a single list of local parts.
9405 .endlist
9406
9407 &*Warning*&: There is an important difference between the address list items
9408 in these two examples:
9409 .code
9410 senders = +my_list
9411 senders = *@+my_list
9412 .endd
9413 In the first one, &`my_list`& is a named address list, whereas in the second
9414 example it is a named domain list.
9415
9416
9417
9418
9419 .section "Case of letters in address lists" "SECTcasletadd"
9420 .cindex "case of local parts"
9421 .cindex "address list" "case forcing"
9422 .cindex "case forcing in address lists"
9423 Domains in email addresses are always handled caselessly, but for local parts
9424 case may be significant on some systems (see &%caseful_local_part%& for how
9425 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9426 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9427 blocking lists should be done in a case-independent manner. Since most address
9428 lists in Exim are used for this kind of control, Exim attempts to do this by
9429 default.
9430
9431 The domain portion of an address is always lowercased before matching it to an
9432 address list. The local part is lowercased by default, and any string
9433 comparisons that take place are done caselessly. This means that the data in
9434 the address list itself, in files included as plain filenames, and in any file
9435 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9436 keys in files that are looked up by a search type other than &(lsearch)& (which
9437 works caselessly) must be in lower case, because these lookups are not
9438 case-independent.
9439
9440 .cindex "&`+caseful`&"
9441 To allow for the possibility of caseful address list matching, if an item in
9442 an address list is the string &"+caseful"&, the original case of the local
9443 part is restored for any comparisons that follow, and string comparisons are no
9444 longer case-independent. This does not affect the domain, which remains in
9445 lower case. However, although independent matches on the domain alone are still
9446 performed caselessly, regular expressions that match against an entire address
9447 become case-sensitive after &"+caseful"& has been seen.
9448
9449
9450
9451 .section "Local part lists" "SECTlocparlis"
9452 .cindex "list" "local part list"
9453 .cindex "local part" "list"
9454 Case-sensitivity in local part lists is handled in the same way as for address
9455 lists, as just described. The &"+caseful"& item can be used if required. In a
9456 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9457 set false, the subject is lowercased and the matching is initially
9458 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9459 matching in the local part list, but not elsewhere in the router. If
9460 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9461 option is case-sensitive from the start.
9462
9463 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9464 comments are handled in the same way as address lists &-- they are recognized
9465 only if the # is preceded by white space or the start of the line.
9466 Otherwise, local part lists are matched in the same way as domain lists, except
9467 that the special items that refer to the local host (&`@`&, &`@[]`&,
9468 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9469 Refer to section &<<SECTdomainlist>>& for details of the other available item
9470 types.
9471 .ecindex IIDdohoadli
9472
9473
9474
9475
9476 . ////////////////////////////////////////////////////////////////////////////
9477 . ////////////////////////////////////////////////////////////////////////////
9478
9479 .chapter "String expansions" "CHAPexpand"
9480 .scindex IIDstrexp "expansion" "of strings"
9481 Many strings in Exim's runtime configuration are expanded before use. Some of
9482 them are expanded every time they are used; others are expanded only once.
9483
9484 When a string is being expanded it is copied verbatim from left to right except
9485 .cindex expansion "string concatenation"
9486 when a dollar or backslash character is encountered. A dollar specifies the
9487 start of a portion of the string that is interpreted and replaced as described
9488 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9489 escape character, as described in the following section.
9490
9491 Whether a string is expanded depends upon the context.  Usually this is solely
9492 dependent upon the option for which a value is sought; in this documentation,
9493 options for which string expansion is performed are marked with &dagger; after
9494 the data type.  ACL rules always expand strings.  A couple of expansion
9495 conditions do not expand some of the brace-delimited branches, for security
9496 reasons,
9497 .cindex "tainted data" expansion
9498 .cindex "tainted data" definition
9499 .cindex expansion "tainted data"
9500 and expansion of data deriving from the sender (&"tainted data"&)
9501 is not permitted.
9502
9503 .new
9504 Common ways of obtaining untainted equivalents of variables with
9505 tainted values
9506 .cindex "tainted data" "de-tainting"
9507 come down to using the tainted value as a lookup key in a trusted database.
9508 This database could be the filesystem structure,
9509 or the password file,
9510 or accessed via a DBMS.
9511 Specific methods are indexed under &"de-tainting"&.
9512 .wen
9513
9514
9515
9516 .section "Literal text in expanded strings" "SECTlittext"
9517 .cindex "expansion" "including literal text"
9518 An uninterpreted dollar can be included in an expanded string by putting a
9519 backslash in front of it. A backslash can be used to prevent any special
9520 character being treated specially in an expansion, including backslash itself.
9521 If the string appears in quotes in the configuration file, two backslashes are
9522 required because the quotes themselves cause interpretation of backslashes when
9523 the string is read in (see section &<<SECTstrings>>&).
9524
9525 .cindex "expansion" "non-expandable substrings"
9526 A portion of the string can specified as non-expandable by placing it between
9527 two occurrences of &`\N`&. This is particularly useful for protecting regular
9528 expressions, which often contain backslashes and dollar signs. For example:
9529 .code
9530 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9531 .endd
9532 On encountering the first &`\N`&, the expander copies subsequent characters
9533 without interpretation until it reaches the next &`\N`& or the end of the
9534 string.
9535
9536
9537
9538 .section "Character escape sequences in expanded strings" "SECID82"
9539 .cindex "expansion" "escape sequences"
9540 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9541 expanded string is recognized as an escape sequence for the character newline,
9542 carriage return, or tab, respectively. A backslash followed by up to three
9543 octal digits is recognized as an octal encoding for a single character, and a
9544 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9545 encoding.
9546
9547 These escape sequences are also recognized in quoted strings when they are read
9548 in. Their interpretation in expansions as well is useful for unquoted strings,
9549 and for other cases such as looked-up strings that are then expanded.
9550
9551
9552 .section "Testing string expansions" "SECID83"
9553 .cindex "expansion" "testing"
9554 .cindex "testing" "string expansion"
9555 .oindex "&%-be%&"
9556 Many expansions can be tested by calling Exim with the &%-be%& option. This
9557 takes the command arguments, or lines from the standard input if there are no
9558 arguments, runs them through the string expansion code, and writes the results
9559 to the standard output. Variables based on configuration values are set up, but
9560 since no message is being processed, variables such as &$local_part$& have no
9561 value. Nevertheless the &%-be%& option can be useful for checking out file and
9562 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9563 and &%nhash%&.
9564
9565 Exim gives up its root privilege when it is called with the &%-be%& option, and
9566 instead runs under the uid and gid it was called with, to prevent users from
9567 using &%-be%& for reading files to which they do not have access.
9568
9569 .oindex "&%-bem%&"
9570 If you want to test expansions that include variables whose values are taken
9571 from a message, there are two other options that can be used. The &%-bem%&
9572 option is like &%-be%& except that it is followed by a filename. The file is
9573 read as a message before doing the test expansions. For example:
9574 .code
9575 exim -bem /tmp/test.message '$h_subject:'
9576 .endd
9577 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9578 Exim message identifier. For example:
9579 .code
9580 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9581 .endd
9582 This loads the message from Exim's spool before doing the test expansions, and
9583 is therefore restricted to admin users.
9584
9585
9586 .section "Forced expansion failure" "SECTforexpfai"
9587 .cindex "expansion" "forced failure"
9588 A number of expansions that are described in the following section have
9589 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9590 (which are sometimes called &"curly brackets"&). Which of the two strings is
9591 used depends on some condition that is evaluated as part of the expansion. If,
9592 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9593 the entire string expansion fails in a way that can be detected by the code
9594 that requested the expansion. This is called &"forced expansion failure"&, and
9595 its consequences depend on the circumstances. In some cases it is no different
9596 from any other expansion failure, but in others a different action may be
9597 taken. Such variations are mentioned in the documentation of the option that is
9598 being expanded.
9599
9600
9601
9602
9603 .section "Expansion items" "SECTexpansionitems"
9604 The following items are recognized in expanded strings. White space may be used
9605 between sub-items that are keywords or substrings enclosed in braces inside an
9606 outer set of braces, to improve readability. &*Warning*&: Within braces,
9607 white space is significant.
9608
9609 .vlist
9610 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9611 .cindex "expansion" "variables"
9612 Substitute the contents of the named variable, for example:
9613 .code
9614 $local_part
9615 ${domain}
9616 .endd
9617 The second form can be used to separate the name from subsequent alphanumeric
9618 characters. This form (using braces) is available only for variables; it does
9619 &'not'& apply to message headers. The names of the variables are given in
9620 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9621 given, the expansion fails.
9622
9623 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9624 .cindex "expansion" "operators"
9625 The string is first itself expanded, and then the operation specified by
9626 <&'op'&> is applied to it. For example:
9627 .code
9628 ${lc:$local_part}
9629 .endd
9630 The string starts with the first character after the colon, which may be
9631 leading white space. A list of operators is given in section &<<SECTexpop>>&
9632 below. The operator notation is used for simple expansion items that have just
9633 one argument, because it reduces the number of braces and therefore makes the
9634 string easier to understand.
9635
9636 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9637 This item inserts &"basic"& header lines. It is described with the &%header%&
9638 expansion item below.
9639
9640
9641 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9642 .cindex "expansion" "calling an acl"
9643 .cindex "&%acl%&" "call from expansion"
9644 The name and zero to nine argument strings are first expanded separately.  The expanded
9645 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9646 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9647 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9648 and may use the variables; if another acl expansion is used the values
9649 are restored after it returns.  If the ACL sets
9650 a value using a "message =" modifier and returns accept or deny, the value becomes
9651 the result of the expansion.
9652 If no message is set and the ACL returns accept or deny
9653 the expansion result is an empty string.
9654 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9655
9656
9657 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9658 .cindex authentication "results header"
9659 .cindex headers "authentication-results:"
9660 .cindex authentication "expansion item"
9661 This item returns a string suitable for insertion as an
9662 &'Authentication-Results:'&
9663 header line.
9664 The given <&'authserv-id'&> is included in the result; typically this
9665 will be a domain name identifying the system performing the authentications.
9666 Methods that might be present in the result include:
9667 .code
9668 none
9669 iprev
9670 auth
9671 spf
9672 dkim
9673 .endd
9674
9675 Example use (as an ACL modifier):
9676 .code
9677       add_header = :at_start:${authresults {$primary_hostname}}
9678 .endd
9679 This is safe even if no authentication results are available.
9680
9681
9682 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9683        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9684 .cindex "expansion" "extracting certificate fields"
9685 .cindex "&%certextract%&" "certificate fields"
9686 .cindex "certificate" "extracting fields"
9687 The <&'certificate'&> must be a variable of type certificate.
9688 The field name is expanded and used to retrieve the relevant field from
9689 the certificate.  Supported fields are:
9690 .display
9691 &`version        `&
9692 &`serial_number  `&
9693 &`subject        `& RFC4514 DN
9694 &`issuer         `& RFC4514 DN
9695 &`notbefore      `& time
9696 &`notafter       `& time
9697 &`sig_algorithm  `&
9698 &`signature      `&
9699 &`subj_altname   `& tagged list
9700 &`ocsp_uri       `& list
9701 &`crl_uri        `& list
9702 .endd
9703 If the field is found,
9704 <&'string2'&> is expanded, and replaces the whole item;
9705 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9706 variable &$value$& contains the value that has been extracted. Afterwards, it
9707 is restored to any previous value it might have had.
9708
9709 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9710 key is not found. If {<&'string2'&>} is also omitted, the value that was
9711 extracted is used.
9712
9713 Some field names take optional modifiers, appended and separated by commas.
9714
9715 The field selectors marked as "RFC4514" above
9716 output a Distinguished Name string which is
9717 not quite
9718 parseable by Exim as a comma-separated tagged list
9719 (the exceptions being elements containing commas).
9720 RDN elements of a single type may be selected by
9721 a modifier of the type label; if so the expansion
9722 result is a list (newline-separated by default).
9723 The separator may be changed by another modifier of
9724 a right angle-bracket followed immediately by the new separator.
9725 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9726
9727 The field selectors marked as "time" above
9728 take an optional modifier of "int"
9729 for which the result is the number of seconds since epoch.
9730 Otherwise the result is a human-readable string
9731 in the timezone selected by the main "timezone" option.
9732
9733 The field selectors marked as "list" above return a list,
9734 newline-separated by default,
9735 (embedded separator characters in elements are doubled).
9736 The separator may be changed by a modifier of
9737 a right angle-bracket followed immediately by the new separator.
9738
9739 The field selectors marked as "tagged" above
9740 prefix each list element with a type string and an equals sign.
9741 Elements of only one type may be selected by a modifier
9742 which is one of "dns", "uri" or "mail";
9743 if so the element tags are omitted.
9744
9745 If not otherwise noted field values are presented in human-readable form.
9746
9747 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9748        {*&<&'arg'&>&*}...}*&"
9749 .cindex &%dlfunc%&
9750 This expansion dynamically loads and then calls a locally-written C function.
9751 This functionality is available only if Exim is compiled with
9752 .code
9753 EXPAND_DLFUNC=yes
9754 .endd
9755 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9756 object so that it doesn't reload the same object file in the same Exim process
9757 (but of course Exim does start new processes frequently).
9758
9759 There may be from zero to eight arguments to the function.
9760
9761 When compiling
9762 a local function that is to be called in this way,
9763 first &_DLFUNC_IMPL_& should be defined,
9764 and second &_local_scan.h_& should be included.
9765 The Exim variables and functions that are defined by that API
9766 are also available for dynamically loaded functions. The function itself
9767 must have the following type:
9768 .code
9769 int dlfunction(uschar **yield, int argc, uschar *argv[])
9770 .endd
9771 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9772 function should return one of the following values:
9773
9774 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9775 into the expanded string that is being built.
9776
9777 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9778 from &'yield'&, if it is set.
9779
9780 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9781 taken from &'yield'& if it is set.
9782
9783 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9784
9785 When compiling a function that is to be used in this way with gcc,
9786 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9787 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9788
9789
9790 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9791 .cindex "expansion" "extracting value from environment"
9792 .cindex "environment" "values from"
9793 The key is first expanded separately, and leading and trailing white space
9794 removed.
9795 This is then searched for as a name in the environment.
9796 If a variable is found then its value is placed in &$value$&
9797 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9798
9799 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9800 appear, for example:
9801 .code
9802 ${env{USER}{$value} fail }
9803 .endd
9804 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9805 {<&'string1'&>} must be present for &"fail"& to be recognized.
9806
9807 If {<&'string2'&>} is omitted an empty string is substituted on
9808 search failure.
9809 If {<&'string1'&>} is omitted the search result is substituted on
9810 search success.
9811
9812 The environment is adjusted by the &%keep_environment%& and
9813 &%add_environment%& main section options.
9814
9815
9816 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9817        {*&<&'string3'&>&*}}*&"
9818 .cindex "expansion" "extracting substrings by key"
9819 .cindex "&%extract%&" "substrings by key"
9820 The key and <&'string1'&> are first expanded separately. Leading and trailing
9821 white space is removed from the key (but not from any of the strings). The key
9822 must not be empty and must not consist entirely of digits.
9823 The expanded <&'string1'&> must be of the form:
9824 .display
9825 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9826 .endd
9827 .vindex "&$value$&"
9828 where the equals signs and spaces (but not both) are optional. If any of the
9829 values contain white space, they must be enclosed in double quotes, and any
9830 values that are enclosed in double quotes are subject to escape processing as
9831 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9832 for the value that corresponds to the key. The search is case-insensitive. If
9833 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9834 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9835 variable &$value$& contains the value that has been extracted. Afterwards, it
9836 is restored to any previous value it might have had.
9837
9838 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9839 key is not found. If {<&'string2'&>} is also omitted, the value that was
9840 extracted is used. Thus, for example, these two expansions are identical, and
9841 yield &"2001"&:
9842 .code
9843 ${extract{gid}{uid=1984 gid=2001}}
9844 ${extract{gid}{uid=1984 gid=2001}{$value}}
9845 .endd
9846 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9847 appear, for example:
9848 .code
9849 ${extract{Z}{A=... B=...}{$value} fail }
9850 .endd
9851 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9852 {<&'string2'&>} must be present for &"fail"& to be recognized.
9853
9854 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9855        {*&<&'string3'&>&*}}*&" &&&
9856        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9857        {*&<&'string3'&>&*}}*&"
9858 .cindex "expansion" "extracting from JSON object"
9859 .cindex JSON expansions
9860 The key and <&'string1'&> are first expanded separately. Leading and trailing
9861 white space is removed from the key (but not from any of the strings). The key
9862 must not be empty and must not consist entirely of digits.
9863 The expanded <&'string1'&> must be of the form:
9864 .display
9865 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9866 .endd
9867 .vindex "&$value$&"
9868 The braces, commas and colons, and the quoting of the member name are required;
9869 the spaces are optional.
9870 Matching of the key against the member names is done case-sensitively.
9871 For the &"json"& variant,
9872 if a returned value is a JSON string, it retains its leading and
9873 trailing quotes.
9874 For the &"jsons"& variant, which is intended for use with JSON strings, the
9875 leading and trailing quotes are removed from the returned value.
9876 . XXX should be a UTF-8 compare
9877
9878 The results of matching are handled as above.
9879
9880
9881 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9882         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9883 .cindex "expansion" "extracting substrings by number"
9884 .cindex "&%extract%&" "substrings by number"
9885 The <&'number'&> argument must consist entirely of decimal digits,
9886 apart from leading and trailing white space, which is ignored.
9887 This is what distinguishes this form of &%extract%& from the previous kind. It
9888 behaves in the same way, except that, instead of extracting a named field, it
9889 extracts from <&'string1'&> the field whose number is given as the first
9890 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9891 <&'string3'&> as before.
9892
9893 The fields in the string are separated by any one of the characters in the
9894 separator string. These may include space or tab characters.
9895 The first field is numbered one. If the number is negative, the fields are
9896 counted from the end of the string, with the rightmost one numbered -1. If the
9897 number given is zero, the entire string is returned. If the modulus of the
9898 number is greater than the number of fields in the string, the result is the
9899 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9900 provided. For example:
9901 .code
9902 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9903 .endd
9904 yields &"42"&, and
9905 .code
9906 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9907 .endd
9908 yields &"99"&. Two successive separators mean that the field between them is
9909 empty (for example, the fifth field above).
9910
9911
9912 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9913         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9914        "&*${extract jsons{*&<&'number'&>&*}}&&&
9915         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9916 .cindex "expansion" "extracting from JSON array"
9917 .cindex JSON expansions
9918 The <&'number'&> argument must consist entirely of decimal digits,
9919 apart from leading and trailing white space, which is ignored.
9920
9921 Field selection and result handling is as above;
9922 there is no choice of field separator.
9923 For the &"json"& variant,
9924 if a returned value is a JSON string, it retains its leading and
9925 trailing quotes.
9926 For the &"jsons"& variant, which is intended for use with JSON strings, the
9927 leading and trailing quotes are removed from the returned value.
9928
9929
9930 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9931 .cindex "list" "selecting by condition"
9932 .cindex "expansion" "selecting from list by condition"
9933 .vindex "&$item$&"
9934 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9935 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9936 For each item
9937 in this list, its value is place in &$item$&, and then the condition is
9938 evaluated. If the condition is true, &$item$& is added to the output as an
9939 item in a new list; if the condition is false, the item is discarded. The
9940 separator used for the output list is the same as the one used for the
9941 input, but a separator setting is not included in the output. For example:
9942 .code
9943 ${filter{a:b:c}{!eq{$item}{b}}}
9944 .endd
9945 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9946 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9947
9948
9949 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9950 .cindex "hash function" "textual"
9951 .cindex "expansion" "textual hash"
9952 This is a textual hashing function, and was the first to be implemented in
9953 early versions of Exim. In current releases, there are other hashing functions
9954 (numeric, MD5, and SHA-1), which are described below.
9955
9956 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9957 <&'n'&>. If you are using fixed values for these numbers, that is, if
9958 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9959 use the simpler operator notation that avoids some of the braces:
9960 .code
9961 ${hash_<n>_<m>:<string>}
9962 .endd
9963 The second number is optional (in both notations). If <&'n'&> is greater than
9964 or equal to the length of the string, the expansion item returns the string.
9965 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9966 function to the string. The new string consists of characters taken from the
9967 first <&'m'&> characters of the string
9968 .code
9969 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9970 .endd
9971 If <&'m'&> is not present the value 26 is used, so that only lower case
9972 letters appear. For example:
9973 .display
9974 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9975 &`$hash{5}{monty}}           `&   yields  &`monty`&
9976 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9977 .endd
9978
9979 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9980         &*$h_*&<&'header&~name'&>&*:*&" &&&
9981        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9982         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9983        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9984         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9985        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9986         &*$rh_*&<&'header&~name'&>&*:*&"
9987 .cindex "expansion" "header insertion"
9988 .vindex "&$header_$&"
9989 .vindex "&$bheader_$&"
9990 .vindex "&$lheader_$&"
9991 .vindex "&$rheader_$&"
9992 .cindex "header lines" "in expansion strings"
9993 .cindex "header lines" "character sets"
9994 .cindex "header lines" "decoding"
9995 Substitute the contents of the named message header line, for example
9996 .code
9997 $header_reply-to:
9998 .endd
9999 The newline that terminates a header line is not included in the expansion, but
10000 internal newlines (caused by splitting the header line over several physical
10001 lines) may be present.
10002
10003 The difference between the four pairs of expansions is in the way
10004 the data in the header line is interpreted.
10005
10006 .ilist
10007 .cindex "white space" "in header lines"
10008 &%rheader%& gives the original &"raw"& content of the header line, with no
10009 processing at all, and without the removal of leading and trailing white space.
10010
10011 .next
10012 .cindex "list" "of header lines"
10013 &%lheader%& gives a colon-separated list, one element per header when there
10014 are multiple headers with a given name.
10015 Any embedded colon characters within an element are doubled, so normal Exim
10016 list-processing facilities can be used.
10017 The terminating newline of each element is removed; in other respects
10018 the content is &"raw"&.
10019
10020 .next
10021 .cindex "base64 encoding" "in header lines"
10022 &%bheader%& removes leading and trailing white space, and then decodes base64
10023 or quoted-printable MIME &"words"& within the header text, but does no
10024 character set translation. If decoding of what looks superficially like a MIME
10025 &"word"& fails, the raw string is returned. If decoding
10026 .cindex "binary zero" "in header line"
10027 produces a binary zero character, it is replaced by a question mark &-- this is
10028 what Exim does for binary zeros that are actually received in header lines.
10029
10030 .next
10031 &%header%& tries to translate the string as decoded by &%bheader%& to a
10032 standard character set. This is an attempt to produce the same string as would
10033 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10034 returned. Translation is attempted only on operating systems that support the
10035 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10036 a system Makefile or in &_Local/Makefile_&.
10037 .endlist ilist
10038
10039 In a filter file, the target character set for &%header%& can be specified by a
10040 command of the following form:
10041 .code
10042 headers charset "UTF-8"
10043 .endd
10044 This command affects all references to &$h_$& (or &$header_$&) expansions in
10045 subsequently obeyed filter commands. In the absence of this command, the target
10046 character set in a filter is taken from the setting of the &%headers_charset%&
10047 option in the runtime configuration. The value of this option defaults to the
10048 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10049 ISO-8859-1.
10050
10051 Header names follow the syntax of RFC 2822, which states that they may contain
10052 any printing characters except space and colon. Consequently, curly brackets
10053 &'do not'& terminate header names, and should not be used to enclose them as
10054 if they were variables. Attempting to do so causes a syntax error.
10055
10056 Only header lines that are common to all copies of a message are visible to
10057 this mechanism. These are the original header lines that are received with the
10058 message, and any that are added by an ACL statement or by a system
10059 filter. Header lines that are added to a particular copy of a message by a
10060 router or transport are not accessible.
10061
10062 For incoming SMTP messages, no header lines are visible in
10063 ACLs that are obeyed before the data phase completes,
10064 because the header structure is not set up until the message is received.
10065 They are visible in DKIM, PRDR and DATA ACLs.
10066 Header lines that are added in a RCPT ACL (for example)
10067 are saved until the message's incoming header lines are available, at which
10068 point they are added.
10069 When any of the above ACLs ar
10070 running, however, header lines added by earlier ACLs are visible.
10071
10072 Upper case and lower case letters are synonymous in header names. If the
10073 following character is white space, the terminating colon may be omitted, but
10074 this is not recommended, because you may then forget it when it is needed. When
10075 white space terminates the header name, this white space is included in the
10076 expanded string.  If the message does not contain the given header, the
10077 expansion item is replaced by an empty string. (See the &%def%& condition in
10078 section &<<SECTexpcond>>& for a means of testing for the existence of a
10079 header.)
10080
10081 If there is more than one header with the same name, they are all concatenated
10082 to form the substitution string, up to a maximum length of 64K. Unless
10083 &%rheader%& is being used, leading and trailing white space is removed from
10084 each header before concatenation, and a completely empty header is ignored. A
10085 newline character is then inserted between non-empty headers, but there is no
10086 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10087 those headers that contain lists of addresses, a comma is also inserted at the
10088 junctions between headers. This does not happen for the &%rheader%& expansion.
10089
10090 .cindex "tainted data"
10091 When the headers are from an incoming message,
10092 the result of expanding any of these variables is tainted.
10093
10094
10095 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10096 .cindex "expansion" "hmac hashing"
10097 .cindex &%hmac%&
10098 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10099 shared secret and some text into a message authentication code, as specified in
10100 RFC 2104. This differs from &`${md5:secret_text...}`& or
10101 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10102 cryptographic hash, allowing for authentication that is not possible with MD5
10103 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10104 present. For example:
10105 .code
10106 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10107 .endd
10108 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10109 produces:
10110 .code
10111 dd97e3ba5d1a61b5006108f8c8252953
10112 .endd
10113 As an example of how this might be used, you might put in the main part of
10114 an Exim configuration:
10115 .code
10116 SPAMSCAN_SECRET=cohgheeLei2thahw
10117 .endd
10118 In a router or a transport you could then have:
10119 .code
10120 headers_add = \
10121   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10122   ${hmac{md5}{SPAMSCAN_SECRET}\
10123   {${primary_hostname},${message_exim_id},$h_message-id:}}
10124 .endd
10125 Then given a message, you can check where it was scanned by looking at the
10126 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10127 this header line is authentic by recomputing the authentication code from the
10128 host name, message ID and the &'Message-id:'& header line. This can be done
10129 using Exim's &%-be%& option, or by other means, for example, by using the
10130 &'hmac_md5_hex()'& function in Perl.
10131
10132
10133 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10134 .cindex "expansion" "conditional"
10135 .cindex "&%if%&, expansion item"
10136 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10137 item; otherwise <&'string2'&> is used. The available conditions are described
10138 in section &<<SECTexpcond>>& below. For example:
10139 .code
10140 ${if eq {$local_part}{postmaster} {yes}{no} }
10141 .endd
10142 The second string need not be present; if it is not and the condition is not
10143 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10144 be present instead of the second string (without any curly brackets). In this
10145 case, the expansion is forced to fail if the condition is not true (see section
10146 &<<SECTforexpfai>>&).
10147
10148 If both strings are omitted, the result is the string &`true`& if the condition
10149 is true, and the empty string if the condition is false. This makes it less
10150 cumbersome to write custom ACL and router conditions. For example, instead of
10151 .code
10152 condition = ${if >{$acl_m4}{3}{true}{false}}
10153 .endd
10154 you can use
10155 .code
10156 condition = ${if >{$acl_m4}{3}}
10157 .endd
10158
10159
10160
10161 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10162 .cindex expansion "imap folder"
10163 .cindex "&%imapfolder%& expansion item"
10164 This item converts a (possibly multilevel, or with non-ASCII characters)
10165 folder specification to a Maildir name for filesystem use.
10166 For information on internationalisation support see &<<SECTi18nMDA>>&.
10167
10168
10169
10170 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10171 .cindex "expansion" "string truncation"
10172 .cindex "&%length%& expansion item"
10173 The &%length%& item is used to extract the initial portion of a string. Both
10174 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10175 you are using a fixed value for the number, that is, if <&'string1'&> does not
10176 change when expanded, you can use the simpler operator notation that avoids
10177 some of the braces:
10178 .code
10179 ${length_<n>:<string>}
10180 .endd
10181 The result of this item is either the first <&'n'&> bytes or the whole
10182 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10183 &%strlen%&, which gives the length of a string.
10184 All measurement is done in bytes and is not UTF-8 aware.
10185
10186
10187 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10188         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10189 .cindex "expansion" "extracting list elements by number"
10190 .cindex "&%listextract%&" "extract list elements by number"
10191 .cindex "list" "extracting elements by number"
10192 The <&'number'&> argument must consist entirely of decimal digits,
10193 apart from an optional leading minus,
10194 and leading and trailing white space (which is ignored).
10195
10196 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10197 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10198
10199 The first field of the list is numbered one.
10200 If the number is negative, the fields are
10201 counted from the end of the list, with the rightmost one numbered -1.
10202 The numbered element of the list is extracted and placed in &$value$&,
10203 then <&'string2'&> is expanded as the result.
10204
10205 If the modulus of the
10206 number is zero or greater than the number of fields in the string,
10207 the result is the expansion of <&'string3'&>.
10208
10209 For example:
10210 .code
10211 ${listextract{2}{x:42:99}}
10212 .endd
10213 yields &"42"&, and
10214 .code
10215 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10216 .endd
10217 yields &"result: 42"&.
10218
10219 If {<&'string3'&>} is omitted, an empty string is used for string3.
10220 If {<&'string2'&>} is also omitted, the value that was
10221 extracted is used.
10222 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10223
10224
10225 .new
10226 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10227 .cindex quoting "for list"
10228 .cindex list quoting
10229 This item doubles any occurrence of the separator character
10230 in the given string.
10231 An empty string is replaced with a single space.
10232 This converts the string into a safe form for use as a list element,
10233 in a list using the given separator.
10234 .wen
10235
10236
10237 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10238         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10239        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10240         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10241 .cindex "expansion" "lookup in"
10242 .cindex "file" "lookups"
10243 .cindex "lookup" "in expanded string"
10244 The two forms of lookup item specify data lookups in files and databases, as
10245 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10246 lookups, and the second is used for query-style lookups. The <&'key'&>,
10247 <&'file'&>, and <&'query'&> strings are expanded before use.
10248
10249 If there is any white space in a lookup item which is part of a filter command,
10250 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10251 other place where white space is significant, the lookup item must be enclosed
10252 in double quotes. The use of data lookups in users' filter files may be locked
10253 out by the system administrator.
10254
10255 .vindex "&$value$&"
10256 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10257 During its expansion, the variable &$value$& contains the data returned by the
10258 lookup. Afterwards it reverts to the value it had previously (at the outer
10259 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10260 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10261 string on failure. If <&'string2'&> is provided, it can itself be a nested
10262 lookup, thus providing a mechanism for looking up a default value when the
10263 original lookup fails.
10264
10265 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10266 data for the outer lookup while the parameters of the second lookup are
10267 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10268 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10269 appear, and in this case, if the lookup fails, the entire expansion is forced
10270 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10271 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10272 successful lookup, and nothing in the case of failure.
10273
10274 For single-key lookups, the string &"partial"& is permitted to precede the
10275 search type in order to do partial matching, and * or *@ may follow a search
10276 type to request default lookups if the key does not match (see sections
10277 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10278
10279 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10280 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10281 and non-wild parts of the key during the expansion of the replacement text.
10282 They return to their previous values at the end of the lookup item.
10283
10284 This example looks up the postmaster alias in the conventional alias file:
10285 .code
10286 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10287 .endd
10288 This example uses NIS+ to look up the full name of the user corresponding to
10289 the local part of an address, forcing the expansion to fail if it is not found:
10290 .code
10291 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10292   {$value}fail}
10293 .endd
10294
10295
10296 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10297 .cindex "expansion" "list creation"
10298 .vindex "&$item$&"
10299 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10300 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10301 For each item
10302 in this list, its value is place in &$item$&, and then <&'string2'&> is
10303 expanded and added to the output as an item in a new list. The separator used
10304 for the output list is the same as the one used for the input, but a separator
10305 setting is not included in the output. For example:
10306 .code
10307 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10308 .endd
10309 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10310 value of &$item$& is restored to what it was before. See also the &%filter%&
10311 and &%reduce%& expansion items.
10312
10313 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10314 .cindex "expansion" "numeric hash"
10315 .cindex "hash function" "numeric"
10316 The three strings are expanded; the first two must yield numbers. Call them
10317 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10318 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10319 can use the simpler operator notation that avoids some of the braces:
10320 .code
10321 ${nhash_<n>_<m>:<string>}
10322 .endd
10323 The second number is optional (in both notations). If there is only one number,
10324 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10325 processed by a div/mod hash function that returns two numbers, separated by a
10326 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10327 example,
10328 .code
10329 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10330 .endd
10331 returns the string &"6/33"&.
10332
10333
10334
10335 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10336 .cindex "Perl" "use in expanded string"
10337 .cindex "expansion" "calling Perl from"
10338 This item is available only if Exim has been built to include an embedded Perl
10339 interpreter. The subroutine name and the arguments are first separately
10340 expanded, and then the Perl subroutine is called with those arguments. No
10341 additional arguments need be given; the maximum number permitted, including the
10342 name of the subroutine, is nine.
10343
10344 The return value of the subroutine is inserted into the expanded string, unless
10345 the return value is &%undef%&. In that case, the expansion fails in the same
10346 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10347 Whatever you return is evaluated in a scalar context. For example, if you
10348 return the name of a Perl vector, the return value is the size of the vector,
10349 not its contents.
10350
10351 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10352 with the error message that was passed to &%die%&. More details of the embedded
10353 Perl facility are given in chapter &<<CHAPperl>>&.
10354
10355 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10356 out the use of this expansion item in filter files.
10357
10358
10359 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10360 .cindex "&%prvs%& expansion item"
10361 The first argument is a complete email address and the second is secret
10362 keystring. The third argument, specifying a key number, is optional. If absent,
10363 it defaults to 0. The result of the expansion is a prvs-signed email address,
10364 to be typically used with the &%return_path%& option on an &(smtp)& transport
10365 as part of a bounce address tag validation (BATV) scheme. For more discussion
10366 and an example, see section &<<SECTverifyPRVS>>&.
10367
10368 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10369         {*&<&'string'&>&*}}*&"
10370 .cindex "&%prvscheck%& expansion item"
10371 This expansion item is the complement of the &%prvs%& item. It is used for
10372 checking prvs-signed addresses. If the expansion of the first argument does not
10373 yield a syntactically valid prvs-signed address, the whole item expands to the
10374 empty string. When the first argument does expand to a syntactically valid
10375 prvs-signed address, the second argument is expanded, with the prvs-decoded
10376 version of the address and the key number extracted from the address in the
10377 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10378
10379 These two variables can be used in the expansion of the second argument to
10380 retrieve the secret. The validity of the prvs-signed address is then checked
10381 against the secret. The result is stored in the variable &$prvscheck_result$&,
10382 which is empty for failure or &"1"& for success.
10383
10384 The third argument is optional; if it is missing, it defaults to an empty
10385 string. This argument is now expanded. If the result is an empty string, the
10386 result of the expansion is the decoded version of the address. This is the case
10387 whether or not the signature was valid. Otherwise, the result of the expansion
10388 is the expansion of the third argument.
10389
10390 All three variables can be used in the expansion of the third argument.
10391 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10392 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10393
10394 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10395 .cindex "expansion" "inserting an entire file"
10396 .cindex "file" "inserting into expansion"
10397 .cindex "&%readfile%& expansion item"
10398 The filename and end-of-line string are first expanded separately. The file is
10399 then read, and its contents replace the entire item. All newline characters in
10400 the file are replaced by the end-of-line string if it is present. Otherwise,
10401 newlines are left in the string.
10402 String expansion is not applied to the contents of the file. If you want this,
10403 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10404 the string expansion fails.
10405
10406 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10407 locks out the use of this expansion item in filter files.
10408
10409
10410
10411 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10412         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10413 .cindex "expansion" "inserting from a socket"
10414 .cindex "socket, use of in expansion"
10415 .cindex "&%readsocket%& expansion item"
10416 This item inserts data from a Unix domain or TCP socket into the expanded
10417 string. The minimal way of using it uses just two arguments, as in these
10418 examples:
10419 .code
10420 ${readsocket{/socket/name}{request string}}
10421 ${readsocket{inet:some.host:1234}{request string}}
10422 .endd
10423 For a Unix domain socket, the first substring must be the path to the socket.
10424 For an Internet socket, the first substring must contain &`inet:`& followed by
10425 a host name or IP address, followed by a colon and a port, which can be a
10426 number or the name of a TCP port in &_/etc/services_&. An IP address may
10427 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10428 example:
10429 .code
10430 ${readsocket{inet:[::1]:1234}{request string}}
10431 .endd
10432 Only a single host name may be given, but if looking it up yields more than
10433 one IP address, they are each tried in turn until a connection is made. For
10434 both kinds of socket, Exim makes a connection, writes the request string
10435 unless it is an empty string; and no terminating NUL is ever sent)
10436 and reads from the socket until an end-of-file
10437 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10438 extend what can be done. Firstly, you can vary the timeout. For example:
10439 .code
10440 ${readsocket{/socket/name}{request string}{3s}}
10441 .endd
10442
10443 The third argument is a list of options, of which the first element is the timeout
10444 and must be present if any options are given.
10445 Further elements are options of form &'name=value'&.
10446 Example:
10447 .code
10448 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10449 .endd
10450
10451 The following option names are recognised:
10452 .ilist
10453 &*cache*&
10454 Defines if the result data can be cached for use by a later identical
10455 request in the same process.
10456 Values are &"yes"& or &"no"& (the default).
10457 If not, all cached results for this connection specification
10458 will be invalidated.
10459
10460 .next
10461 &*shutdown*&
10462 Defines whether or not a write-shutdown is done on the connection after
10463 sending the request. Values are &"yes"& (the default) or &"no"&
10464 (preferred, eg. by some webservers).
10465
10466 .next
10467 &*tls*&
10468 Controls the use of TLS on the connection.
10469 Values are &"yes"& or &"no"& (the default).
10470 If it is enabled, a shutdown as descripbed above is never done.
10471 .endlist
10472
10473
10474 A fourth argument allows you to change any newlines that are in the data
10475 that is read, in the same way as for &%readfile%& (see above). This example
10476 turns them into spaces:
10477 .code
10478 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10479 .endd
10480 As with all expansions, the substrings are expanded before the processing
10481 happens. Errors in these sub-expansions cause the expansion to fail. In
10482 addition, the following errors can occur:
10483
10484 .ilist
10485 Failure to create a socket file descriptor;
10486 .next
10487 Failure to connect the socket;
10488 .next
10489 Failure to write the request string;
10490 .next
10491 Timeout on reading from the socket.
10492 .endlist
10493
10494 By default, any of these errors causes the expansion to fail. However, if
10495 you supply a fifth substring, it is expanded and used when any of the above
10496 errors occurs. For example:
10497 .code
10498 ${readsocket{/socket/name}{request string}{3s}{\n}\
10499   {socket failure}}
10500 .endd
10501 You can test for the existence of a Unix domain socket by wrapping this
10502 expansion in &`${if exists`&, but there is a race condition between that test
10503 and the actual opening of the socket, so it is safer to use the fifth argument
10504 if you want to be absolutely sure of avoiding an expansion error for a
10505 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10506
10507 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10508 locks out the use of this expansion item in filter files.
10509
10510
10511 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10512 .cindex "expansion" "reducing a list to a scalar"
10513 .cindex "list" "reducing to a scalar"
10514 .vindex "&$value$&"
10515 .vindex "&$item$&"
10516 This operation reduces a list to a single, scalar string. After expansion,
10517 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10518 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10519 Then <&'string2'&> is expanded and
10520 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10521 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10522 them. The result of that expansion is assigned to &$value$& before the next
10523 iteration. When the end of the list is reached, the final value of &$value$& is
10524 added to the expansion output. The &%reduce%& expansion item can be used in a
10525 number of ways. For example, to add up a list of numbers:
10526 .code
10527 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10528 .endd
10529 The result of that expansion would be &`6`&. The maximum of a list of numbers
10530 can be found:
10531 .code
10532 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10533 .endd
10534 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10535 restored to what they were before. See also the &%filter%& and &%map%&
10536 expansion items.
10537
10538 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10539 This item inserts &"raw"& header lines. It is described with the &%header%&
10540 expansion item in section &<<SECTexpansionitems>>& above.
10541
10542 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10543         {*&<&'string2'&>&*}}*&"
10544 .cindex "expansion" "running a command"
10545 .cindex "&%run%& expansion item"
10546 The command and its arguments are first expanded as one string. The string is
10547 split apart into individual arguments by spaces, and then the command is run
10548 in a separate process, but under the same uid and gid.  As in other command
10549 executions from Exim, a shell is not used by default. If the command requires
10550 a shell, you must explicitly code it.
10551
10552 Since the arguments are split by spaces, when there is a variable expansion
10553 which has an empty result, it will cause the situation that the argument will
10554 simply be omitted when the program is actually executed by Exim. If the
10555 script/program requires a specific number of arguments and the expanded
10556 variable could possibly result in this empty expansion, the variable must be
10557 quoted. This is more difficult if the expanded variable itself could result
10558 in a string containing quotes, because it would interfere with the quotes
10559 around the command arguments. A possible guard against this is to wrap the
10560 variable in the &%sg%& operator to change any quote marks to some other
10561 character.
10562
10563 The standard input for the command exists, but is empty. The standard output
10564 and standard error are set to the same file descriptor.
10565 .cindex "return code" "from &%run%& expansion"
10566 .vindex "&$value$&"
10567 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10568 and replaces the entire item; during this expansion, the standard output/error
10569 from the command is in the variable &$value$&. If the command fails,
10570 <&'string2'&>, if present, is expanded and used. Once again, during the
10571 expansion, the standard output/error from the command is in the variable
10572 &$value$&.
10573
10574 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10575 can be the word &"fail"& (not in braces) to force expansion failure if the
10576 command does not succeed. If both strings are omitted, the result is contents
10577 of the standard output/error on success, and nothing on failure.
10578
10579 .vindex "&$run_in_acl$&"
10580 The standard output/error of the command is put in the variable &$value$&.
10581 In this ACL example, the output of a command is logged for the admin to
10582 troubleshoot:
10583 .code
10584 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10585       log_message  = Output of id: $value
10586 .endd
10587 If the command requires shell idioms, such as the > redirect operator, the
10588 shell must be invoked directly, such as with:
10589 .code
10590 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10591 .endd
10592
10593 .vindex "&$runrc$&"
10594 The return code from the command is put in the variable &$runrc$&, and this
10595 remains set afterwards, so in a filter file you can do things like this:
10596 .code
10597 if "${run{x y z}{}}$runrc" is 1 then ...
10598   elif $runrc is 2 then ...
10599   ...
10600 endif
10601 .endd
10602 If execution of the command fails (for example, the command does not exist),
10603 the return code is 127 &-- the same code that shells use for non-existent
10604 commands.
10605
10606 &*Warning*&: In a router or transport, you cannot assume the order in which
10607 option values are expanded, except for those preconditions whose order of
10608 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10609 by the expansion of one option, and use it in another.
10610
10611 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10612 out the use of this expansion item in filter files.
10613
10614
10615 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10616 .cindex "expansion" "string substitution"
10617 .cindex "&%sg%& expansion item"
10618 This item works like Perl's substitution operator (s) with the global (/g)
10619 option; hence its name. However, unlike the Perl equivalent, Exim does not
10620 modify the subject string; instead it returns the modified string for insertion
10621 into the overall expansion. The item takes three arguments: the subject string,
10622 a regular expression, and a substitution string. For example:
10623 .code
10624 ${sg{abcdefabcdef}{abc}{xyz}}
10625 .endd
10626 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10627 if any $, } or \ characters are required in the regular expression or in the
10628 substitution string, they have to be escaped. For example:
10629 .code
10630 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10631 .endd
10632 yields &"defabc"&, and
10633 .code
10634 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10635 .endd
10636 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10637 the regular expression from string expansion.
10638
10639 The regular expression is compiled in 8-bit mode, working against bytes
10640 rather than any Unicode-aware character handling.
10641
10642
10643 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10644 .cindex sorting "a list"
10645 .cindex list sorting
10646 .cindex expansion "list sorting"
10647 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10648 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10649 The <&'comparator'&> argument is interpreted as the operator
10650 of a two-argument expansion condition.
10651 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10652 The comparison should return true when applied to two values
10653 if the first value should sort before the second value.
10654 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10655 the element being placed in &$item$&,
10656 to give values for comparison.
10657
10658 The item result is a sorted list,
10659 with the original list separator,
10660 of the list elements (in full) of the original.
10661
10662 Examples:
10663 .code
10664 ${sort{3:2:1:4}{<}{$item}}
10665 .endd
10666 sorts a list of numbers, and
10667 .code
10668 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10669 .endd
10670 will sort an MX lookup into priority order.
10671
10672
10673
10674 .new
10675 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10676 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10677 .wen
10678
10679
10680
10681 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10682 .cindex "&%substr%& expansion item"
10683 .cindex "substring extraction"
10684 .cindex "expansion" "substring extraction"
10685 The three strings are expanded; the first two must yield numbers. Call them
10686 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10687 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10688 can use the simpler operator notation that avoids some of the braces:
10689 .code
10690 ${substr_<n>_<m>:<string>}
10691 .endd
10692 The second number is optional (in both notations).
10693 If it is absent in the simpler format, the preceding underscore must also be
10694 omitted.
10695
10696 The &%substr%& item can be used to extract more general substrings than
10697 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10698 length required. For example
10699 .code
10700 ${substr{3}{2}{$local_part}}
10701 .endd
10702 If the starting offset is greater than the string length the result is the
10703 null string; if the length plus starting offset is greater than the string
10704 length, the result is the right-hand part of the string, starting from the
10705 given offset. The first byte (character) in the string has offset zero.
10706
10707 The &%substr%& expansion item can take negative offset values to count
10708 from the right-hand end of its operand. The last byte (character) is offset -1,
10709 the second-last is offset -2, and so on. Thus, for example,
10710 .code
10711 ${substr{-5}{2}{1234567}}
10712 .endd
10713 yields &"34"&. If the absolute value of a negative offset is greater than the
10714 length of the string, the substring starts at the beginning of the string, and
10715 the length is reduced by the amount of overshoot. Thus, for example,
10716 .code
10717 ${substr{-5}{2}{12}}
10718 .endd
10719 yields an empty string, but
10720 .code
10721 ${substr{-3}{2}{12}}
10722 .endd
10723 yields &"1"&.
10724
10725 When the second number is omitted from &%substr%&, the remainder of the string
10726 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10727 string preceding the offset point are taken. For example, an offset of -1 and
10728 no length, as in these semantically identical examples:
10729 .code
10730 ${substr_-1:abcde}
10731 ${substr{-1}{abcde}}
10732 .endd
10733 yields all but the last character of the string, that is, &"abcd"&.
10734
10735 All measurement is done in bytes and is not UTF-8 aware.
10736
10737
10738
10739 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10740         {*&<&'replacements'&>&*}}*&"
10741 .cindex "expansion" "character translation"
10742 .cindex "&%tr%& expansion item"
10743 This item does single-character (in bytes) translation on its subject string. The second
10744 argument is a list of characters to be translated in the subject string. Each
10745 matching character is replaced by the corresponding character from the
10746 replacement list. For example
10747 .code
10748 ${tr{abcdea}{ac}{13}}
10749 .endd
10750 yields &`1b3de1`&. If there are duplicates in the second character string, the
10751 last occurrence is used. If the third string is shorter than the second, its
10752 last character is replicated. However, if it is empty, no translation takes
10753 place.
10754
10755 All character handling is done in bytes and is not UTF-8 aware.
10756
10757 .endlist
10758
10759
10760
10761 .section "Expansion operators" "SECTexpop"
10762 .cindex "expansion" "operators"
10763 For expansion items that perform transformations on a single argument string,
10764 the &"operator"& notation is used because it is simpler and uses fewer braces.
10765 The substring is first expanded before the operation is applied to it. The
10766 following operations can be performed:
10767
10768 .vlist
10769 .vitem &*${address:*&<&'string'&>&*}*&
10770 .cindex "expansion" "RFC 2822 address handling"
10771 .cindex "&%address%& expansion item"
10772 The string is interpreted as an RFC 2822 address, as it might appear in a
10773 header line, and the effective address is extracted from it. If the string does
10774 not parse successfully, the result is empty.
10775
10776 The parsing correctly handles SMTPUTF8 Unicode in the string.
10777
10778
10779 .vitem &*${addresses:*&<&'string'&>&*}*&
10780 .cindex "expansion" "RFC 2822 address handling"
10781 .cindex "&%addresses%& expansion item"
10782 The string (after expansion) is interpreted as a list of addresses in RFC
10783 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10784 operative address (&'local-part@domain'&) is extracted from each item, and the
10785 result of the expansion is a colon-separated list, with appropriate
10786 doubling of colons should any happen to be present in the email addresses.
10787 Syntactically invalid RFC2822 address items are omitted from the output.
10788
10789 It is possible to specify a character other than colon for the output
10790 separator by starting the string with > followed by the new separator
10791 character. For example:
10792 .code
10793 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10794 .endd
10795 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10796 first, so if the expanded string starts with >, it may change the output
10797 separator unintentionally. This can be avoided by setting the output
10798 separator explicitly:
10799 .code
10800 ${addresses:>:$h_from:}
10801 .endd
10802
10803 Compare the &%address%& (singular)
10804 expansion item, which extracts the working address from a single RFC2822
10805 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10806 processing lists.
10807
10808 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10809 a strict interpretation of header line formatting.  Exim parses the bare,
10810 unquoted portion of an email address and if it finds a comma, treats it as an
10811 email address separator. For the example header line:
10812 .code
10813 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10814 .endd
10815 The first example below demonstrates that Q-encoded email addresses are parsed
10816 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10817 It does not see the comma because it's still encoded as "=2C".  The second
10818 example below is passed the contents of &`$header_from:`&, meaning it gets
10819 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10820 The third example shows that the presence of a comma is skipped when it is
10821 quoted.  The fourth example shows SMTPUTF8 handling.
10822 .code
10823 # exim -be '${addresses:From: \
10824 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10825 user@example.com
10826 # exim -be '${addresses:From: Last, First <user@example.com>}'
10827 Last:user@example.com
10828 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10829 user@example.com
10830 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10831 フィリップ@example.jp
10832 .endd
10833
10834 .vitem &*${base32:*&<&'digits'&>&*}*&
10835 .cindex "&%base32%& expansion item"
10836 .cindex "expansion" "conversion to base 32"
10837 The string must consist entirely of decimal digits. The number is converted to
10838 base 32 and output as a (empty, for zero) string of characters.
10839 Only lowercase letters are used.
10840
10841 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10842 .cindex "&%base32d%& expansion item"
10843 .cindex "expansion" "conversion to base 32"
10844 The string must consist entirely of base-32 digits.
10845 The number is converted to decimal and output as a string.
10846
10847 .vitem &*${base62:*&<&'digits'&>&*}*&
10848 .cindex "&%base62%& expansion item"
10849 .cindex "expansion" "conversion to base 62"
10850 The string must consist entirely of decimal digits. The number is converted to
10851 base 62 and output as a string of six characters, including leading zeros. In
10852 the few operating environments where Exim uses base 36 instead of base 62 for
10853 its message identifiers (because those systems do not have case-sensitive
10854 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10855 to be absolutely clear: this is &'not'& base64 encoding.
10856
10857 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10858 .cindex "&%base62d%& expansion item"
10859 .cindex "expansion" "conversion to base 62"
10860 The string must consist entirely of base-62 digits, or, in operating
10861 environments where Exim uses base 36 instead of base 62 for its message
10862 identifiers, base-36 digits. The number is converted to decimal and output as a
10863 string.
10864
10865 .vitem &*${base64:*&<&'string'&>&*}*&
10866 .cindex "expansion" "base64 encoding"
10867 .cindex "base64 encoding" "in string expansion"
10868 .cindex "&%base64%& expansion item"
10869 .cindex certificate "base64 of DER"
10870 This operator converts a string into one that is base64 encoded.
10871
10872 If the string is a single variable of type certificate,
10873 returns the base64 encoding of the DER form of the certificate.
10874
10875
10876 .vitem &*${base64d:*&<&'string'&>&*}*&
10877 .cindex "expansion" "base64 decoding"
10878 .cindex "base64 decoding" "in string expansion"
10879 .cindex "&%base64d%& expansion item"
10880 This operator converts a base64-encoded string into the un-coded form.
10881
10882
10883 .vitem &*${domain:*&<&'string'&>&*}*&
10884 .cindex "domain" "extraction"
10885 .cindex "expansion" "domain extraction"
10886 The string is interpreted as an RFC 2822 address and the domain is extracted
10887 from it. If the string does not parse successfully, the result is empty.
10888
10889
10890 .vitem &*${escape:*&<&'string'&>&*}*&
10891 .cindex "expansion" "escaping non-printing characters"
10892 .cindex "&%escape%& expansion item"
10893 If the string contains any non-printing characters, they are converted to
10894 escape sequences starting with a backslash. Whether characters with the most
10895 significant bit set (so-called &"8-bit characters"&) count as printing or not
10896 is controlled by the &%print_topbitchars%& option.
10897
10898 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10899 .cindex "expansion" "escaping 8-bit characters"
10900 .cindex "&%escape8bit%& expansion item"
10901 If the string contains and characters with the most significant bit set,
10902 they are converted to escape sequences starting with a backslash.
10903 Backslashes and DEL characters are also converted.
10904
10905
10906 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10907 .cindex "expansion" "expression evaluation"
10908 .cindex "expansion" "arithmetic expression"
10909 .cindex "&%eval%& expansion item"
10910 These items supports simple arithmetic and bitwise logical operations in
10911 expansion strings. The string (after expansion) must be a conventional
10912 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10913 logical operators, and parentheses. All operations are carried out using
10914 integer arithmetic. The operator priorities are as follows (the same as in the
10915 C programming language):
10916 .table2 70pt 300pt
10917 .irow &'highest:'& "not (~), negate (-)"
10918 .irow ""   "multiply (*), divide (/), remainder (%)"
10919 .irow ""   "plus (+), minus (-)"
10920 .irow ""   "shift-left (<<), shift-right (>>)"
10921 .irow ""   "and (&&)"
10922 .irow ""   "xor (^)"
10923 .irow &'lowest:'&  "or (|)"
10924 .endtable
10925 Binary operators with the same priority are evaluated from left to right. White
10926 space is permitted before or after operators.
10927
10928 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10929 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10930 decimal, even if they start with a leading zero; hexadecimal numbers are not
10931 permitted. This can be useful when processing numbers extracted from dates or
10932 times, which often do have leading zeros.
10933
10934 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10935 or 1024*1024*1024,
10936 respectively. Negative numbers are supported. The result of the computation is
10937 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10938
10939 .display
10940 &`${eval:1+1}            `&  yields 2
10941 &`${eval:1+2*3}          `&  yields 7
10942 &`${eval:(1+2)*3}        `&  yields 9
10943 &`${eval:2+42%5}         `&  yields 4
10944 &`${eval:0xc&amp;5}          `&  yields 4
10945 &`${eval:0xc|5}          `&  yields 13
10946 &`${eval:0xc^5}          `&  yields 9
10947 &`${eval:0xc>>1}         `&  yields 6
10948 &`${eval:0xc<<1}         `&  yields 24
10949 &`${eval:~255&amp;0x1234}    `&  yields 4608
10950 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10951 .endd
10952
10953 As a more realistic example, in an ACL you might have
10954 .code
10955 deny   condition =                    \
10956          ${if and {                   \
10957            {>{$rcpt_count}{10}}       \
10958            {                          \
10959            <                          \
10960              {$recipients_count}      \
10961              {${eval:$rcpt_count/2}}  \
10962            }                          \
10963          }{yes}{no}}
10964        message = Too many bad recipients
10965 .endd
10966 The condition is true if there have been more than 10 RCPT commands and
10967 fewer than half of them have resulted in a valid recipient.
10968
10969
10970 .vitem &*${expand:*&<&'string'&>&*}*&
10971 .cindex "expansion" "re-expansion of substring"
10972 The &%expand%& operator causes a string to be expanded for a second time. For
10973 example,
10974 .code
10975 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10976 .endd
10977 first looks up a string in a file while expanding the operand for &%expand%&,
10978 and then re-expands what it has found.
10979
10980
10981 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10982 .cindex "Unicode"
10983 .cindex "UTF-8" "conversion from"
10984 .cindex "expansion" "UTF-8 conversion"
10985 .cindex "&%from_utf8%& expansion item"
10986 The world is slowly moving towards Unicode, although there are no standards for
10987 email yet. However, other applications (including some databases) are starting
10988 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10989 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10990 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10991 the result is an undefined sequence of bytes.
10992
10993 Unicode code points with values less than 256 are compatible with ASCII and
10994 ISO-8859-1 (also known as Latin-1).
10995 For example, character 169 is the copyright symbol in both cases, though the
10996 way it is encoded is different. In UTF-8, more than one byte is needed for
10997 characters with code values greater than 127, whereas ISO-8859-1 is a
10998 single-byte encoding (but thereby limited to 256 characters). This makes
10999 translation from UTF-8 to ISO-8859-1 straightforward.
11000
11001
11002 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11003 .cindex "hash function" "textual"
11004 .cindex "expansion" "textual hash"
11005 The &%hash%& operator is a simpler interface to the hashing function that can
11006 be used when the two parameters are fixed numbers (as opposed to strings that
11007 change when expanded). The effect is the same as
11008 .code
11009 ${hash{<n>}{<m>}{<string>}}
11010 .endd
11011 See the description of the general &%hash%& item above for details. The
11012 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11013
11014
11015
11016 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11017 .cindex "base64 encoding" "conversion from hex"
11018 .cindex "expansion" "hex to base64"
11019 .cindex "&%hex2b64%& expansion item"
11020 This operator converts a hex string into one that is base64 encoded. This can
11021 be useful for processing the output of the various hashing functions.
11022
11023
11024
11025 .vitem &*${hexquote:*&<&'string'&>&*}*&
11026 .cindex "quoting" "hex-encoded unprintable characters"
11027 .cindex "&%hexquote%& expansion item"
11028 This operator converts non-printable characters in a string into a hex
11029 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11030 as is, and other byte values are converted to &`\xNN`&, for example, a
11031 byte value 127 is converted to &`\x7f`&.
11032
11033
11034 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11035 .cindex "&%ipv6denorm%& expansion item"
11036 .cindex "IP address" normalisation
11037 This expands an IPv6 address to a full eight-element colon-separated set
11038 of hex digits including leading zeroes.
11039 A trailing ipv4-style dotted-decimal set is converted to hex.
11040 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11041
11042 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11043 .cindex "&%ipv6norm%& expansion item"
11044 .cindex "IP address" normalisation
11045 .cindex "IP address" "canonical form"
11046 This converts an IPv6 address to canonical form.
11047 Leading zeroes of groups are omitted, and the longest
11048 set of zero-valued groups is replaced with a double colon.
11049 A trailing ipv4-style dotted-decimal set is converted to hex.
11050 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11051
11052
11053 .vitem &*${lc:*&<&'string'&>&*}*&
11054 .cindex "case forcing in strings"
11055 .cindex "string" "case forcing"
11056 .cindex "lower casing"
11057 .cindex "expansion" "case forcing"
11058 .cindex "&%lc%& expansion item"
11059 This forces the letters in the string into lower-case, for example:
11060 .code
11061 ${lc:$local_part}
11062 .endd
11063 Case is defined per the system C locale.
11064
11065 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11066 .cindex "expansion" "string truncation"
11067 .cindex "&%length%& expansion item"
11068 The &%length%& operator is a simpler interface to the &%length%& function that
11069 can be used when the parameter is a fixed number (as opposed to a string that
11070 changes when expanded). The effect is the same as
11071 .code
11072 ${length{<number>}{<string>}}
11073 .endd
11074 See the description of the general &%length%& item above for details. Note that
11075 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11076 when &%length%& is used as an operator.
11077 All measurement is done in bytes and is not UTF-8 aware.
11078
11079
11080 .vitem &*${listcount:*&<&'string'&>&*}*&
11081 .cindex "expansion" "list item count"
11082 .cindex "list" "item count"
11083 .cindex "list" "count of items"
11084 .cindex "&%listcount%& expansion item"
11085 The string is interpreted as a list and the number of items is returned.
11086
11087
11088 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11089 .cindex "expansion" "named list"
11090 .cindex "&%listnamed%& expansion item"
11091 The name is interpreted as a named list and the content of the list is returned,
11092 expanding any referenced lists, re-quoting as needed for colon-separation.
11093 If the optional type is given it must be one of "a", "d", "h" or "l"
11094 and selects address-, domain-, host- or localpart- lists to search among respectively.
11095 Otherwise all types are searched in an undefined order and the first
11096 matching list is returned.
11097
11098
11099 .vitem &*${local_part:*&<&'string'&>&*}*&
11100 .cindex "expansion" "local part extraction"
11101 .cindex "&%local_part%& expansion item"
11102 The string is interpreted as an RFC 2822 address and the local part is
11103 extracted from it. If the string does not parse successfully, the result is
11104 empty.
11105 The parsing correctly handles SMTPUTF8 Unicode in the string.
11106
11107
11108 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11109 .cindex "masked IP address"
11110 .cindex "IP address" "masking"
11111 .cindex "CIDR notation"
11112 .cindex "expansion" "IP address masking"
11113 .cindex "&%mask%& expansion item"
11114 If the form of the string to be operated on is not an IP address followed by a
11115 slash and an integer (that is, a network address in CIDR notation), the
11116 expansion fails. Otherwise, this operator converts the IP address to binary,
11117 masks off the least significant bits according to the bit count, and converts
11118 the result back to text, with mask appended. For example,
11119 .code
11120 ${mask:10.111.131.206/28}
11121 .endd
11122 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11123 be mostly used for looking up masked addresses in files, the result for an IPv6
11124 address uses dots to separate components instead of colons, because colon
11125 terminates a key string in lsearch files. So, for example,
11126 .code
11127 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11128 .endd
11129 returns the string
11130 .code
11131 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11132 .endd
11133 Letters in IPv6 addresses are always output in lower case.
11134
11135
11136 .vitem &*${md5:*&<&'string'&>&*}*&
11137 .cindex "MD5 hash"
11138 .cindex "expansion" "MD5 hash"
11139 .cindex certificate fingerprint
11140 .cindex "&%md5%& expansion item"
11141 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11142 as a 32-digit hexadecimal number, in which any letters are in lower case.
11143
11144 If the string is a single variable of type certificate,
11145 returns the MD5 hash fingerprint of the certificate.
11146
11147
11148 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11149 .cindex "expansion" "numeric hash"
11150 .cindex "hash function" "numeric"
11151 The &%nhash%& operator is a simpler interface to the numeric hashing function
11152 that can be used when the two parameters are fixed numbers (as opposed to
11153 strings that change when expanded). The effect is the same as
11154 .code
11155 ${nhash{<n>}{<m>}{<string>}}
11156 .endd
11157 See the description of the general &%nhash%& item above for details.
11158
11159
11160 .vitem &*${quote:*&<&'string'&>&*}*&
11161 .cindex "quoting" "in string expansions"
11162 .cindex "expansion" "quoting"
11163 .cindex "&%quote%& expansion item"
11164 The &%quote%& operator puts its argument into double quotes if it
11165 is an empty string or
11166 contains anything other than letters, digits, underscores, dots, and hyphens.
11167 Any occurrences of double quotes and backslashes are escaped with a backslash.
11168 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11169 respectively For example,
11170 .code
11171 ${quote:ab"*"cd}
11172 .endd
11173 becomes
11174 .code
11175 "ab\"*\"cd"
11176 .endd
11177 The place where this is useful is when the argument is a substitution from a
11178 variable or a message header.
11179
11180 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11181 .cindex "&%quote_local_part%& expansion item"
11182 This operator is like &%quote%&, except that it quotes the string only if
11183 required to do so by the rules of RFC 2822 for quoting local parts. For
11184 example, a plus sign would not cause quoting (but it would for &%quote%&).
11185 If you are creating a new email address from the contents of &$local_part$&
11186 (or any other unknown data), you should always use this operator.
11187
11188 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11189 will likely use the quoting form.
11190 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11191
11192
11193 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11194 .cindex "quoting" "lookup-specific"
11195 This operator applies lookup-specific quoting rules to the string. Each
11196 query-style lookup type has its own quoting rules which are described with
11197 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11198 .code
11199 ${quote_ldap:two * two}
11200 .endd
11201 returns
11202 .code
11203 two%20%5C2A%20two
11204 .endd
11205 For single-key lookup types, no quoting is ever necessary and this operator
11206 yields an unchanged string.
11207
11208
11209 .vitem &*${randint:*&<&'n'&>&*}*&
11210 .cindex "random number"
11211 This operator returns a somewhat random number which is less than the
11212 supplied number and is at least 0.  The quality of this randomness depends
11213 on how Exim was built; the values are not suitable for keying material.
11214 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11215 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11216 for versions of GnuTLS with that function.
11217 Otherwise, the implementation may be arc4random(), random() seeded by
11218 srandomdev() or srandom(), or a custom implementation even weaker than
11219 random().
11220
11221
11222 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11223 .cindex "expansion" "IP address"
11224 This operator reverses an IP address; for IPv4 addresses, the result is in
11225 dotted-quad decimal form, while for IPv6 addresses the result is in
11226 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11227 for DNS.  For example,
11228 .code
11229 ${reverse_ip:192.0.2.4}
11230 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11231 .endd
11232 returns
11233 .code
11234 4.2.0.192
11235 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
11236 .endd
11237
11238
11239 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11240 .cindex "expansion" "RFC 2047"
11241 .cindex "RFC 2047" "expansion operator"
11242 .cindex "&%rfc2047%& expansion item"
11243 This operator encodes text according to the rules of RFC 2047. This is an
11244 encoding that is used in header lines to encode non-ASCII characters. It is
11245 assumed that the input string is in the encoding specified by the
11246 &%headers_charset%& option, which gets its default at build time. If the string
11247 contains only characters in the range 33&--126, and no instances of the
11248 characters
11249 .code
11250 ? = ( ) < > @ , ; : \ " . [ ] _
11251 .endd
11252 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11253 string, using as many &"encoded words"& as necessary to encode all the
11254 characters.
11255
11256
11257 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11258 .cindex "expansion" "RFC 2047"
11259 .cindex "RFC 2047" "decoding"
11260 .cindex "&%rfc2047d%& expansion item"
11261 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11262 bytes are replaced by question marks. Characters are converted into the
11263 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11264 not recognized unless &%check_rfc2047_length%& is set false.
11265
11266 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11267 access a header line, RFC 2047 decoding is done automatically. You do not need
11268 to use this operator as well.
11269
11270
11271
11272 .vitem &*${rxquote:*&<&'string'&>&*}*&
11273 .cindex "quoting" "in regular expressions"
11274 .cindex "regular expressions" "quoting"
11275 .cindex "&%rxquote%& expansion item"
11276 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11277 characters in its argument. This is useful when substituting the values of
11278 variables or headers inside regular expressions.
11279
11280
11281 .vitem &*${sha1:*&<&'string'&>&*}*&
11282 .cindex "SHA-1 hash"
11283 .cindex "expansion" "SHA-1 hashing"
11284 .cindex certificate fingerprint
11285 .cindex "&%sha1%& expansion item"
11286 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11287 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11288
11289 If the string is a single variable of type certificate,
11290 returns the SHA-1 hash fingerprint of the certificate.
11291
11292
11293 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11294        &*${sha2:*&<&'string'&>&*}*& &&&
11295        &*${sha2_<n>:*&<&'string'&>&*}*&
11296 .cindex "SHA-256 hash"
11297 .cindex "SHA-2 hash"
11298 .cindex certificate fingerprint
11299 .cindex "expansion" "SHA-256 hashing"
11300 .cindex "&%sha256%& expansion item"
11301 .cindex "&%sha2%& expansion item"
11302 The &%sha256%& operator computes the SHA-256 hash value of the string
11303 and returns
11304 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11305
11306 If the string is a single variable of type certificate,
11307 returns the SHA-256 hash fingerprint of the certificate.
11308
11309 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11310 (except for certificates, which are not supported).
11311 Finally, if an underbar
11312 and a number is appended it specifies the output length, selecting a
11313 member of the SHA-2 family of hash functions.
11314 Values of 256, 384 and 512 are accepted, with 256 being the default.
11315
11316
11317 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11318        &*${sha3_<n>:*&<&'string'&>&*}*&
11319 .cindex "SHA3 hash"
11320 .cindex "expansion" "SHA3 hashing"
11321 .cindex "&%sha3%& expansion item"
11322 The &%sha3%& operator computes the SHA3-256 hash value of the string
11323 and returns
11324 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11325
11326 If a number is appended, separated by an underbar, it specifies
11327 the output length.  Values of 224, 256, 384 and 512 are accepted;
11328 with 256 being the default.
11329
11330 The &%sha3%& expansion item is only supported if Exim has been
11331 compiled with GnuTLS 3.5.0 or later,
11332 or OpenSSL 1.1.1 or later.
11333 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11334
11335
11336 .vitem &*${stat:*&<&'string'&>&*}*&
11337 .cindex "expansion" "statting a file"
11338 .cindex "file" "extracting characteristics"
11339 .cindex "&%stat%& expansion item"
11340 The string, after expansion, must be a file path. A call to the &[stat()]&
11341 function is made for this path. If &[stat()]& fails, an error occurs and the
11342 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11343 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11344 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11345 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11346 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11347 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11348 can extract individual fields using the &%extract%& expansion item.
11349
11350 The use of the &%stat%& expansion in users' filter files can be locked out by
11351 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11352 systems for files larger than 2GB.
11353
11354 .vitem &*${str2b64:*&<&'string'&>&*}*&
11355 .cindex "&%str2b64%& expansion item"
11356 Now deprecated, a synonym for the &%base64%& expansion operator.
11357
11358
11359
11360 .vitem &*${strlen:*&<&'string'&>&*}*&
11361 .cindex "expansion" "string length"
11362 .cindex "string" "length in expansion"
11363 .cindex "&%strlen%& expansion item"
11364 The item is replace by the length of the expanded string, expressed as a
11365 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11366 All measurement is done in bytes and is not UTF-8 aware.
11367
11368
11369 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11370 .cindex "&%substr%& expansion item"
11371 .cindex "substring extraction"
11372 .cindex "expansion" "substring expansion"
11373 The &%substr%& operator is a simpler interface to the &%substr%& function that
11374 can be used when the two parameters are fixed numbers (as opposed to strings
11375 that change when expanded). The effect is the same as
11376 .code
11377 ${substr{<start>}{<length>}{<string>}}
11378 .endd
11379 See the description of the general &%substr%& item above for details. The
11380 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11381 All measurement is done in bytes and is not UTF-8 aware.
11382
11383 .vitem &*${time_eval:*&<&'string'&>&*}*&
11384 .cindex "&%time_eval%& expansion item"
11385 .cindex "time interval" "decoding"
11386 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11387 seconds.
11388
11389 .vitem &*${time_interval:*&<&'string'&>&*}*&
11390 .cindex "&%time_interval%& expansion item"
11391 .cindex "time interval" "formatting"
11392 The argument (after sub-expansion) must be a sequence of decimal digits that
11393 represents an interval of time as a number of seconds. It is converted into a
11394 number of larger units and output in Exim's normal time format, for example,
11395 &`1w3d4h2m6s`&.
11396
11397 .vitem &*${uc:*&<&'string'&>&*}*&
11398 .cindex "case forcing in strings"
11399 .cindex "string" "case forcing"
11400 .cindex "upper casing"
11401 .cindex "expansion" "case forcing"
11402 .cindex "&%uc%& expansion item"
11403 This forces the letters in the string into upper-case.
11404 Case is defined per the system C locale.
11405
11406 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11407 .cindex "correction of invalid utf-8 sequences in strings"
11408 .cindex "utf-8" "utf-8 sequences"
11409 .cindex "incorrect utf-8"
11410 .cindex "expansion" "utf-8 forcing"
11411 .cindex "&%utf8clean%& expansion item"
11412 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11413 In versions of Exim before 4.92, this did not correctly do so for a truncated
11414 final codepoint's encoding, and the character would be silently dropped.
11415 If you must handle detection of this scenario across both sets of Exim behavior,
11416 the complexity will depend upon the task.
11417 For instance, to detect if the first character is multibyte and a 1-byte
11418 extraction can be successfully used as a path component (as is common for
11419 dividing up delivery folders), you might use:
11420 .code
11421 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11422 .endd
11423 (which will false-positive if the first character of the local part is a
11424 literal question mark).
11425
11426 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11427        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11428        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11429        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11430 .cindex expansion UTF-8
11431 .cindex UTF-8 expansion
11432 .cindex EAI
11433 .cindex internationalisation
11434 .cindex "&%utf8_domain_to_alabel%& expansion item"
11435 .cindex "&%utf8_domain_from_alabel%& expansion item"
11436 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11437 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11438 These convert EAI mail name components between UTF-8 and a-label forms.
11439 For information on internationalisation support see &<<SECTi18nMTA>>&.
11440 .endlist
11441
11442
11443
11444
11445
11446
11447 .section "Expansion conditions" "SECTexpcond"
11448 .scindex IIDexpcond "expansion" "conditions"
11449 The following conditions are available for testing by the &%${if%& construct
11450 while expanding strings:
11451
11452 .vlist
11453 .vitem &*!*&<&'condition'&>
11454 .cindex "expansion" "negating a condition"
11455 .cindex "negation" "in expansion condition"
11456 Preceding any condition with an exclamation mark negates the result of the
11457 condition.
11458
11459 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11460 .cindex "numeric comparison"
11461 .cindex "expansion" "numeric comparison"
11462 There are a number of symbolic operators for doing numeric comparisons. They
11463 are:
11464 .display
11465 &`=   `&   equal
11466 &`==  `&   equal
11467 &`>   `&   greater
11468 &`>=  `&   greater or equal
11469 &`<   `&   less
11470 &`<=  `&   less or equal
11471 .endd
11472 For example:
11473 .code
11474 ${if >{$message_size}{10M} ...
11475 .endd
11476 Note that the general negation operator provides for inequality testing. The
11477 two strings must take the form of optionally signed decimal integers,
11478 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11479 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11480 As a special case, the numerical value of an empty string is taken as
11481 zero.
11482
11483 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11484 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11485 10M, not if 10M is larger than &$message_size$&.
11486
11487
11488 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11489         {*&<&'arg2'&>&*}...}*&
11490 .cindex "expansion" "calling an acl"
11491 .cindex "&%acl%&" "expansion condition"
11492 The name and zero to nine argument strings are first expanded separately.  The expanded
11493 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11494 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11495 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11496 and may use the variables; if another acl expansion is used the values
11497 are restored after it returns.  If the ACL sets
11498 a value using a "message =" modifier the variable $value becomes
11499 the result of the expansion, otherwise it is empty.
11500 If the ACL returns accept the condition is true; if deny, false.
11501 If the ACL returns defer the result is a forced-fail.
11502
11503 .vitem &*bool&~{*&<&'string'&>&*}*&
11504 .cindex "expansion" "boolean parsing"
11505 .cindex "&%bool%& expansion condition"
11506 This condition turns a string holding a true or false representation into
11507 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11508 (case-insensitively); also integer numbers map to true if non-zero,
11509 false if zero.
11510 An empty string is treated as false.
11511 Leading and trailing whitespace is ignored;
11512 thus a string consisting only of whitespace is false.
11513 All other string values will result in expansion failure.
11514
11515 When combined with ACL variables, this expansion condition will let you
11516 make decisions in one place and act on those decisions in another place.
11517 For example:
11518 .code
11519 ${if bool{$acl_m_privileged_sender} ...
11520 .endd
11521
11522
11523 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11524 .cindex "expansion" "boolean parsing"
11525 .cindex "&%bool_lax%& expansion condition"
11526 Like &%bool%&, this condition turns a string into a boolean state.  But
11527 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11528 loose definition that the Router &%condition%& option uses.  The empty string
11529 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11530 true.  Leading and trailing whitespace is ignored.
11531
11532 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11533
11534 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11535 .cindex "expansion" "encrypted comparison"
11536 .cindex "encrypted strings, comparing"
11537 .cindex "&%crypteq%& expansion condition"
11538 This condition is included in the Exim binary if it is built to support any
11539 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11540 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11541 included in the binary.
11542
11543 The &%crypteq%& condition has two arguments. The first is encrypted and
11544 compared against the second, which is already encrypted. The second string may
11545 be in the LDAP form for storing encrypted strings, which starts with the
11546 encryption type in curly brackets, followed by the data. If the second string
11547 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11548 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11549 Typically this will be a field from a password file. An example of an encrypted
11550 string in LDAP form is:
11551 .code
11552 {md5}CY9rzUYh03PK3k6DJie09g==
11553 .endd
11554 If such a string appears directly in an expansion, the curly brackets have to
11555 be quoted, because they are part of the expansion syntax. For example:
11556 .code
11557 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11558 .endd
11559 The following encryption types (whose names are matched case-independently) are
11560 supported:
11561
11562 .ilist
11563 .cindex "MD5 hash"
11564 .cindex "base64 encoding" "in encrypted password"
11565 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11566 printable characters to compare with the remainder of the second string. If the
11567 length of the comparison string is 24, Exim assumes that it is base64 encoded
11568 (as in the above example). If the length is 32, Exim assumes that it is a
11569 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11570 comparison fails.
11571
11572 .next
11573 .cindex "SHA-1 hash"
11574 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11575 printable characters to compare with the remainder of the second string. If the
11576 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11577 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11578 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11579
11580 .next
11581 .cindex "&[crypt()]&"
11582 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11583 only the first eight characters of the password. However, in modern operating
11584 systems this is no longer true, and in many cases the entire password is used,
11585 whatever its length.
11586
11587 .next
11588 .cindex "&[crypt16()]&"
11589 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11590 use up to 16 characters of the password in some operating systems. Again, in
11591 modern operating systems, more characters may be used.
11592 .endlist
11593 Exim has its own version of &[crypt16()]&, which is just a double call to
11594 &[crypt()]&. For operating systems that have their own version, setting
11595 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11596 operating system version instead of its own. This option is set by default in
11597 the OS-dependent &_Makefile_& for those operating systems that are known to
11598 support &[crypt16()]&.
11599
11600 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11601 it was not using the same algorithm as some operating systems' versions. It
11602 turns out that as well as &[crypt16()]& there is a function called
11603 &[bigcrypt()]& in some operating systems. This may or may not use the same
11604 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11605
11606 However, since there is now a move away from the traditional &[crypt()]&
11607 functions towards using SHA1 and other algorithms, tidying up this area of
11608 Exim is seen as very low priority.
11609
11610 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11611 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11612 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11613 default is &`{crypt}`&. Whatever the default, you can always use either
11614 function by specifying it explicitly in curly brackets.
11615
11616 .vitem &*def:*&<&'variable&~name'&>
11617 .cindex "expansion" "checking for empty variable"
11618 .cindex "&%def%& expansion condition"
11619 The &%def%& condition must be followed by the name of one of the expansion
11620 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11621 variable does not contain the empty string. For example:
11622 .code
11623 ${if def:sender_ident {from $sender_ident}}
11624 .endd
11625 Note that the variable name is given without a leading &%$%& character. If the
11626 variable does not exist, the expansion fails.
11627
11628 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11629         &~&*def:h_*&<&'header&~name'&>&*:*&"
11630 .cindex "expansion" "checking header line existence"
11631 This condition is true if a message is being processed and the named header
11632 exists in the message. For example,
11633 .code
11634 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11635 .endd
11636 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11637 the header name must be terminated by a colon if white space does not follow.
11638
11639 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11640        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11641 .cindex "string" "comparison"
11642 .cindex "expansion" "string comparison"
11643 .cindex "&%eq%& expansion condition"
11644 .cindex "&%eqi%& expansion condition"
11645 The two substrings are first expanded. The condition is true if the two
11646 resulting strings are identical. For &%eq%& the comparison includes the case of
11647 letters, whereas for &%eqi%& the comparison is case-independent, where
11648 case is defined per the system C locale.
11649
11650 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11651 .cindex "expansion" "file existence test"
11652 .cindex "file" "existence test"
11653 .cindex "&%exists%&, expansion condition"
11654 The substring is first expanded and then interpreted as an absolute path. The
11655 condition is true if the named file (or directory) exists. The existence test
11656 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11657 users' filter files may be locked out by the system administrator.
11658
11659 .new
11660 &*Note:*& Testing a path using this condition is not a sufficient way of
11661 de-tainting it.
11662 .wen
11663
11664 .vitem &*first_delivery*&
11665 .cindex "delivery" "first"
11666 .cindex "first delivery"
11667 .cindex "expansion" "first delivery test"
11668 .cindex "&%first_delivery%& expansion condition"
11669 This condition, which has no data, is true during a message's first delivery
11670 attempt. It is false during any subsequent delivery attempts.
11671
11672
11673 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11674        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11675 .cindex "list" "iterative conditions"
11676 .cindex "expansion" "&*forall*& condition"
11677 .cindex "expansion" "&*forany*& condition"
11678 .vindex "&$item$&"
11679 These conditions iterate over a list. The first argument is expanded to form
11680 the list. By default, the list separator is a colon, but it can be changed by
11681 the normal method (&<<SECTlistsepchange>>&).
11682 The second argument is interpreted as a condition that is to
11683 be applied to each item in the list in turn. During the interpretation of the
11684 condition, the current list item is placed in a variable called &$item$&.
11685 .ilist
11686 For &*forany*&, interpretation stops if the condition is true for any item, and
11687 the result of the whole condition is true. If the condition is false for all
11688 items in the list, the overall condition is false.
11689 .next
11690 For &*forall*&, interpretation stops if the condition is false for any item,
11691 and the result of the whole condition is false. If the condition is true for
11692 all items in the list, the overall condition is true.
11693 .endlist
11694 Note that negation of &*forany*& means that the condition must be false for all
11695 items for the overall condition to succeed, and negation of &*forall*& means
11696 that the condition must be false for at least one item. In this example, the
11697 list separator is changed to a comma:
11698 .code
11699 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11700 .endd
11701 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11702 being processed, to enable these expansion items to be nested.
11703
11704 To scan a named list, expand it with the &*listnamed*& operator.
11705
11706 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11707        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11708        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11709        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11710 .cindex JSON "iterative conditions"
11711 .cindex JSON expansions
11712 .cindex expansion "&*forall_json*& condition"
11713 .cindex expansion "&*forany_json*& condition"
11714 .cindex expansion "&*forall_jsons*& condition"
11715 .cindex expansion "&*forany_jsons*& condition"
11716 As for the above, except that the first argument must, after expansion,
11717 be a JSON array.
11718 The array separator is not changeable.
11719 For the &"jsons"& variants the elements are expected to be JSON strings
11720 and have their quotes removed before the evaluation of the condition.
11721
11722
11723
11724 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11725        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11726 .cindex "string" "comparison"
11727 .cindex "expansion" "string comparison"
11728 .cindex "&%ge%& expansion condition"
11729 .cindex "&%gei%& expansion condition"
11730 The two substrings are first expanded. The condition is true if the first
11731 string is lexically greater than or equal to the second string. For &%ge%& the
11732 comparison includes the case of letters, whereas for &%gei%& the comparison is
11733 case-independent.
11734 Case and collation order are defined per the system C locale.
11735
11736 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11737        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11738 .cindex "string" "comparison"
11739 .cindex "expansion" "string comparison"
11740 .cindex "&%gt%& expansion condition"
11741 .cindex "&%gti%& expansion condition"
11742 The two substrings are first expanded. The condition is true if the first
11743 string is lexically greater than the second string. For &%gt%& the comparison
11744 includes the case of letters, whereas for &%gti%& the comparison is
11745 case-independent.
11746 Case and collation order are defined per the system C locale.
11747
11748
11749 .new
11750 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11751 SRS decode.  See SECT &<<SECTSRS>>& for details.
11752 .wen
11753
11754
11755 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11756        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11757 .cindex "string" "comparison"
11758 .cindex "list" "iterative conditions"
11759 Both strings are expanded; the second string is treated as a list of simple
11760 strings; if the first string is a member of the second, then the condition
11761 is true.
11762 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11763
11764 These are simpler to use versions of the more powerful &*forany*& condition.
11765 Examples, and the &*forany*& equivalents:
11766 .code
11767 ${if inlist{needle}{foo:needle:bar}}
11768   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11769 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11770   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11771 .endd
11772
11773 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11774        &*isip4&~{*&<&'string'&>&*}*& &&&
11775        &*isip6&~{*&<&'string'&>&*}*&
11776 .cindex "IP address" "testing string format"
11777 .cindex "string" "testing for IP address"
11778 .cindex "&%isip%& expansion condition"
11779 .cindex "&%isip4%& expansion condition"
11780 .cindex "&%isip6%& expansion condition"
11781 The substring is first expanded, and then tested to see if it has the form of
11782 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11783 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11784
11785 For an IPv4 address, the test is for four dot-separated components, each of
11786 which consists of from one to three digits. For an IPv6 address, up to eight
11787 colon-separated components are permitted, each containing from one to four
11788 hexadecimal digits. There may be fewer than eight components if an empty
11789 component (adjacent colons) is present. Only one empty component is permitted.
11790
11791 &*Note*&: The checks used to be just on the form of the address; actual numerical
11792 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11793 check.
11794 This is no longer the case.
11795
11796 The main use of these tests is to distinguish between IP addresses and
11797 host names, or between IPv4 and IPv6 addresses. For example, you could use
11798 .code
11799 ${if isip4{$sender_host_address}...
11800 .endd
11801 to test which IP version an incoming SMTP connection is using.
11802
11803 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11804 .cindex "LDAP" "use for authentication"
11805 .cindex "expansion" "LDAP authentication test"
11806 .cindex "&%ldapauth%& expansion condition"
11807 This condition supports user authentication using LDAP. See section
11808 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11809 queries. For this use, the query must contain a user name and password. The
11810 query itself is not used, and can be empty. The condition is true if the
11811 password is not empty, and the user name and password are accepted by the LDAP
11812 server. An empty password is rejected without calling LDAP because LDAP binds
11813 with an empty password are considered anonymous regardless of the username, and
11814 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11815 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11816 this can be used.
11817
11818
11819 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11820        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11821 .cindex "string" "comparison"
11822 .cindex "expansion" "string comparison"
11823 .cindex "&%le%& expansion condition"
11824 .cindex "&%lei%& expansion condition"
11825 The two substrings are first expanded. The condition is true if the first
11826 string is lexically less than or equal to the second string. For &%le%& the
11827 comparison includes the case of letters, whereas for &%lei%& the comparison is
11828 case-independent.
11829 Case and collation order are defined per the system C locale.
11830
11831 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11832        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11833 .cindex "string" "comparison"
11834 .cindex "expansion" "string comparison"
11835 .cindex "&%lt%& expansion condition"
11836 .cindex "&%lti%& expansion condition"
11837 The two substrings are first expanded. The condition is true if the first
11838 string is lexically less than the second string. For &%lt%& the comparison
11839 includes the case of letters, whereas for &%lti%& the comparison is
11840 case-independent.
11841 Case and collation order are defined per the system C locale.
11842
11843
11844 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11845 .cindex "expansion" "regular expression comparison"
11846 .cindex "regular expressions" "match in expanded string"
11847 .cindex "&%match%& expansion condition"
11848 The two substrings are first expanded. The second is then treated as a regular
11849 expression and applied to the first. Because of the pre-expansion, if the
11850 regular expression contains dollar, or backslash characters, they must be
11851 escaped. Care must also be taken if the regular expression contains braces
11852 (curly brackets). A closing brace must be escaped so that it is not taken as a
11853 premature termination of <&'string2'&>. The easiest approach is to use the
11854 &`\N`& feature to disable expansion of the regular expression.
11855 For example,
11856 .code
11857 ${if match {$local_part}{\N^\d{3}\N} ...
11858 .endd
11859 If the whole expansion string is in double quotes, further escaping of
11860 backslashes is also required.
11861
11862 The condition is true if the regular expression match succeeds.
11863 The regular expression is not required to begin with a circumflex
11864 metacharacter, but if there is no circumflex, the expression is not anchored,
11865 and it may match anywhere in the subject, not just at the start. If you want
11866 the pattern to match at the end of the subject, you must include the &`$`&
11867 metacharacter at an appropriate point.
11868 All character handling is done in bytes and is not UTF-8 aware,
11869 but we might change this in a future Exim release.
11870
11871 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11872 At the start of an &%if%& expansion the values of the numeric variable
11873 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11874 succeeds causes them to be reset to the substrings of that condition and they
11875 will have these values during the expansion of the success string. At the end
11876 of the &%if%& expansion, the previous values are restored. After testing a
11877 combination of conditions using &%or%&, the subsequent values of the numeric
11878 variables are those of the condition that succeeded.
11879
11880 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11881 .cindex "&%match_address%& expansion condition"
11882 See &*match_local_part*&.
11883
11884 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11885 .cindex "&%match_domain%& expansion condition"
11886 See &*match_local_part*&.
11887
11888 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11889 .cindex "&%match_ip%& expansion condition"
11890 This condition matches an IP address to a list of IP address patterns. It must
11891 be followed by two argument strings. The first (after expansion) must be an IP
11892 address or an empty string. The second (not expanded) is a restricted host
11893 list that can match only an IP address, not a host name. For example:
11894 .code
11895 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11896 .endd
11897 The specific types of host list item that are permitted in the list are:
11898
11899 .ilist
11900 An IP address, optionally with a CIDR mask.
11901 .next
11902 A single asterisk, which matches any IP address.
11903 .next
11904 An empty item, which matches only if the IP address is empty. This could be
11905 useful for testing for a locally submitted message or one from specific hosts
11906 in a single test such as
11907 . ==== As this is a nested list, any displays it contains must be indented
11908 . ==== as otherwise they are too far to the left. This comment applies to
11909 . ==== the use of xmlto plus fop. There's no problem when formatting with
11910 . ==== sdop, with or without the extra indent.
11911 .code
11912   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11913 .endd
11914 where the first item in the list is the empty string.
11915 .next
11916 The item @[] matches any of the local host's interface addresses.
11917 .next
11918 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11919 even if &`net-`& is not specified. There is never any attempt to turn the IP
11920 address into a host name. The most common type of linear search for
11921 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11922 masks. For example:
11923 .code
11924   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11925 .endd
11926 It is of course possible to use other kinds of lookup, and in such a case, you
11927 do need to specify the &`net-`& prefix if you want to specify a specific
11928 address mask, for example:
11929 .code
11930   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11931 .endd
11932 However, unless you are combining a &%match_ip%& condition with others, it is
11933 just as easy to use the fact that a lookup is itself a condition, and write:
11934 .code
11935   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11936 .endd
11937 .endlist ilist
11938
11939 Note that <&'string2'&> is not itself subject to string expansion, unless
11940 Exim was built with the EXPAND_LISTMATCH_RHS option.
11941
11942 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11943
11944 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11945 .cindex "domain list" "in expansion condition"
11946 .cindex "address list" "in expansion condition"
11947 .cindex "local part" "list, in expansion condition"
11948 .cindex "&%match_local_part%& expansion condition"
11949 This condition, together with &%match_address%& and &%match_domain%&, make it
11950 possible to test domain, address, and local part lists within expansions. Each
11951 condition requires two arguments: an item and a list to match. A trivial
11952 example is:
11953 .code
11954 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11955 .endd
11956 In each case, the second argument may contain any of the allowable items for a
11957 list of the appropriate type. Also, because the second argument
11958 is a standard form of list, it is possible to refer to a named list.
11959 Thus, you can use conditions like this:
11960 .code
11961 ${if match_domain{$domain}{+local_domains}{...
11962 .endd
11963 .cindex "&`+caseful`&"
11964 For address lists, the matching starts off caselessly, but the &`+caseful`&
11965 item can be used, as in all address lists, to cause subsequent items to
11966 have their local parts matched casefully. Domains are always matched
11967 caselessly.
11968
11969 Note that <&'string2'&> is not itself subject to string expansion, unless
11970 Exim was built with the EXPAND_LISTMATCH_RHS option.
11971
11972 &*Note*&: Host lists are &'not'& supported in this way. This is because
11973 hosts have two identities: a name and an IP address, and it is not clear
11974 how to specify cleanly how such a test would work. However, IP addresses can be
11975 matched using &%match_ip%&.
11976
11977 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11978 .cindex "PAM authentication"
11979 .cindex "AUTH" "with PAM"
11980 .cindex "Solaris" "PAM support"
11981 .cindex "expansion" "PAM authentication test"
11982 .cindex "&%pam%& expansion condition"
11983 &'Pluggable Authentication Modules'&
11984 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11985 available in the latest releases of Solaris and in some GNU/Linux
11986 distributions. The Exim support, which is intended for use in conjunction with
11987 the SMTP AUTH command, is available only if Exim is compiled with
11988 .code
11989 SUPPORT_PAM=yes
11990 .endd
11991 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11992 in some releases of GNU/Linux &%-ldl%& is also needed.
11993
11994 The argument string is first expanded, and the result must be a
11995 colon-separated list of strings. Leading and trailing white space is ignored.
11996 The PAM module is initialized with the service name &"exim"& and the user name
11997 taken from the first item in the colon-separated data string (<&'string1'&>).
11998 The remaining items in the data string are passed over in response to requests
11999 from the authentication function. In the simple case there will only be one
12000 request, for a password, so the data consists of just two strings.
12001
12002 There can be problems if any of the strings are permitted to contain colon
12003 characters. In the usual way, these have to be doubled to avoid being taken as
12004 separators.
12005 The &%listquote%& expansion item can be used for this.
12006 For example, the configuration
12007 of a LOGIN authenticator might contain this setting:
12008 .code
12009 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12010 .endd
12011 In some operating systems, PAM authentication can be done only from a process
12012 running as root. Since Exim is running as the Exim user when receiving
12013 messages, this means that PAM cannot be used directly in those systems.
12014 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12015
12016
12017 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12018 .cindex "&'pwcheck'& daemon"
12019 .cindex "Cyrus"
12020 .cindex "expansion" "&'pwcheck'& authentication test"
12021 .cindex "&%pwcheck%& expansion condition"
12022 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12023 This is one way of making it possible for passwords to be checked by a process
12024 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12025 deprecated. Its replacement is &'saslauthd'& (see below).
12026
12027 The pwcheck support is not included in Exim by default. You need to specify
12028 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12029 building Exim. For example:
12030 .code
12031 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12032 .endd
12033 You do not need to install the full Cyrus software suite in order to use
12034 the pwcheck daemon. You can compile and install just the daemon alone
12035 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12036 access to the &_/var/pwcheck_& directory.
12037
12038 The &%pwcheck%& condition takes one argument, which must be the user name and
12039 password, separated by a colon. For example, in a LOGIN authenticator
12040 configuration, you might have this:
12041 .code
12042 server_condition = ${if pwcheck{$auth1:$auth2}}
12043 .endd
12044 Again, for a PLAIN authenticator configuration, this would be:
12045 .code
12046 server_condition = ${if pwcheck{$auth2:$auth3}}
12047 .endd
12048 .vitem &*queue_running*&
12049 .cindex "queue runner" "detecting when delivering from"
12050 .cindex "expansion" "queue runner test"
12051 .cindex "&%queue_running%& expansion condition"
12052 This condition, which has no data, is true during delivery attempts that are
12053 initiated by queue runner processes, and false otherwise.
12054
12055
12056 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12057 .cindex "Radius"
12058 .cindex "expansion" "Radius authentication"
12059 .cindex "&%radius%& expansion condition"
12060 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12061 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12062 the Radius client configuration file in order to build Exim with Radius
12063 support.
12064
12065 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12066 library, using the original API. If you are using release 0.4.0 or later of
12067 this library, you need to set
12068 .code
12069 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12070 .endd
12071 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12072 &%libradius%& library that comes with FreeBSD. To do this, set
12073 .code
12074 RADIUS_LIB_TYPE=RADLIB
12075 .endd
12076 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12077 You may also have to supply a suitable setting in EXTRALIBS so that the
12078 Radius library can be found when Exim is linked.
12079
12080 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12081 Radius client library, which calls the Radius server. The condition is true if
12082 the authentication is successful. For example:
12083 .code
12084 server_condition = ${if radius{<arguments>}}
12085 .endd
12086
12087
12088 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12089         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12090 .cindex "&'saslauthd'& daemon"
12091 .cindex "Cyrus"
12092 .cindex "expansion" "&'saslauthd'& authentication test"
12093 .cindex "&%saslauthd%& expansion condition"
12094 This condition supports user authentication using the Cyrus &'saslauthd'&
12095 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12096 Using this daemon is one way of making it possible for passwords to be checked
12097 by a process that is not running as root.
12098
12099 The saslauthd support is not included in Exim by default. You need to specify
12100 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12101 building Exim. For example:
12102 .code
12103 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12104 .endd
12105 You do not need to install the full Cyrus software suite in order to use
12106 the saslauthd daemon. You can compile and install just the daemon alone
12107 from the Cyrus SASL library.
12108
12109 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12110 two are mandatory. For example:
12111 .code
12112 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12113 .endd
12114 The service and the realm are optional (which is why the arguments are enclosed
12115 in their own set of braces). For details of the meaning of the service and
12116 realm, and how to run the daemon, consult the Cyrus documentation.
12117 .endlist vlist
12118
12119
12120
12121 .section "Combining expansion conditions" "SECID84"
12122 .cindex "expansion" "combining conditions"
12123 Several conditions can be tested at once by combining them using the &%and%&
12124 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12125 conditions on their own, and precede their lists of sub-conditions. Each
12126 sub-condition must be enclosed in braces within the overall braces that contain
12127 the list. No repetition of &%if%& is used.
12128
12129
12130 .vlist
12131 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12132 .cindex "&""or""& expansion condition"
12133 .cindex "expansion" "&""or""& of conditions"
12134 The sub-conditions are evaluated from left to right. The condition is true if
12135 any one of the sub-conditions is true.
12136 For example,
12137 .code
12138 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12139 .endd
12140 When a true sub-condition is found, the following ones are parsed but not
12141 evaluated. If there are several &"match"& sub-conditions the values of the
12142 numeric variables afterwards are taken from the first one that succeeds.
12143
12144 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12145 .cindex "&""and""& expansion condition"
12146 .cindex "expansion" "&""and""& of conditions"
12147 The sub-conditions are evaluated from left to right. The condition is true if
12148 all of the sub-conditions are true. If there are several &"match"&
12149 sub-conditions, the values of the numeric variables afterwards are taken from
12150 the last one. When a false sub-condition is found, the following ones are
12151 parsed but not evaluated.
12152 .endlist
12153 .ecindex IIDexpcond
12154
12155
12156
12157
12158 .section "Expansion variables" "SECTexpvar"
12159 .cindex "expansion" "variables, list of"
12160 This section contains an alphabetical list of all the expansion variables. Some
12161 of them are available only when Exim is compiled with specific options such as
12162 support for TLS or the content scanning extension.
12163
12164 .vlist
12165 .vitem "&$0$&, &$1$&, etc"
12166 .cindex "numerical variables (&$1$& &$2$& etc)"
12167 When a &%match%& expansion condition succeeds, these variables contain the
12168 captured substrings identified by the regular expression during subsequent
12169 processing of the success string of the containing &%if%& expansion item.
12170 In the expansion condition case
12171 they do not retain their values afterwards; in fact, their previous
12172 values are restored at the end of processing an &%if%& item. The numerical
12173 variables may also be set externally by some other matching process which
12174 precedes the expansion of the string. For example, the commands available in
12175 Exim filter files include an &%if%& command with its own regular expression
12176 matching condition.
12177
12178 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12179 Within an acl condition, expansion condition or expansion item
12180 any arguments are copied to these variables,
12181 any unused variables being made empty.
12182
12183 .vitem "&$acl_c...$&"
12184 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12185 can be given any name that starts with &$acl_c$& and is at least six characters
12186 long, but the sixth character must be either a digit or an underscore. For
12187 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12188 variables persist throughout the lifetime of an SMTP connection. They can be
12189 used to pass information between ACLs and between different invocations of the
12190 same ACL. When a message is received, the values of these variables are saved
12191 with the message, and can be accessed by filters, routers, and transports
12192 during subsequent delivery.
12193
12194 .vitem "&$acl_m...$&"
12195 These variables are like the &$acl_c...$& variables, except that their values
12196 are reset after a message has been received. Thus, if several messages are
12197 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12198 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12199 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12200 message is received, the values of these variables are saved with the message,
12201 and can be accessed by filters, routers, and transports during subsequent
12202 delivery.
12203
12204 .vitem &$acl_narg$&
12205 Within an acl condition, expansion condition or expansion item
12206 this variable has the number of arguments.
12207
12208 .vitem &$acl_verify_message$&
12209 .vindex "&$acl_verify_message$&"
12210 After an address verification has failed, this variable contains the failure
12211 message. It retains its value for use in subsequent modifiers. The message can
12212 be preserved by coding like this:
12213 .code
12214 warn !verify = sender
12215      set acl_m0 = $acl_verify_message
12216 .endd
12217 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12218 &%log_message%& modifiers, to include information about the verification
12219 failure.
12220
12221 .vitem &$address_data$&
12222 .vindex "&$address_data$&"
12223 This variable is set by means of the &%address_data%& option in routers. The
12224 value then remains with the address while it is processed by subsequent routers
12225 and eventually a transport. If the transport is handling multiple addresses,
12226 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12227 for more details. &*Note*&: The contents of &$address_data$& are visible in
12228 user filter files.
12229
12230 If &$address_data$& is set when the routers are called from an ACL to verify
12231 a recipient address, the final value is still in the variable for subsequent
12232 conditions and modifiers of the ACL statement. If routing the address caused it
12233 to be redirected to just one address, the child address is also routed as part
12234 of the verification, and in this case the final value of &$address_data$& is
12235 from the child's routing.
12236
12237 If &$address_data$& is set when the routers are called from an ACL to verify a
12238 sender address, the final value is also preserved, but this time in
12239 &$sender_address_data$&, to distinguish it from data from a recipient
12240 address.
12241
12242 In both cases (recipient and sender verification), the value does not persist
12243 after the end of the current ACL statement. If you want to preserve
12244 these values for longer, you can save them in ACL variables.
12245
12246 .vitem &$address_file$&
12247 .vindex "&$address_file$&"
12248 When, as a result of aliasing, forwarding, or filtering, a message is directed
12249 to a specific file, this variable holds the name of the file when the transport
12250 is running. At other times, the variable is empty. For example, using the
12251 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12252 .code
12253 /home/r2d2/savemail
12254 .endd
12255 then when the &(address_file)& transport is running, &$address_file$&
12256 contains the text string &`/home/r2d2/savemail`&.
12257 .cindex "Sieve filter" "value of &$address_file$&"
12258 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12259 then up to the transport configuration to generate an appropriate absolute path
12260 to the relevant file.
12261
12262 .vitem &$address_pipe$&
12263 .vindex "&$address_pipe$&"
12264 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12265 this variable holds the pipe command when the transport is running.
12266
12267 .vitem "&$auth1$& &-- &$auth3$&"
12268 .vindex "&$auth1$&, &$auth2$&, etc"
12269 These variables are used in SMTP authenticators (see chapters
12270 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12271
12272 .vitem &$authenticated_id$&
12273 .cindex "authentication" "id"
12274 .vindex "&$authenticated_id$&"
12275 When a server successfully authenticates a client it may be configured to
12276 preserve some of the authentication information in the variable
12277 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12278 user/password authenticator configuration might preserve the user name for use
12279 in the routers. Note that this is not the same information that is saved in
12280 &$sender_host_authenticated$&.
12281
12282 When a message is submitted locally (that is, not over a TCP connection)
12283 the value of &$authenticated_id$& is normally the login name of the calling
12284 process. However, a trusted user can override this by means of the &%-oMai%&
12285 command line option.
12286 This second case also sets up information used by the
12287 &$authresults$& expansion item.
12288
12289 .vitem &$authenticated_fail_id$&
12290 .cindex "authentication" "fail" "id"
12291 .vindex "&$authenticated_fail_id$&"
12292 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12293 will contain the failed authentication id. If more than one authentication
12294 id is attempted, it will contain only the last one. The variable is
12295 available for processing in the ACL's, generally the quit or notquit ACL.
12296 A message to a local recipient could still be accepted without requiring
12297 authentication, which means this variable could also be visible in all of
12298 the ACL's as well.
12299
12300
12301 .vitem &$authenticated_sender$&
12302 .cindex "sender" "authenticated"
12303 .cindex "authentication" "sender"
12304 .cindex "AUTH" "on MAIL command"
12305 .vindex "&$authenticated_sender$&"
12306 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12307 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12308 described in section &<<SECTauthparamail>>&. Unless the data is the string
12309 &"<>"&, it is set as the authenticated sender of the message, and the value is
12310 available during delivery in the &$authenticated_sender$& variable. If the
12311 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12312
12313 .vindex "&$qualify_domain$&"
12314 When a message is submitted locally (that is, not over a TCP connection), the
12315 value of &$authenticated_sender$& is an address constructed from the login
12316 name of the calling process and &$qualify_domain$&, except that a trusted user
12317 can override this by means of the &%-oMas%& command line option.
12318
12319
12320 .vitem &$authentication_failed$&
12321 .cindex "authentication" "failure"
12322 .vindex "&$authentication_failed$&"
12323 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12324 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12325 possible to distinguish between &"did not try to authenticate"&
12326 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12327 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12328 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12329 negative response to an AUTH command, including (for example) an attempt to use
12330 an undefined mechanism.
12331
12332 .vitem &$av_failed$&
12333 .cindex "content scanning" "AV scanner failure"
12334 This variable is available when Exim is compiled with the content-scanning
12335 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12336 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12337 the ACL malware condition.
12338
12339 .vitem &$body_linecount$&
12340 .cindex "message body" "line count"
12341 .cindex "body of message" "line count"
12342 .vindex "&$body_linecount$&"
12343 When a message is being received or delivered, this variable contains the
12344 number of lines in the message's body. See also &$message_linecount$&.
12345
12346 .vitem &$body_zerocount$&
12347 .cindex "message body" "binary zero count"
12348 .cindex "body of message" "binary zero count"
12349 .cindex "binary zero" "in message body"
12350 .vindex "&$body_zerocount$&"
12351 When a message is being received or delivered, this variable contains the
12352 number of binary zero bytes (ASCII NULs) in the message's body.
12353
12354 .vitem &$bounce_recipient$&
12355 .vindex "&$bounce_recipient$&"
12356 This is set to the recipient address of a bounce message while Exim is creating
12357 it. It is useful if a customized bounce message text file is in use (see
12358 chapter &<<CHAPemsgcust>>&).
12359
12360 .vitem &$bounce_return_size_limit$&
12361 .vindex "&$bounce_return_size_limit$&"
12362 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12363 up to a multiple of 1000. It is useful when a customized error message text
12364 file is in use (see chapter &<<CHAPemsgcust>>&).
12365
12366 .vitem &$caller_gid$&
12367 .cindex "gid (group id)" "caller"
12368 .vindex "&$caller_gid$&"
12369 The real group id under which the process that called Exim was running. This is
12370 not the same as the group id of the originator of a message (see
12371 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12372 incarnation normally contains the Exim gid.
12373
12374 .vitem &$caller_uid$&
12375 .cindex "uid (user id)" "caller"
12376 .vindex "&$caller_uid$&"
12377 The real user id under which the process that called Exim was running. This is
12378 not the same as the user id of the originator of a message (see
12379 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12380 incarnation normally contains the Exim uid.
12381
12382 .vitem &$callout_address$&
12383 .vindex "&$callout_address$&"
12384 After a callout for verification, spamd or malware daemon service, the
12385 address that was connected to.
12386
12387 .vitem &$compile_number$&
12388 .vindex "&$compile_number$&"
12389 The building process for Exim keeps a count of the number
12390 of times it has been compiled. This serves to distinguish different
12391 compilations of the same version of Exim.
12392
12393 .vitem &$config_dir$&
12394 .vindex "&$config_dir$&"
12395 The directory name of the main configuration file. That is, the content of
12396 &$config_file$& with the last component stripped. The value does not
12397 contain the trailing slash. If &$config_file$& does not contain a slash,
12398 &$config_dir$& is ".".
12399
12400 .vitem &$config_file$&
12401 .vindex "&$config_file$&"
12402 The name of the main configuration file Exim is using.
12403
12404 .vitem &$dkim_verify_status$&
12405 Results of DKIM verification.
12406 For details see section &<<SECDKIMVFY>>&.
12407
12408 .vitem &$dkim_cur_signer$& &&&
12409        &$dkim_verify_reason$& &&&
12410        &$dkim_domain$& &&&
12411        &$dkim_identity$& &&&
12412        &$dkim_selector$& &&&
12413        &$dkim_algo$& &&&
12414        &$dkim_canon_body$& &&&
12415        &$dkim_canon_headers$& &&&
12416        &$dkim_copiedheaders$& &&&
12417        &$dkim_bodylength$& &&&
12418        &$dkim_created$& &&&
12419        &$dkim_expires$& &&&
12420        &$dkim_headernames$& &&&
12421        &$dkim_key_testing$& &&&
12422        &$dkim_key_nosubdomains$& &&&
12423        &$dkim_key_srvtype$& &&&
12424        &$dkim_key_granularity$& &&&
12425        &$dkim_key_notes$& &&&
12426        &$dkim_key_length$&
12427 These variables are only available within the DKIM ACL.
12428 For details see section &<<SECDKIMVFY>>&.
12429
12430 .vitem &$dkim_signers$&
12431 .vindex &$dkim_signers$&
12432 When a message has been received this variable contains
12433 a colon-separated list of signer domains and identities for the message.
12434 For details see section &<<SECDKIMVFY>>&.
12435
12436 .vitem &$dmarc_domain_policy$& &&&
12437        &$dmarc_status$& &&&
12438        &$dmarc_status_text$& &&&
12439        &$dmarc_used_domains$&
12440 Results of DMARC verification.
12441 For details see section &<<SECDMARC>>&.
12442
12443 .vitem &$dnslist_domain$& &&&
12444        &$dnslist_matched$& &&&
12445        &$dnslist_text$& &&&
12446        &$dnslist_value$&
12447 .vindex "&$dnslist_domain$&"
12448 .vindex "&$dnslist_matched$&"
12449 .vindex "&$dnslist_text$&"
12450 .vindex "&$dnslist_value$&"
12451 .cindex "black list (DNS)"
12452 When a DNS (black) list lookup succeeds, these variables are set to contain
12453 the following data from the lookup: the list's domain name, the key that was
12454 looked up, the contents of any associated TXT record, and the value from the
12455 main A record. See section &<<SECID204>>& for more details.
12456
12457 .vitem &$domain$&
12458 .vindex "&$domain$&"
12459 When an address is being routed, or delivered on its own, this variable
12460 contains the domain. Uppercase letters in the domain are converted into lower
12461 case for &$domain$&.
12462
12463 Global address rewriting happens when a message is received, so the value of
12464 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12465 is set during user filtering, but not during system filtering, because a
12466 message may have many recipients and the system filter is called just once.
12467
12468 When more than one address is being delivered at once (for example, several
12469 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12470 have the same domain. Transports can be restricted to handling only one domain
12471 at a time if the value of &$domain$& is required at transport time &-- this is
12472 the default for local transports. For further details of the environment in
12473 which local transports are run, see chapter &<<CHAPenvironment>>&.
12474
12475 .oindex "&%delay_warning_condition%&"
12476 At the end of a delivery, if all deferred addresses have the same domain, it is
12477 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12478
12479 The &$domain$& variable is also used in some other circumstances:
12480
12481 .ilist
12482 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12483 the recipient address. The domain of the &'sender'& address is in
12484 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12485 normally set during the running of the MAIL ACL. However, if the sender address
12486 is verified with a callout during the MAIL ACL, the sender domain is placed in
12487 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12488 the &(smtp)& transport.
12489
12490 .next
12491 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12492 &$domain$& contains the domain portion of the address that is being rewritten;
12493 it can be used in the expansion of the replacement address, for example, to
12494 rewrite domains by file lookup.
12495
12496 .next
12497 With one important exception, whenever a domain list is being scanned,
12498 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12499 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12500 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12501 that, in a RCPT ACL, the sender domain list can be dependent on the
12502 recipient domain (which is what is in &$domain$& at this time).
12503
12504 .next
12505 .cindex "ETRN" "value of &$domain$&"
12506 .oindex "&%smtp_etrn_command%&"
12507 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12508 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12509 .endlist
12510
12511 .cindex "tainted data"
12512 If the origin of the data is an incoming message,
12513 the result of expanding this variable is tainted and may not
12514 be further expanded or used as a filename.
12515 When an untainted version is needed, one should be obtained from
12516 looking up the value in a local (therefore trusted) database.
12517 Often &$domain_data$& is usable in this role.
12518
12519
12520 .vitem &$domain_data$&
12521 .vindex "&$domain_data$&"
12522 When the &%domains%& condition on a router
12523 .new
12524 or an ACL
12525 matches a domain
12526 against a list, the match value is copied to &$domain_data$&.
12527 This is an enhancement over previous versions of Exim, when it only
12528 applied to the data read by a lookup.
12529 For details on match values see section &<<SECTlistresults>>& et. al.
12530 .wen
12531
12532 If the router routes the
12533 address to a transport, the value is available in that transport. If the
12534 transport is handling multiple addresses, the value from the first address is
12535 used.
12536
12537 &$domain_data$& set in an ACL is available during
12538 the rest of the ACL statement.
12539
12540 .vitem &$exim_gid$&
12541 .vindex "&$exim_gid$&"
12542 This variable contains the numerical value of the Exim group id.
12543
12544 .vitem &$exim_path$&
12545 .vindex "&$exim_path$&"
12546 This variable contains the path to the Exim binary.
12547
12548 .vitem &$exim_uid$&
12549 .vindex "&$exim_uid$&"
12550 This variable contains the numerical value of the Exim user id.
12551
12552 .vitem &$exim_version$&
12553 .vindex "&$exim_version$&"
12554 This variable contains the version string of the Exim build.
12555 The first character is a major version number, currently 4.
12556 Then after a dot, the next group of digits is a minor version number.
12557 There may be other characters following the minor version.
12558 This value may be overridden by the &%exim_version%& main config option.
12559
12560 .vitem &$header_$&<&'name'&>
12561 This is not strictly an expansion variable. It is expansion syntax for
12562 inserting the message header line with the given name. Note that the name must
12563 be terminated by colon or white space, because it may contain a wide variety of
12564 characters. Note also that braces must &'not'& be used.
12565 See the full description in section &<<SECTexpansionitems>>& above.
12566
12567 .vitem &$headers_added$&
12568 .vindex "&$headers_added$&"
12569 Within an ACL this variable contains the headers added so far by
12570 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12571 The headers are a newline-separated list.
12572
12573 .vitem &$home$&
12574 .vindex "&$home$&"
12575 When the &%check_local_user%& option is set for a router, the user's home
12576 directory is placed in &$home$& when the check succeeds. In particular, this
12577 means it is set during the running of users' filter files. A router may also
12578 explicitly set a home directory for use by a transport; this can be overridden
12579 by a setting on the transport itself.
12580
12581 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12582 of the environment variable HOME, which is subject to the
12583 &%keep_environment%& and &%add_environment%& main config options.
12584
12585 .vitem &$host$&
12586 .vindex "&$host$&"
12587 If a router assigns an address to a transport (any transport), and passes a
12588 list of hosts with the address, the value of &$host$& when the transport starts
12589 to run is the name of the first host on the list. Note that this applies both
12590 to local and remote transports.
12591
12592 .cindex "transport" "filter"
12593 .cindex "filter" "transport filter"
12594 For the &(smtp)& transport, if there is more than one host, the value of
12595 &$host$& changes as the transport works its way through the list. In
12596 particular, when the &(smtp)& transport is expanding its options for encryption
12597 using TLS, or for specifying a transport filter (see chapter
12598 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12599 is connected.
12600
12601 When used in the client part of an authenticator configuration (see chapter
12602 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12603 client is connected.
12604
12605
12606 .vitem &$host_address$&
12607 .vindex "&$host_address$&"
12608 This variable is set to the remote host's IP address whenever &$host$& is set
12609 for a remote connection. It is also set to the IP address that is being checked
12610 when the &%ignore_target_hosts%& option is being processed.
12611
12612 .vitem &$host_data$&
12613 .vindex "&$host_data$&"
12614 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12615 result of the lookup is made available in the &$host_data$& variable. This
12616 allows you, for example, to do things like this:
12617 .code
12618 deny  hosts = net-lsearch;/some/file
12619       message = $host_data
12620 .endd
12621 .vitem &$host_lookup_deferred$&
12622 .cindex "host name" "lookup, failure of"
12623 .vindex "&$host_lookup_deferred$&"
12624 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12625 message comes from a remote host and there is an attempt to look up the host's
12626 name from its IP address, and the attempt is not successful, one of these
12627 variables is set to &"1"&.
12628
12629 .ilist
12630 If the lookup receives a definite negative response (for example, a DNS lookup
12631 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12632
12633 .next
12634 If there is any kind of problem during the lookup, such that Exim cannot
12635 tell whether or not the host name is defined (for example, a timeout for a DNS
12636 lookup), &$host_lookup_deferred$& is set to &"1"&.
12637 .endlist ilist
12638
12639 Looking up a host's name from its IP address consists of more than just a
12640 single reverse lookup. Exim checks that a forward lookup of at least one of the
12641 names it receives from a reverse lookup yields the original IP address. If this
12642 is not the case, Exim does not accept the looked up name(s), and
12643 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12644 IP address (for example, the existence of a PTR record in the DNS) is not
12645 sufficient on its own for the success of a host name lookup. If the reverse
12646 lookup succeeds, but there is a lookup problem such as a timeout when checking
12647 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12648 &"1"&. See also &$sender_host_name$&.
12649
12650 .cindex authentication "expansion item"
12651 Performing these checks sets up information used by the
12652 &%authresults%& expansion item.
12653
12654
12655 .vitem &$host_lookup_failed$&
12656 .vindex "&$host_lookup_failed$&"
12657 See &$host_lookup_deferred$&.
12658
12659 .vitem &$host_port$&
12660 .vindex "&$host_port$&"
12661 This variable is set to the remote host's TCP port whenever &$host$& is set
12662 for an outbound connection.
12663
12664 .vitem &$initial_cwd$&
12665 .vindex "&$initial_cwd$&
12666 This variable contains the full path name of the initial working
12667 directory of the current Exim process. This may differ from the current
12668 working directory, as Exim changes this to "/" during early startup, and
12669 to &$spool_directory$& later.
12670
12671 .vitem &$inode$&
12672 .vindex "&$inode$&"
12673 The only time this variable is set is while expanding the &%directory_file%&
12674 option in the &(appendfile)& transport. The variable contains the inode number
12675 of the temporary file which is about to be renamed. It can be used to construct
12676 a unique name for the file.
12677
12678 .vitem &$interface_address$&
12679 .vindex "&$interface_address$&"
12680 This is an obsolete name for &$received_ip_address$&.
12681
12682 .vitem &$interface_port$&
12683 .vindex "&$interface_port$&"
12684 This is an obsolete name for &$received_port$&.
12685
12686 .vitem &$item$&
12687 .vindex "&$item$&"
12688 This variable is used during the expansion of &*forall*& and &*forany*&
12689 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12690 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12691 empty.
12692
12693 .vitem &$ldap_dn$&
12694 .vindex "&$ldap_dn$&"
12695 This variable, which is available only when Exim is compiled with LDAP support,
12696 contains the DN from the last entry in the most recently successful LDAP
12697 lookup.
12698
12699 .vitem &$load_average$&
12700 .vindex "&$load_average$&"
12701 This variable contains the system load average, multiplied by 1000 so that it
12702 is an integer. For example, if the load average is 0.21, the value of the
12703 variable is 210. The value is recomputed every time the variable is referenced.
12704
12705 .vitem &$local_part$&
12706 .vindex "&$local_part$&"
12707 When an address is being routed, or delivered on its own, this
12708 variable contains the local part. When a number of addresses are being
12709 delivered together (for example, multiple RCPT commands in an SMTP
12710 session), &$local_part$& is not set.
12711
12712 Global address rewriting happens when a message is received, so the value of
12713 &$local_part$& during routing and delivery is the value after rewriting.
12714 &$local_part$& is set during user filtering, but not during system filtering,
12715 because a message may have many recipients and the system filter is called just
12716 once.
12717
12718 .cindex "tainted data"
12719 If the origin of the data is an incoming message,
12720 the result of expanding this variable is tainted and
12721 may not be further expanded or used as a filename.
12722
12723 &*Warning*&: the content of this variable is usually provided by a potential
12724 attacker.
12725 Consider carefully the implications of using it unvalidated as a name
12726 for file access.
12727 This presents issues for users' &_.forward_& and filter files.
12728 For traditional full user accounts, use &%check_local_users%& and the
12729 &$local_part_data$& variable rather than this one.
12730 For virtual users, store a suitable pathname component in the database
12731 which is used for account name validation, and use that retrieved value
12732 rather than this variable.
12733 Often &$local_part_data$& is usable in this role.
12734 If needed, use a router &%address_data%& or &%set%& option for
12735 the retrieved data.
12736
12737 When a message is being delivered to a file, pipe, or autoreply transport as a
12738 result of aliasing or forwarding, &$local_part$& is set to the local part of
12739 the parent address, not to the filename or command (see &$address_file$& and
12740 &$address_pipe$&).
12741
12742 When an ACL is running for a RCPT command, &$local_part$& contains the
12743 local part of the recipient address.
12744
12745 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12746 &$local_part$& contains the local part of the address that is being rewritten;
12747 it can be used in the expansion of the replacement address, for example.
12748
12749 In all cases, all quoting is removed from the local part. For example, for both
12750 the addresses
12751 .code
12752 "abc:xyz"@test.example
12753 abc\:xyz@test.example
12754 .endd
12755 the value of &$local_part$& is
12756 .code
12757 abc:xyz
12758 .endd
12759 If you use &$local_part$& to create another address, you should always wrap it
12760 inside a quoting operator. For example, in a &(redirect)& router you could
12761 have:
12762 .code
12763 data = ${quote_local_part:$local_part}@new.domain.example
12764 .endd
12765 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12766 to process local parts in a case-dependent manner in a router, you can set the
12767 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12768
12769 .vitem &$local_part_data$&
12770 .vindex "&$local_part_data$&"
12771 When the &%local_parts%& condition on a router or ACL
12772 matches a local part list
12773 .new
12774 the match value is copied to &$local_part_data$&.
12775 This is an enhancement over previous versions of Exim, when it only
12776 applied to the data read by a lookup.
12777 For details on match values see section &<<SECTlistresults>>& et. al.
12778 .wen
12779
12780 The &%check_local_user%& router option also sets this variable.
12781
12782 .vindex &$local_part_prefix$& &&&
12783         &$local_part_prefix_v$& &&&
12784         &$local_part_suffix$& &&&
12785         &$local_part_suffix_v$&
12786 .cindex affix variables
12787 If a local part prefix or suffix has been recognized, it is not included in the
12788 value of &$local_part$& during routing and subsequent delivery. The values of
12789 any prefix or suffix are in &$local_part_prefix$& and
12790 &$local_part_suffix$&, respectively.
12791 .cindex "tainted data"
12792 If the specification did not include a wildcard then
12793 the affix variable value is not tainted.
12794
12795 If the affix specification included a wildcard then the portion of
12796 the affix matched by the wildcard is in
12797 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12798 and both the whole and varying values are tainted.
12799
12800 .vitem &$local_scan_data$&
12801 .vindex "&$local_scan_data$&"
12802 This variable contains the text returned by the &[local_scan()]& function when
12803 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12804
12805 .vitem &$local_user_gid$&
12806 .vindex "&$local_user_gid$&"
12807 See &$local_user_uid$&.
12808
12809 .vitem &$local_user_uid$&
12810 .vindex "&$local_user_uid$&"
12811 This variable and &$local_user_gid$& are set to the uid and gid after the
12812 &%check_local_user%& router precondition succeeds. This means that their values
12813 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12814 and &%condition%&), for the &%address_data%& expansion, and for any
12815 router-specific expansions. At all other times, the values in these variables
12816 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12817
12818 .vitem &$localhost_number$&
12819 .vindex "&$localhost_number$&"
12820 This contains the expanded value of the
12821 &%localhost_number%& option. The expansion happens after the main options have
12822 been read.
12823
12824 .vitem &$log_inodes$&
12825 .vindex "&$log_inodes$&"
12826 The number of free inodes in the disk partition where Exim's
12827 log files are being written. The value is recalculated whenever the variable is
12828 referenced. If the relevant file system does not have the concept of inodes,
12829 the value of is -1. See also the &%check_log_inodes%& option.
12830
12831 .vitem &$log_space$&
12832 .vindex "&$log_space$&"
12833 The amount of free space (as a number of kilobytes) in the disk
12834 partition where Exim's log files are being written. The value is recalculated
12835 whenever the variable is referenced. If the operating system does not have the
12836 ability to find the amount of free space (only true for experimental systems),
12837 the space value is -1. See also the &%check_log_space%& option.
12838
12839
12840 .vitem &$lookup_dnssec_authenticated$&
12841 .vindex "&$lookup_dnssec_authenticated$&"
12842 This variable is set after a DNS lookup done by
12843 a dnsdb lookup expansion, dnslookup router or smtp transport.
12844 .cindex "DNS" "DNSSEC"
12845 It will be empty if &(DNSSEC)& was not requested,
12846 &"no"& if the result was not labelled as authenticated data
12847 and &"yes"& if it was.
12848 Results that are labelled as authoritative answer that match
12849 the &%dns_trust_aa%& configuration variable count also
12850 as authenticated data.
12851
12852 .vitem &$mailstore_basename$&
12853 .vindex "&$mailstore_basename$&"
12854 This variable is set only when doing deliveries in &"mailstore"& format in the
12855 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12856 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12857 contains the basename of the files that are being written, that is, the name
12858 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12859 variable is empty.
12860
12861 .vitem &$malware_name$&
12862 .vindex "&$malware_name$&"
12863 This variable is available when Exim is compiled with the
12864 content-scanning extension. It is set to the name of the virus that was found
12865 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12866
12867 .vitem &$max_received_linelength$&
12868 .vindex "&$max_received_linelength$&"
12869 .cindex "maximum" "line length"
12870 .cindex "line length" "maximum"
12871 This variable contains the number of bytes in the longest line that was
12872 received as part of the message, not counting the line termination
12873 character(s).
12874 It is not valid if the &%spool_files_wireformat%& option is used.
12875
12876 .vitem &$message_age$&
12877 .cindex "message" "age of"
12878 .vindex "&$message_age$&"
12879 This variable is set at the start of a delivery attempt to contain the number
12880 of seconds since the message was received. It does not change during a single
12881 delivery attempt.
12882
12883 .vitem &$message_body$&
12884 .cindex "body of message" "expansion variable"
12885 .cindex "message body" "in expansion"
12886 .cindex "binary zero" "in message body"
12887 .vindex "&$message_body$&"
12888 .oindex "&%message_body_visible%&"
12889 This variable contains the initial portion of a message's body while it is
12890 being delivered, and is intended mainly for use in filter files. The maximum
12891 number of characters of the body that are put into the variable is set by the
12892 &%message_body_visible%& configuration option; the default is 500.
12893
12894 .oindex "&%message_body_newlines%&"
12895 By default, newlines are converted into spaces in &$message_body$&, to make it
12896 easier to search for phrases that might be split over a line break. However,
12897 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12898 zeros are always converted into spaces.
12899
12900 .vitem &$message_body_end$&
12901 .cindex "body of message" "expansion variable"
12902 .cindex "message body" "in expansion"
12903 .vindex "&$message_body_end$&"
12904 This variable contains the final portion of a message's
12905 body while it is being delivered. The format and maximum size are as for
12906 &$message_body$&.
12907
12908 .vitem &$message_body_size$&
12909 .cindex "body of message" "size"
12910 .cindex "message body" "size"
12911 .vindex "&$message_body_size$&"
12912 When a message is being delivered, this variable contains the size of the body
12913 in bytes. The count starts from the character after the blank line that
12914 separates the body from the header. Newlines are included in the count. See
12915 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12916
12917 If the spool file is wireformat
12918 (see the &%spool_files_wireformat%& main option)
12919 the CRLF line-terminators are included in the count.
12920
12921 .vitem &$message_exim_id$&
12922 .vindex "&$message_exim_id$&"
12923 When a message is being received or delivered, this variable contains the
12924 unique message id that is generated and used by Exim to identify the message.
12925 An id is not created for a message until after its header has been successfully
12926 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12927 line; it is the local id that Exim assigns to the message, for example:
12928 &`1BXTIK-0001yO-VA`&.
12929
12930 .vitem &$message_headers$&
12931 .vindex &$message_headers$&
12932 This variable contains a concatenation of all the header lines when a message
12933 is being processed, except for lines added by routers or transports. The header
12934 lines are separated by newline characters. Their contents are decoded in the
12935 same way as a header line that is inserted by &%bheader%&.
12936
12937 .vitem &$message_headers_raw$&
12938 .vindex &$message_headers_raw$&
12939 This variable is like &$message_headers$& except that no processing of the
12940 contents of header lines is done.
12941
12942 .vitem &$message_id$&
12943 This is an old name for &$message_exim_id$&. It is now deprecated.
12944
12945 .vitem &$message_linecount$&
12946 .vindex "&$message_linecount$&"
12947 This variable contains the total number of lines in the header and body of the
12948 message. Compare &$body_linecount$&, which is the count for the body only.
12949 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12950 number of lines received. Before delivery happens (that is, before filters,
12951 routers, and transports run) the count is increased to include the
12952 &'Received:'& header line that Exim standardly adds, and also any other header
12953 lines that are added by ACLs. The blank line that separates the message header
12954 from the body is not counted.
12955
12956 As with the special case of &$message_size$&, during the expansion of the
12957 appendfile transport's maildir_tag option in maildir format, the value of
12958 &$message_linecount$& is the precise size of the number of newlines in the
12959 file that has been written (minus one for the blank line between the
12960 header and the body).
12961
12962 Here is an example of the use of this variable in a DATA ACL:
12963 .code
12964 deny condition = \
12965       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12966      message   = Too many lines in message header
12967 .endd
12968 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12969 message has not yet been received.
12970
12971 This variable is not valid if the &%spool_files_wireformat%& option is used.
12972
12973 .vitem &$message_size$&
12974 .cindex "size" "of message"
12975 .cindex "message" "size"
12976 .vindex "&$message_size$&"
12977 When a message is being processed, this variable contains its size in bytes. In
12978 most cases, the size includes those headers that were received with the
12979 message, but not those (such as &'Envelope-to:'&) that are added to individual
12980 deliveries as they are written. However, there is one special case: during the
12981 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12982 doing a delivery in maildir format, the value of &$message_size$& is the
12983 precise size of the file that has been written. See also
12984 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12985
12986 .cindex "RCPT" "value of &$message_size$&"
12987 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12988 contains the size supplied on the MAIL command, or -1 if no size was given. The
12989 value may not, of course, be truthful.
12990
12991 .vitem &$mime_$&&'xxx'&
12992 A number of variables whose names start with &$mime$& are
12993 available when Exim is compiled with the content-scanning extension. For
12994 details, see section &<<SECTscanmimepart>>&.
12995
12996 .vitem "&$n0$& &-- &$n9$&"
12997 These variables are counters that can be incremented by means
12998 of the &%add%& command in filter files.
12999
13000 .vitem &$original_domain$&
13001 .vindex "&$domain$&"
13002 .vindex "&$original_domain$&"
13003 When a top-level address is being processed for delivery, this contains the
13004 same value as &$domain$&. However, if a &"child"& address (for example,
13005 generated by an alias, forward, or filter file) is being processed, this
13006 variable contains the domain of the original address (lower cased). This
13007 differs from &$parent_domain$& only when there is more than one level of
13008 aliasing or forwarding. When more than one address is being delivered in a
13009 single transport run, &$original_domain$& is not set.
13010
13011 If a new address is created by means of a &%deliver%& command in a system
13012 filter, it is set up with an artificial &"parent"& address. This has the local
13013 part &'system-filter'& and the default qualify domain.
13014
13015 .vitem &$original_local_part$&
13016 .vindex "&$local_part$&"
13017 .vindex "&$original_local_part$&"
13018 When a top-level address is being processed for delivery, this contains the
13019 same value as &$local_part$&, unless a prefix or suffix was removed from the
13020 local part, because &$original_local_part$& always contains the full local
13021 part. When a &"child"& address (for example, generated by an alias, forward, or
13022 filter file) is being processed, this variable contains the full local part of
13023 the original address.
13024
13025 If the router that did the redirection processed the local part
13026 case-insensitively, the value in &$original_local_part$& is in lower case.
13027 This variable differs from &$parent_local_part$& only when there is more than
13028 one level of aliasing or forwarding. When more than one address is being
13029 delivered in a single transport run, &$original_local_part$& is not set.
13030
13031 If a new address is created by means of a &%deliver%& command in a system
13032 filter, it is set up with an artificial &"parent"& address. This has the local
13033 part &'system-filter'& and the default qualify domain.
13034
13035 .vitem &$originator_gid$&
13036 .cindex "gid (group id)" "of originating user"
13037 .cindex "sender" "gid"
13038 .vindex "&$caller_gid$&"
13039 .vindex "&$originator_gid$&"
13040 This variable contains the value of &$caller_gid$& that was set when the
13041 message was received. For messages received via the command line, this is the
13042 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13043 normally the gid of the Exim user.
13044
13045 .vitem &$originator_uid$&
13046 .cindex "uid (user id)" "of originating user"
13047 .cindex "sender" "uid"
13048 .vindex "&$caller_uid$&"
13049 .vindex "&$originator_uid$&"
13050 The value of &$caller_uid$& that was set when the message was received. For
13051 messages received via the command line, this is the uid of the sending user.
13052 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13053 user.
13054
13055 .vitem &$parent_domain$&
13056 .vindex "&$parent_domain$&"
13057 This variable is similar to &$original_domain$& (see
13058 above), except that it refers to the immediately preceding parent address.
13059
13060 .vitem &$parent_local_part$&
13061 .vindex "&$parent_local_part$&"
13062 This variable is similar to &$original_local_part$&
13063 (see above), except that it refers to the immediately preceding parent address.
13064
13065 .vitem &$pid$&
13066 .cindex "pid (process id)" "of current process"
13067 .vindex "&$pid$&"
13068 This variable contains the current process id.
13069
13070 .vitem &$pipe_addresses$&
13071 .cindex "filter" "transport filter"
13072 .cindex "transport" "filter"
13073 .vindex "&$pipe_addresses$&"
13074 This is not an expansion variable, but is mentioned here because the string
13075 &`$pipe_addresses`& is handled specially in the command specification for the
13076 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13077 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13078 It cannot be used in general expansion strings, and provokes an &"unknown
13079 variable"& error if encountered.
13080
13081 .vitem &$primary_hostname$&
13082 .vindex "&$primary_hostname$&"
13083 This variable contains the value set by &%primary_hostname%& in the
13084 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13085 a single-component name, Exim calls &[gethostbyname()]& (or
13086 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13087 qualified host name. See also &$smtp_active_hostname$&.
13088
13089
13090 .vitem &$proxy_external_address$& &&&
13091        &$proxy_external_port$& &&&
13092        &$proxy_local_address$& &&&
13093        &$proxy_local_port$& &&&
13094        &$proxy_session$&
13095 These variables are only available when built with Proxy Protocol
13096 or SOCKS5 support.
13097 For details see chapter &<<SECTproxyInbound>>&.
13098
13099 .vitem &$prdr_requested$&
13100 .cindex "PRDR" "variable for"
13101 This variable is set to &"yes"& if PRDR was requested by the client for the
13102 current message, otherwise &"no"&.
13103
13104 .vitem &$prvscheck_address$&
13105 This variable is used in conjunction with the &%prvscheck%& expansion item,
13106 which is described in sections &<<SECTexpansionitems>>& and
13107 &<<SECTverifyPRVS>>&.
13108
13109 .vitem &$prvscheck_keynum$&
13110 This variable is used in conjunction with the &%prvscheck%& expansion item,
13111 which is described in sections &<<SECTexpansionitems>>& and
13112 &<<SECTverifyPRVS>>&.
13113
13114 .vitem &$prvscheck_result$&
13115 This variable is used in conjunction with the &%prvscheck%& expansion item,
13116 which is described in sections &<<SECTexpansionitems>>& and
13117 &<<SECTverifyPRVS>>&.
13118
13119 .vitem &$qualify_domain$&
13120 .vindex "&$qualify_domain$&"
13121 The value set for the &%qualify_domain%& option in the configuration file.
13122
13123 .vitem &$qualify_recipient$&
13124 .vindex "&$qualify_recipient$&"
13125 The value set for the &%qualify_recipient%& option in the configuration file,
13126 or if not set, the value of &$qualify_domain$&.
13127
13128 .vitem &$queue_name$&
13129 .vindex &$queue_name$&
13130 .cindex "named queues" variable
13131 .cindex queues named
13132 The name of the spool queue in use; empty for the default queue.
13133
13134 .vitem &$queue_size$&
13135 .vindex "&$queue_size$&"
13136 .cindex "queue" "size of"
13137 .cindex "spool" "number of messages"
13138 This variable contains the number of messages queued.
13139 It is evaluated on demand, but no more often than once every minute.
13140 If there is no daemon notifier socket open, the value will be
13141 an empty string.
13142
13143 .vitem &$r_...$&
13144 .vindex &$r_...$&
13145 .cindex router variables
13146 Values can be placed in these variables by the &%set%& option of a router.
13147 They can be given any name that starts with &$r_$&.
13148 The values persist for the address being handled through subsequent routers
13149 and the eventual transport.
13150
13151 .vitem &$rcpt_count$&
13152 .vindex "&$rcpt_count$&"
13153 When a message is being received by SMTP, this variable contains the number of
13154 RCPT commands received for the current message. If this variable is used in a
13155 RCPT ACL, its value includes the current command.
13156
13157 .vitem &$rcpt_defer_count$&
13158 .vindex "&$rcpt_defer_count$&"
13159 .cindex "4&'xx'& responses" "count of"
13160 When a message is being received by SMTP, this variable contains the number of
13161 RCPT commands in the current message that have previously been rejected with a
13162 temporary (4&'xx'&) response.
13163
13164 .vitem &$rcpt_fail_count$&
13165 .vindex "&$rcpt_fail_count$&"
13166 When a message is being received by SMTP, this variable contains the number of
13167 RCPT commands in the current message that have previously been rejected with a
13168 permanent (5&'xx'&) response.
13169
13170 .vitem &$received_count$&
13171 .vindex "&$received_count$&"
13172 This variable contains the number of &'Received:'& header lines in the message,
13173 including the one added by Exim (so its value is always greater than zero). It
13174 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13175 delivering.
13176
13177 .vitem &$received_for$&
13178 .vindex "&$received_for$&"
13179 If there is only a single recipient address in an incoming message, this
13180 variable contains that address when the &'Received:'& header line is being
13181 built. The value is copied after recipient rewriting has happened, but before
13182 the &[local_scan()]& function is run.
13183
13184 .vitem &$received_ip_address$&
13185 .vindex "&$received_ip_address$&"
13186 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13187 variable is set to the address of the local IP interface, and &$received_port$&
13188 is set to the local port number. (The remote IP address and port are in
13189 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13190 the port value is -1 unless it has been set using the &%-oMi%& command line
13191 option.
13192
13193 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13194 could be used, for example, to make the filename for a TLS certificate depend
13195 on which interface and/or port is being used for the incoming connection. The
13196 values of &$received_ip_address$& and &$received_port$& are saved with any
13197 messages that are received, thus making these variables available at delivery
13198 time.
13199 For outbound connections see &$sending_ip_address$&.
13200
13201 .vitem &$received_port$&
13202 .vindex "&$received_port$&"
13203 See &$received_ip_address$&.
13204
13205 .vitem &$received_protocol$&
13206 .vindex "&$received_protocol$&"
13207 When a message is being processed, this variable contains the name of the
13208 protocol by which it was received. Most of the names used by Exim are defined
13209 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13210 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13211 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13212 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13213 connection and the client was successfully authenticated.
13214
13215 Exim uses the protocol name &"smtps"& for the case when encryption is
13216 automatically set up on connection without the use of STARTTLS (see
13217 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13218 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13219 where the client initially uses EHLO, sets up an encrypted connection using
13220 STARTTLS, and then uses HELO afterwards.
13221
13222 The &%-oMr%& option provides a way of specifying a custom protocol name for
13223 messages that are injected locally by trusted callers. This is commonly used to
13224 identify messages that are being re-injected after some kind of scanning.
13225
13226 .vitem &$received_time$&
13227 .vindex "&$received_time$&"
13228 This variable contains the date and time when the current message was received,
13229 as a number of seconds since the start of the Unix epoch.
13230
13231 .vitem &$recipient_data$&
13232 .vindex "&$recipient_data$&"
13233 This variable is set after an indexing lookup success in an ACL &%recipients%&
13234 condition. It contains the data from the lookup, and the value remains set
13235 until the next &%recipients%& test. Thus, you can do things like this:
13236 .display
13237 &`require recipients  = cdb*@;/some/file`&
13238 &`deny    `&&'some further test involving'& &`$recipient_data`&
13239 .endd
13240 &*Warning*&: This variable is set only when a lookup is used as an indexing
13241 method in the address list, using the semicolon syntax as in the example above.
13242 The variable is not set for a lookup that is used as part of the string
13243 expansion that all such lists undergo before being interpreted.
13244
13245 .vitem &$recipient_verify_failure$&
13246 .vindex "&$recipient_verify_failure$&"
13247 In an ACL, when a recipient verification fails, this variable contains
13248 information about the failure. It is set to one of the following words:
13249
13250 .ilist
13251 &"qualify"&: The address was unqualified (no domain), and the message
13252 was neither local nor came from an exempted host.
13253
13254 .next
13255 &"route"&: Routing failed.
13256
13257 .next
13258 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13259 or before the MAIL command (that is, on initial connection, HELO, or
13260 MAIL).
13261
13262 .next
13263 &"recipient"&: The RCPT command in a callout was rejected.
13264 .next
13265
13266 &"postmaster"&: The postmaster check in a callout was rejected.
13267 .endlist
13268
13269 The main use of this variable is expected to be to distinguish between
13270 rejections of MAIL and rejections of RCPT.
13271
13272 .vitem &$recipients$&
13273 .vindex "&$recipients$&"
13274 This variable contains a list of envelope recipients for a message. A comma and
13275 a space separate the addresses in the replacement text. However, the variable
13276 is not generally available, to prevent exposure of Bcc recipients in
13277 unprivileged users' filter files. You can use &$recipients$& only in these
13278 cases:
13279
13280 .olist
13281 In a system filter file.
13282 .next
13283 In the ACLs associated with the DATA command and with non-SMTP messages, that
13284 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13285 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13286 &%acl_not_smtp_mime%&.
13287 .next
13288 From within a &[local_scan()]& function.
13289 .endlist
13290
13291
13292 .vitem &$recipients_count$&
13293 .vindex "&$recipients_count$&"
13294 When a message is being processed, this variable contains the number of
13295 envelope recipients that came with the message. Duplicates are not excluded
13296 from the count. While a message is being received over SMTP, the number
13297 increases for each accepted recipient. It can be referenced in an ACL.
13298
13299
13300 .vitem &$regex_match_string$&
13301 .vindex "&$regex_match_string$&"
13302 This variable is set to contain the matching regular expression after a
13303 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13304
13305 .vitem "&$regex1$&, &$regex2$&, etc"
13306 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13307 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13308 these variables contain the
13309 captured substrings identified by the regular expression.
13310
13311
13312 .vitem &$reply_address$&
13313 .vindex "&$reply_address$&"
13314 When a message is being processed, this variable contains the contents of the
13315 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13316 contents of the &'From:'& header line. Apart from the removal of leading
13317 white space, the value is not processed in any way. In particular, no RFC 2047
13318 decoding or character code translation takes place.
13319
13320 .vitem &$return_path$&
13321 .vindex "&$return_path$&"
13322 When a message is being delivered, this variable contains the return path &--
13323 the sender field that will be sent as part of the envelope. It is not enclosed
13324 in <> characters. At the start of routing an address, &$return_path$& has the
13325 same value as &$sender_address$&, but if, for example, an incoming message to a
13326 mailing list has been expanded by a router which specifies a different address
13327 for bounce messages, &$return_path$& subsequently contains the new bounce
13328 address, whereas &$sender_address$& always contains the original sender address
13329 that was received with the message. In other words, &$sender_address$& contains
13330 the incoming envelope sender, and &$return_path$& contains the outgoing
13331 envelope sender.
13332
13333 .vitem &$return_size_limit$&
13334 .vindex "&$return_size_limit$&"
13335 This is an obsolete name for &$bounce_return_size_limit$&.
13336
13337 .vitem &$router_name$&
13338 .cindex "router" "name"
13339 .cindex "name" "of router"
13340 .vindex "&$router_name$&"
13341 During the running of a router this variable contains its name.
13342
13343 .vitem &$runrc$&
13344 .cindex "return code" "from &%run%& expansion"
13345 .vindex "&$runrc$&"
13346 This variable contains the return code from a command that is run by the
13347 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13348 assume the order in which option values are expanded, except for those
13349 preconditions whose order of testing is documented. Therefore, you cannot
13350 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13351 another.
13352
13353 .vitem &$self_hostname$&
13354 .oindex "&%self%&" "value of host name"
13355 .vindex "&$self_hostname$&"
13356 When an address is routed to a supposedly remote host that turns out to be the
13357 local host, what happens is controlled by the &%self%& generic router option.
13358 One of its values causes the address to be passed to another router. When this
13359 happens, &$self_hostname$& is set to the name of the local host that the
13360 original router encountered. In other circumstances its contents are null.
13361
13362 .vitem &$sender_address$&
13363 .vindex "&$sender_address$&"
13364 When a message is being processed, this variable contains the sender's address
13365 that was received in the message's envelope. The case of letters in the address
13366 is retained, in both the local part and the domain. For bounce messages, the
13367 value of this variable is the empty string. See also &$return_path$&.
13368
13369 .vitem &$sender_address_data$&
13370 .vindex "&$address_data$&"
13371 .vindex "&$sender_address_data$&"
13372 If &$address_data$& is set when the routers are called from an ACL to verify a
13373 sender address, the final value is preserved in &$sender_address_data$&, to
13374 distinguish it from data from a recipient address. The value does not persist
13375 after the end of the current ACL statement. If you want to preserve it for
13376 longer, you can save it in an ACL variable.
13377
13378 .vitem &$sender_address_domain$&
13379 .vindex "&$sender_address_domain$&"
13380 The domain portion of &$sender_address$&.
13381
13382 .vitem &$sender_address_local_part$&
13383 .vindex "&$sender_address_local_part$&"
13384 The local part portion of &$sender_address$&.
13385
13386 .vitem &$sender_data$&
13387 .vindex "&$sender_data$&"
13388 This variable is set after a lookup success in an ACL &%senders%& condition or
13389 in a router &%senders%& option. It contains the data from the lookup, and the
13390 value remains set until the next &%senders%& test. Thus, you can do things like
13391 this:
13392 .display
13393 &`require senders      = cdb*@;/some/file`&
13394 &`deny    `&&'some further test involving'& &`$sender_data`&
13395 .endd
13396 &*Warning*&: This variable is set only when a lookup is used as an indexing
13397 method in the address list, using the semicolon syntax as in the example above.
13398 The variable is not set for a lookup that is used as part of the string
13399 expansion that all such lists undergo before being interpreted.
13400
13401 .vitem &$sender_fullhost$&
13402 .vindex "&$sender_fullhost$&"
13403 When a message is received from a remote host, this variable contains the host
13404 name and IP address in a single string. It ends with the IP address in square
13405 brackets, followed by a colon and a port number if the logging of ports is
13406 enabled. The format of the rest of the string depends on whether the host
13407 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13408 looking up its IP address. (Looking up the IP address can be forced by the
13409 &%host_lookup%& option, independent of verification.) A plain host name at the
13410 start of the string is a verified host name; if this is not present,
13411 verification either failed or was not requested. A host name in parentheses is
13412 the argument of a HELO or EHLO command. This is omitted if it is identical to
13413 the verified host name or to the host's IP address in square brackets.
13414
13415 .vitem &$sender_helo_dnssec$&
13416 .vindex "&$sender_helo_dnssec$&"
13417 This boolean variable is true if a successful HELO verification was
13418 .cindex "DNS" "DNSSEC"
13419 done using DNS information the resolver library stated was authenticated data.
13420
13421 .vitem &$sender_helo_name$&
13422 .vindex "&$sender_helo_name$&"
13423 When a message is received from a remote host that has issued a HELO or EHLO
13424 command, the argument of that command is placed in this variable. It is also
13425 set if HELO or EHLO is used when a message is received using SMTP locally via
13426 the &%-bs%& or &%-bS%& options.
13427
13428 .vitem &$sender_host_address$&
13429 .vindex "&$sender_host_address$&"
13430 When a message is received from a remote host using SMTP,
13431 this variable contains that
13432 host's IP address. For locally non-SMTP submitted messages, it is empty.
13433
13434 .vitem &$sender_host_authenticated$&
13435 .vindex "&$sender_host_authenticated$&"
13436 This variable contains the name (not the public name) of the authenticator
13437 driver that successfully authenticated the client from which the message was
13438 received. It is empty if there was no successful authentication. See also
13439 &$authenticated_id$&.
13440
13441 .vitem &$sender_host_dnssec$&
13442 .vindex "&$sender_host_dnssec$&"
13443 If an attempt to populate &$sender_host_name$& has been made
13444 (by reference, &%hosts_lookup%& or
13445 otherwise) then this boolean will have been set true if, and only if, the
13446 resolver library states that both
13447 the reverse and forward DNS were authenticated data.  At all
13448 other times, this variable is false.
13449
13450 .cindex "DNS" "DNSSEC"
13451 It is likely that you will need to coerce DNSSEC support on in the resolver
13452 library, by setting:
13453 .code
13454 dns_dnssec_ok = 1
13455 .endd
13456
13457 In addition, on Linux with glibc 2.31 or newer the resolver library will
13458 default to stripping out a successful validation status.
13459 This will break a previously working Exim installation.
13460 Provided that you do trust the resolver (ie, is on localhost) you can tell
13461 glibc to pass through any successful validation with a new option in
13462 &_/etc/resolv.conf_&:
13463 .code
13464 options trust-ad
13465 .endd
13466
13467 Exim does not perform DNSSEC validation itself, instead leaving that to a
13468 validating resolver (e.g. unbound, or bind with suitable configuration).
13469
13470 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13471 mechanism in the list, then this variable will be false.
13472
13473 This requires that your system resolver library support EDNS0 (and that
13474 DNSSEC flags exist in the system headers).  If the resolver silently drops
13475 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13476 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13477
13478
13479 .vitem &$sender_host_name$&
13480 .vindex "&$sender_host_name$&"
13481 When a message is received from a remote host, this variable contains the
13482 host's name as obtained by looking up its IP address. For messages received by
13483 other means, this variable is empty.
13484
13485 .vindex "&$host_lookup_failed$&"
13486 If the host name has not previously been looked up, a reference to
13487 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13488 A looked up name is accepted only if it leads back to the original IP address
13489 via a forward lookup. If either the reverse or the forward lookup fails to find
13490 any data, or if the forward lookup does not yield the original IP address,
13491 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13492
13493 .vindex "&$host_lookup_deferred$&"
13494 However, if either of the lookups cannot be completed (for example, there is a
13495 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13496 &$host_lookup_failed$& remains set to &"0"&.
13497
13498 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13499 host name again if there is a subsequent reference to &$sender_host_name$&
13500 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13501 is set to &"1"&.
13502
13503 Exim does not automatically look up every calling host's name. If you want
13504 maximum efficiency, you should arrange your configuration so that it avoids
13505 these lookups altogether. The lookup happens only if one or more of the
13506 following are true:
13507
13508 .ilist
13509 A string containing &$sender_host_name$& is expanded.
13510 .next
13511 The calling host matches the list in &%host_lookup%&. In the default
13512 configuration, this option is set to *, so it must be changed if lookups are
13513 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13514 .next
13515 Exim needs the host name in order to test an item in a host list. The items
13516 that require this are described in sections &<<SECThoslispatnam>>& and
13517 &<<SECThoslispatnamsk>>&.
13518 .next
13519 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13520 In this case, the host name is required to compare with the name quoted in any
13521 EHLO or HELO commands that the client issues.
13522 .next
13523 The remote host issues a EHLO or HELO command that quotes one of the
13524 domains in &%helo_lookup_domains%&. The default value of this option is
13525 . ==== As this is a nested list, any displays it contains must be indented
13526 . ==== as otherwise they are too far to the left.
13527 .code
13528   helo_lookup_domains = @ : @[]
13529 .endd
13530 which causes a lookup if a remote host (incorrectly) gives the server's name or
13531 IP address in an EHLO or HELO command.
13532 .endlist
13533
13534
13535 .vitem &$sender_host_port$&
13536 .vindex "&$sender_host_port$&"
13537 When a message is received from a remote host, this variable contains the port
13538 number that was used on the remote host.
13539
13540 .vitem &$sender_ident$&
13541 .vindex "&$sender_ident$&"
13542 When a message is received from a remote host, this variable contains the
13543 identification received in response to an RFC 1413 request. When a message has
13544 been received locally, this variable contains the login name of the user that
13545 called Exim.
13546
13547 .vitem &$sender_rate_$&&'xxx'&
13548 A number of variables whose names begin &$sender_rate_$& are set as part of the
13549 &%ratelimit%& ACL condition. Details are given in section
13550 &<<SECTratelimiting>>&.
13551
13552 .vitem &$sender_rcvhost$&
13553 .cindex "DNS" "reverse lookup"
13554 .cindex "reverse DNS lookup"
13555 .vindex "&$sender_rcvhost$&"
13556 This is provided specifically for use in &'Received:'& headers. It starts with
13557 either the verified host name (as obtained from a reverse DNS lookup) or, if
13558 there is no verified host name, the IP address in square brackets. After that
13559 there may be text in parentheses. When the first item is a verified host name,
13560 the first thing in the parentheses is the IP address in square brackets,
13561 followed by a colon and a port number if port logging is enabled. When the
13562 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13563 the parentheses.
13564
13565 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13566 was used and its argument was not identical to the real host name or IP
13567 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13568 all three items are present in the parentheses, a newline and tab are inserted
13569 into the string, to improve the formatting of the &'Received:'& header.
13570
13571 .vitem &$sender_verify_failure$&
13572 .vindex "&$sender_verify_failure$&"
13573 In an ACL, when a sender verification fails, this variable contains information
13574 about the failure. The details are the same as for
13575 &$recipient_verify_failure$&.
13576
13577 .vitem &$sending_ip_address$&
13578 .vindex "&$sending_ip_address$&"
13579 This variable is set whenever an outgoing SMTP connection to another host has
13580 been set up. It contains the IP address of the local interface that is being
13581 used. This is useful if a host that has more than one IP address wants to take
13582 on different personalities depending on which one is being used. For incoming
13583 connections, see &$received_ip_address$&.
13584
13585 .vitem &$sending_port$&
13586 .vindex "&$sending_port$&"
13587 This variable is set whenever an outgoing SMTP connection to another host has
13588 been set up. It contains the local port that is being used. For incoming
13589 connections, see &$received_port$&.
13590
13591 .vitem &$smtp_active_hostname$&
13592 .vindex "&$smtp_active_hostname$&"
13593 During an incoming SMTP session, this variable contains the value of the active
13594 host name, as specified by the &%smtp_active_hostname%& option. The value of
13595 &$smtp_active_hostname$& is saved with any message that is received, so its
13596 value can be consulted during routing and delivery.
13597
13598 .vitem &$smtp_command$&
13599 .vindex "&$smtp_command$&"
13600 During the processing of an incoming SMTP command, this variable contains the
13601 entire command. This makes it possible to distinguish between HELO and EHLO in
13602 the HELO ACL, and also to distinguish between commands such as these:
13603 .code
13604 MAIL FROM:<>
13605 MAIL FROM: <>
13606 .endd
13607 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13608 command, the address in &$smtp_command$& is the original address before any
13609 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13610 the address after SMTP-time rewriting.
13611
13612 .vitem &$smtp_command_argument$&
13613 .cindex "SMTP" "command, argument for"
13614 .vindex "&$smtp_command_argument$&"
13615 While an ACL is running to check an SMTP command, this variable contains the
13616 argument, that is, the text that follows the command name, with leading white
13617 space removed. Following the introduction of &$smtp_command$&, this variable is
13618 somewhat redundant, but is retained for backwards compatibility.
13619
13620 .vitem &$smtp_command_history$&
13621 .cindex SMTP "command history"
13622 .vindex "&$smtp_command_history$&"
13623 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13624 received, in time-order left to right.  Only a limited number of commands
13625 are remembered.
13626
13627 .vitem &$smtp_count_at_connection_start$&
13628 .vindex "&$smtp_count_at_connection_start$&"
13629 This variable is set greater than zero only in processes spawned by the Exim
13630 daemon for handling incoming SMTP connections. The name is deliberately long,
13631 in order to emphasize what the contents are. When the daemon accepts a new
13632 connection, it increments this variable. A copy of the variable is passed to
13633 the child process that handles the connection, but its value is fixed, and
13634 never changes. It is only an approximation of how many incoming connections
13635 there actually are, because many other connections may come and go while a
13636 single connection is being processed. When a child process terminates, the
13637 daemon decrements its copy of the variable.
13638
13639 .vitem "&$sn0$& &-- &$sn9$&"
13640 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13641 that were current at the end of the system filter file. This allows a system
13642 filter file to set values that can be tested in users' filter files. For
13643 example, a system filter could set a value indicating how likely it is that a
13644 message is junk mail.
13645
13646 .vitem &$spam_$&&'xxx'&
13647 A number of variables whose names start with &$spam$& are available when Exim
13648 is compiled with the content-scanning extension. For details, see section
13649 &<<SECTscanspamass>>&.
13650
13651 .vitem &$spf_header_comment$& &&&
13652        &$spf_received$& &&&
13653        &$spf_result$& &&&
13654        &$spf_result_guessed$& &&&
13655        &$spf_smtp_comment$&
13656 These variables are only available if Exim is built with SPF support.
13657 For details see section &<<SECSPF>>&.
13658
13659 .vitem &$spool_directory$&
13660 .vindex "&$spool_directory$&"
13661 The name of Exim's spool directory.
13662
13663 .vitem &$spool_inodes$&
13664 .vindex "&$spool_inodes$&"
13665 The number of free inodes in the disk partition where Exim's spool files are
13666 being written. The value is recalculated whenever the variable is referenced.
13667 If the relevant file system does not have the concept of inodes, the value of
13668 is -1. See also the &%check_spool_inodes%& option.
13669
13670 .vitem &$spool_space$&
13671 .vindex "&$spool_space$&"
13672 The amount of free space (as a number of kilobytes) in the disk partition where
13673 Exim's spool files are being written. The value is recalculated whenever the
13674 variable is referenced. If the operating system does not have the ability to
13675 find the amount of free space (only true for experimental systems), the space
13676 value is -1. For example, to check in an ACL that there is at least 50
13677 megabytes free on the spool, you could write:
13678 .code
13679 condition = ${if > {$spool_space}{50000}}
13680 .endd
13681 See also the &%check_spool_space%& option.
13682
13683
13684 .vitem &$thisaddress$&
13685 .vindex "&$thisaddress$&"
13686 This variable is set only during the processing of the &%foranyaddress%&
13687 command in a filter file. Its use is explained in the description of that
13688 command, which can be found in the separate document entitled &'Exim's
13689 interfaces to mail filtering'&.
13690
13691 .vitem &$tls_in_bits$&
13692 .vindex "&$tls_in_bits$&"
13693 Contains an approximation of the TLS cipher's bit-strength
13694 on the inbound connection; the meaning of
13695 this depends upon the TLS implementation used.
13696 If TLS has not been negotiated, the value will be 0.
13697 The value of this is automatically fed into the Cyrus SASL authenticator
13698 when acting as a server, to specify the "external SSF" (a SASL term).
13699
13700 The deprecated &$tls_bits$& 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_bits$&
13705 .vindex "&$tls_out_bits$&"
13706 Contains an approximation of the TLS cipher's bit-strength
13707 on an outbound SMTP connection; the meaning of
13708 this depends upon the TLS implementation used.
13709 If TLS has not been negotiated, the value will be 0.
13710
13711 .vitem &$tls_in_ourcert$&
13712 .vindex "&$tls_in_ourcert$&"
13713 .cindex certificate variables
13714 This variable refers to the certificate presented to the peer of an
13715 inbound connection when the message was received.
13716 It is only useful as the argument of a
13717 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13718 or a &%def%& condition.
13719
13720 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13721 when a list of more than one
13722 file is used for &%tls_certificate%&, this variable is not reliable.
13723 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13724
13725 .vitem &$tls_in_peercert$&
13726 .vindex "&$tls_in_peercert$&"
13727 This variable refers to the certificate presented by the peer of an
13728 inbound connection when the message was received.
13729 It is only useful as the argument of a
13730 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13731 or a &%def%& condition.
13732 If certificate verification fails it may refer to a failing chain element
13733 which is not the leaf.
13734
13735 .vitem &$tls_out_ourcert$&
13736 .vindex "&$tls_out_ourcert$&"
13737 This variable refers to the certificate presented to the peer of an
13738 outbound connection.  It is only useful as the argument of a
13739 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13740 or a &%def%& condition.
13741
13742 .vitem &$tls_out_peercert$&
13743 .vindex "&$tls_out_peercert$&"
13744 This variable refers to the certificate presented by the peer of an
13745 outbound connection.  It is only useful as the argument of a
13746 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13747 or a &%def%& condition.
13748 If certificate verification fails it may refer to a failing chain element
13749 which is not the leaf.
13750
13751 .vitem &$tls_in_certificate_verified$&
13752 .vindex "&$tls_in_certificate_verified$&"
13753 This variable is set to &"1"& if a TLS certificate was verified when the
13754 message was received, and &"0"& otherwise.
13755
13756 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13757 except when used in the context of an outbound SMTP delivery, when it refers to
13758 the outbound.
13759
13760 .vitem &$tls_out_certificate_verified$&
13761 .vindex "&$tls_out_certificate_verified$&"
13762 This variable is set to &"1"& if a TLS certificate was verified when an
13763 outbound SMTP connection was made,
13764 and &"0"& otherwise.
13765
13766 .vitem &$tls_in_cipher$&
13767 .vindex "&$tls_in_cipher$&"
13768 .vindex "&$tls_cipher$&"
13769 When a message is received from a remote host over an encrypted SMTP
13770 connection, this variable is set to the cipher suite that was negotiated, for
13771 example DES-CBC3-SHA. In other circumstances, in particular, for message
13772 received over unencrypted connections, the variable is empty. Testing
13773 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13774 non-encrypted connections during ACL processing.
13775
13776 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13777 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13778 becomes the same as &$tls_out_cipher$&.
13779
13780 .vitem &$tls_in_cipher_std$&
13781 .vindex "&$tls_in_cipher_std$&"
13782 As above, but returning the RFC standard name for the cipher suite.
13783
13784 .vitem &$tls_out_cipher$&
13785 .vindex "&$tls_out_cipher$&"
13786 This variable is
13787 cleared before any outgoing SMTP connection is made,
13788 and then set to the outgoing cipher suite if one is negotiated. See chapter
13789 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13790 details of the &(smtp)& transport.
13791
13792 .vitem &$tls_out_cipher_std$&
13793 .vindex "&$tls_out_cipher_std$&"
13794 As above, but returning the RFC standard name for the cipher suite.
13795
13796 .vitem &$tls_out_dane$&
13797 .vindex &$tls_out_dane$&
13798 DANE active status.  See section &<<SECDANE>>&.
13799
13800 .vitem &$tls_in_ocsp$&
13801 .vindex "&$tls_in_ocsp$&"
13802 When a message is received from a remote client connection
13803 the result of any OCSP request from the client is encoded in this variable:
13804 .code
13805 0 OCSP proof was not requested (default value)
13806 1 No response to request
13807 2 Response not verified
13808 3 Verification failed
13809 4 Verification succeeded
13810 .endd
13811
13812 .vitem &$tls_out_ocsp$&
13813 .vindex "&$tls_out_ocsp$&"
13814 When a message is sent to a remote host connection
13815 the result of any OCSP request made is encoded in this variable.
13816 See &$tls_in_ocsp$& for values.
13817
13818 .vitem &$tls_in_peerdn$&
13819 .vindex "&$tls_in_peerdn$&"
13820 .vindex "&$tls_peerdn$&"
13821 .cindex certificate "extracting fields"
13822 When a message is received from a remote host over an encrypted SMTP
13823 connection, and Exim is configured to request a certificate from the client,
13824 the value of the Distinguished Name of the certificate is made available in the
13825 &$tls_in_peerdn$& during subsequent processing.
13826 If certificate verification fails it may refer to a failing chain element
13827 which is not the leaf.
13828
13829 The deprecated &$tls_peerdn$& variable refers to the inbound side
13830 except when used in the context of an outbound SMTP delivery, when it refers to
13831 the outbound.
13832
13833 .vitem &$tls_out_peerdn$&
13834 .vindex "&$tls_out_peerdn$&"
13835 When a message is being delivered to a remote host over an encrypted SMTP
13836 connection, and Exim is configured to request a certificate from the server,
13837 the value of the Distinguished Name of the certificate is made available in the
13838 &$tls_out_peerdn$& during subsequent processing.
13839 If certificate verification fails it may refer to a failing chain element
13840 which is not the leaf.
13841
13842
13843 .new
13844 .vitem &$tls_in_resumption$& &&&
13845        &$tls_out_resumption$&
13846 .vindex &$tls_in_resumption$&
13847 .vindex &$tls_out_resumption$&
13848 .cindex TLS resumption
13849 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13850 .wen
13851
13852
13853 .vitem &$tls_in_sni$&
13854 .vindex "&$tls_in_sni$&"
13855 .vindex "&$tls_sni$&"
13856 .cindex "TLS" "Server Name Indication"
13857 .cindex "TLS" SNI
13858 .cindex SNI "observability on server"
13859 When a TLS session is being established, if the client sends the Server
13860 Name Indication extension, the value will be placed in this variable.
13861 If the variable appears in &%tls_certificate%& then this option and
13862 some others, described in &<<SECTtlssni>>&,
13863 will be re-expanded early in the TLS session, to permit
13864 a different certificate to be presented (and optionally a different key to be
13865 used) to the client, based upon the value of the SNI extension.
13866
13867 The deprecated &$tls_sni$& variable refers to the inbound side
13868 except when used in the context of an outbound SMTP delivery, when it refers to
13869 the outbound.
13870
13871 .vitem &$tls_out_sni$&
13872 .vindex "&$tls_out_sni$&"
13873 .cindex "TLS" "Server Name Indication"
13874 .cindex "TLS" SNI
13875 .cindex SNI "observability in client"
13876 During outbound
13877 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13878 the transport.
13879
13880 .vitem &$tls_out_tlsa_usage$&
13881 .vindex &$tls_out_tlsa_usage$&
13882 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13883
13884 .vitem &$tls_in_ver$&
13885 .vindex "&$tls_in_ver$&"
13886 When a message is received from a remote host over an encrypted SMTP connection
13887 this variable is set to the protocol version, eg &'TLS1.2'&.
13888
13889 .vitem &$tls_out_ver$&
13890 .vindex "&$tls_out_ver$&"
13891 When a message is being delivered to a remote host over an encrypted SMTP connection
13892 this variable is set to the protocol version.
13893
13894
13895 .vitem &$tod_bsdinbox$&
13896 .vindex "&$tod_bsdinbox$&"
13897 The time of day and the date, in the format required for BSD-style mailbox
13898 files, for example: Thu Oct 17 17:14:09 1995.
13899
13900 .vitem &$tod_epoch$&
13901 .vindex "&$tod_epoch$&"
13902 The time and date as a number of seconds since the start of the Unix epoch.
13903
13904 .vitem &$tod_epoch_l$&
13905 .vindex "&$tod_epoch_l$&"
13906 The time and date as a number of microseconds since the start of the Unix epoch.
13907
13908 .vitem &$tod_full$&
13909 .vindex "&$tod_full$&"
13910 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13911 +0100. The timezone is always given as a numerical offset from UTC, with
13912 positive values used for timezones that are ahead (east) of UTC, and negative
13913 values for those that are behind (west).
13914
13915 .vitem &$tod_log$&
13916 .vindex "&$tod_log$&"
13917 The time and date in the format used for writing Exim's log files, for example:
13918 1995-10-12 15:32:29, but without a timezone.
13919
13920 .vitem &$tod_logfile$&
13921 .vindex "&$tod_logfile$&"
13922 This variable contains the date in the format yyyymmdd. This is the format that
13923 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13924 flag.
13925
13926 .vitem &$tod_zone$&
13927 .vindex "&$tod_zone$&"
13928 This variable contains the numerical value of the local timezone, for example:
13929 -0500.
13930
13931 .vitem &$tod_zulu$&
13932 .vindex "&$tod_zulu$&"
13933 This variable contains the UTC date and time in &"Zulu"& format, as specified
13934 by ISO 8601, for example: 20030221154023Z.
13935
13936 .vitem &$transport_name$&
13937 .cindex "transport" "name"
13938 .cindex "name" "of transport"
13939 .vindex "&$transport_name$&"
13940 During the running of a transport, this variable contains its name.
13941
13942 .vitem &$value$&
13943 .vindex "&$value$&"
13944 This variable contains the result of an expansion lookup, extraction operation,
13945 or external command, as described above. It is also used during a
13946 &*reduce*& expansion.
13947
13948 .vitem &$verify_mode$&
13949 .vindex "&$verify_mode$&"
13950 While a router or transport is being run in verify mode or for cutthrough delivery,
13951 contains "S" for sender-verification or "R" for recipient-verification.
13952 Otherwise, empty.
13953
13954 .vitem &$version_number$&
13955 .vindex "&$version_number$&"
13956 The version number of Exim. Same as &$exim_version$&, may be overridden
13957 by the &%exim_version%& main config option.
13958
13959 .vitem &$warn_message_delay$&
13960 .vindex "&$warn_message_delay$&"
13961 This variable is set only during the creation of a message warning about a
13962 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13963
13964 .vitem &$warn_message_recipients$&
13965 .vindex "&$warn_message_recipients$&"
13966 This variable is set only during the creation of a message warning about a
13967 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13968 .endlist
13969 .ecindex IIDstrexp
13970
13971
13972
13973 . ////////////////////////////////////////////////////////////////////////////
13974 . ////////////////////////////////////////////////////////////////////////////
13975
13976 .chapter "Embedded Perl" "CHAPperl"
13977 .scindex IIDperl "Perl" "calling from Exim"
13978 Exim can be built to include an embedded Perl interpreter. When this is done,
13979 Perl subroutines can be called as part of the string expansion process. To make
13980 use of the Perl support, you need version 5.004 or later of Perl installed on
13981 your system. To include the embedded interpreter in the Exim binary, include
13982 the line
13983 .code
13984 EXIM_PERL = perl.o
13985 .endd
13986 in your &_Local/Makefile_& and then build Exim in the normal way.
13987
13988
13989 .section "Setting up so Perl can be used" "SECID85"
13990 .oindex "&%perl_startup%&"
13991 Access to Perl subroutines is via a global configuration option called
13992 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13993 no &%perl_startup%& option in the Exim configuration file then no Perl
13994 interpreter is started and there is almost no overhead for Exim (since none of
13995 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13996 option then the associated value is taken to be Perl code which is executed in
13997 a newly created Perl interpreter.
13998
13999 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14000 need backslashes before any characters to escape special meanings. The option
14001 should usually be something like
14002 .code
14003 perl_startup = do '/etc/exim.pl'
14004 .endd
14005 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14006 use from Exim. Exim can be configured either to start up a Perl interpreter as
14007 soon as it is entered, or to wait until the first time it is needed. Starting
14008 the interpreter at the beginning ensures that it is done while Exim still has
14009 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14010 fact used in a particular run. Also, note that this does not mean that Exim is
14011 necessarily running as root when Perl is called at a later time. By default,
14012 the interpreter is started only when it is needed, but this can be changed in
14013 two ways:
14014
14015 .ilist
14016 .oindex "&%perl_at_start%&"
14017 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14018 a startup when Exim is entered.
14019 .next
14020 The command line option &%-ps%& also requests a startup when Exim is entered,
14021 overriding the setting of &%perl_at_start%&.
14022 .endlist
14023
14024 There is also a command line option &%-pd%& (for delay) which suppresses the
14025 initial startup, even if &%perl_at_start%& is set.
14026
14027 .ilist
14028 .oindex "&%perl_taintmode%&"
14029 .cindex "Perl" "taintmode"
14030 To provide more security executing Perl code via the embedded Perl
14031 interpreter, the &%perl_taintmode%& option can be set. This enables the
14032 taint mode of the Perl interpreter. You are encouraged to set this
14033 option to a true value. To avoid breaking existing installations, it
14034 defaults to false.
14035
14036
14037 .section "Calling Perl subroutines" "SECID86"
14038 When the configuration file includes a &%perl_startup%& option you can make use
14039 of the string expansion item to call the Perl subroutines that are defined
14040 by the &%perl_startup%& code. The operator is used in any of the following
14041 forms:
14042 .code
14043 ${perl{foo}}
14044 ${perl{foo}{argument}}
14045 ${perl{foo}{argument1}{argument2} ... }
14046 .endd
14047 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14048 arguments may be passed. Passing more than this results in an expansion failure
14049 with an error message of the form
14050 .code
14051 Too many arguments passed to Perl subroutine "foo" (max is 8)
14052 .endd
14053 The return value of the Perl subroutine is evaluated in a scalar context before
14054 it is passed back to Exim to be inserted into the expanded string. If the
14055 return value is &'undef'&, the expansion is forced to fail in the same way as
14056 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14057 by obeying Perl's &%die%& function, the expansion fails with the error message
14058 that was passed to &%die%&.
14059
14060
14061 .section "Calling Exim functions from Perl" "SECID87"
14062 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14063 is available to call back into Exim's string expansion function. For example,
14064 the Perl code
14065 .code
14066 my $lp = Exim::expand_string('$local_part');
14067 .endd
14068 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14069 Note those are single quotes and not double quotes to protect against
14070 &$local_part$& being interpolated as a Perl variable.
14071
14072 If the string expansion is forced to fail by a &"fail"& item, the result of
14073 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14074 expansion string, the Perl call from the original expansion string fails with
14075 an appropriate error message, in the same way as if &%die%& were used.
14076
14077 .cindex "debugging" "from embedded Perl"
14078 .cindex "log" "writing from embedded Perl"
14079 Two other Exim functions are available for use from within Perl code.
14080 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14081 debugging is enabled. If you want a newline at the end, you must supply it.
14082 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14083 timestamp. In this case, you should not supply a terminating newline.
14084
14085
14086 .section "Use of standard output and error by Perl" "SECID88"
14087 .cindex "Perl" "standard output and error"
14088 You should not write to the standard error or output streams from within your
14089 Perl code, as it is not defined how these are set up. In versions of Exim
14090 before 4.50, it is possible for the standard output or error to refer to the
14091 SMTP connection during message reception via the daemon. Writing to this stream
14092 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14093 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14094 avoided, but the output is lost.
14095
14096 .cindex "Perl" "use of &%warn%&"
14097 The Perl &%warn%& statement writes to the standard error stream by default.
14098 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14099 you have no control. When Exim starts up the Perl interpreter, it arranges for
14100 output from the &%warn%& statement to be written to the Exim main log. You can
14101 change this by including appropriate Perl magic somewhere in your Perl code.
14102 For example, to discard &%warn%& output completely, you need this:
14103 .code
14104 $SIG{__WARN__} = sub { };
14105 .endd
14106 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14107 example, the code for the subroutine is empty, so it does nothing, but you can
14108 include any Perl code that you like. The text of the &%warn%& message is passed
14109 as the first subroutine argument.
14110 .ecindex IIDperl
14111
14112
14113 . ////////////////////////////////////////////////////////////////////////////
14114 . ////////////////////////////////////////////////////////////////////////////
14115
14116 .chapter "Starting the daemon and the use of network interfaces" &&&
14117          "CHAPinterfaces" &&&
14118          "Starting the daemon"
14119 .cindex "daemon" "starting"
14120 .cindex "interface" "listening"
14121 .cindex "network interface"
14122 .cindex "interface" "network"
14123 .cindex "IP address" "for listening"
14124 .cindex "daemon" "listening IP addresses"
14125 .cindex "TCP/IP" "setting listening interfaces"
14126 .cindex "TCP/IP" "setting listening ports"
14127 A host that is connected to a TCP/IP network may have one or more physical
14128 hardware network interfaces. Each of these interfaces may be configured as one
14129 or more &"logical"& interfaces, which are the entities that a program actually
14130 works with. Each of these logical interfaces is associated with an IP address.
14131 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14132 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14133 knowledge about the host's interfaces for use in three different circumstances:
14134
14135 .olist
14136 When a listening daemon is started, Exim needs to know which interfaces
14137 and ports to listen on.
14138 .next
14139 When Exim is routing an address, it needs to know which IP addresses
14140 are associated with local interfaces. This is required for the correct
14141 processing of MX lists by removing the local host and others with the
14142 same or higher priority values. Also, Exim needs to detect cases
14143 when an address is routed to an IP address that in fact belongs to the
14144 local host. Unless the &%self%& router option or the &%allow_localhost%&
14145 option of the smtp transport is set (as appropriate), this is treated
14146 as an error situation.
14147 .next
14148 When Exim connects to a remote host, it may need to know which interface to use
14149 for the outgoing connection.
14150 .endlist
14151
14152
14153 Exim's default behaviour is likely to be appropriate in the vast majority
14154 of cases. If your host has only one interface, and you want all its IP
14155 addresses to be treated in the same way, and you are using only the
14156 standard SMTP port, you should not need to take any special action. The
14157 rest of this chapter does not apply to you.
14158
14159 In a more complicated situation you may want to listen only on certain
14160 interfaces, or on different ports, and for this reason there are a number of
14161 options that can be used to influence Exim's behaviour. The rest of this
14162 chapter describes how they operate.
14163
14164 When a message is received over TCP/IP, the interface and port that were
14165 actually used are set in &$received_ip_address$& and &$received_port$&.
14166
14167
14168
14169 .section "Starting a listening daemon" "SECID89"
14170 When a listening daemon is started (by means of the &%-bd%& command line
14171 option), the interfaces and ports on which it listens are controlled by the
14172 following options:
14173
14174 .ilist
14175 &%daemon_smtp_ports%& contains a list of default ports
14176 or service names.
14177 (For backward compatibility, this option can also be specified in the singular.)
14178 .next
14179 &%local_interfaces%& contains list of interface IP addresses on which to
14180 listen. Each item may optionally also specify a port.
14181 .endlist
14182
14183 The default list separator in both cases is a colon, but this can be changed as
14184 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14185 it is usually best to change the separator to avoid having to double all the
14186 colons. For example:
14187 .code
14188 local_interfaces = <; 127.0.0.1 ; \
14189                       192.168.23.65 ; \
14190                       ::1 ; \
14191                       3ffe:ffff:836f::fe86:a061
14192 .endd
14193 There are two different formats for specifying a port along with an IP address
14194 in &%local_interfaces%&:
14195
14196 .olist
14197 The port is added onto the address with a dot separator. For example, to listen
14198 on port 1234 on two different IP addresses:
14199 .code
14200 local_interfaces = <; 192.168.23.65.1234 ; \
14201                       3ffe:ffff:836f::fe86:a061.1234
14202 .endd
14203 .next
14204 The IP address is enclosed in square brackets, and the port is added
14205 with a colon separator, for example:
14206 .code
14207 local_interfaces = <; [192.168.23.65]:1234 ; \
14208                       [3ffe:ffff:836f::fe86:a061]:1234
14209 .endd
14210 .endlist
14211
14212 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14213 default setting contains just one port:
14214 .code
14215 daemon_smtp_ports = smtp
14216 .endd
14217 If more than one port is listed, each interface that does not have its own port
14218 specified listens on all of them. Ports that are listed in
14219 &%daemon_smtp_ports%& can be identified either by name (defined in
14220 &_/etc/services_&) or by number. However, when ports are given with individual
14221 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14222
14223
14224
14225 .section "Special IP listening addresses" "SECID90"
14226 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14227 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14228 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14229 instead of setting up separate listening sockets for each interface. The
14230 default value of &%local_interfaces%& is
14231 .code
14232 local_interfaces = 0.0.0.0
14233 .endd
14234 when Exim is built without IPv6 support; otherwise it is:
14235 .code
14236 local_interfaces = <; ::0 ; 0.0.0.0
14237 .endd
14238 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14239
14240
14241
14242 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14243 The &%-oX%& command line option can be used to override the values of
14244 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14245 instance. Another way of doing this would be to use macros and the &%-D%&
14246 option. However, &%-oX%& can be used by any admin user, whereas modification of
14247 the runtime configuration by &%-D%& is allowed only when the caller is root or
14248 exim.
14249
14250 The value of &%-oX%& is a list of items. The default colon separator can be
14251 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14252 If there are any items that do not
14253 contain dots or colons (that is, are not IP addresses), the value of
14254 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14255 items that do contain dots or colons, the value of &%local_interfaces%& is
14256 replaced by those items. Thus, for example,
14257 .code
14258 -oX 1225
14259 .endd
14260 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14261 whereas
14262 .code
14263 -oX 192.168.34.5.1125
14264 .endd
14265 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14266 (However, since &%local_interfaces%& now contains no items without ports, the
14267 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14268
14269
14270
14271 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14272 .cindex "submissions protocol"
14273 .cindex "ssmtp protocol"
14274 .cindex "smtps protocol"
14275 .cindex "SMTP" "ssmtp protocol"
14276 .cindex "SMTP" "smtps protocol"
14277 Exim supports the use of TLS-on-connect, used by mail clients in the
14278 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14279 For some years, IETF Standards Track documents only blessed the
14280 STARTTLS-based Submission service (port 587) while common practice was to support
14281 the same feature set on port 465, but using TLS-on-connect.
14282 If your installation needs to provide service to mail clients
14283 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14284 the 465 TCP ports.
14285
14286 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14287 service names, connections to those ports must first establish TLS, before
14288 proceeding to the application layer use of the SMTP protocol.
14289
14290 The common use of this option is expected to be
14291 .code
14292 tls_on_connect_ports = 465
14293 .endd
14294 per RFC 8314.
14295 There is also a command line option &%-tls-on-connect%&, which forces all ports
14296 to behave in this way when a daemon is started.
14297
14298 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14299 daemon to listen on those ports. You must still specify them in
14300 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14301 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14302 connections via the daemon.)
14303
14304
14305
14306
14307 .section "IPv6 address scopes" "SECID92"
14308 .cindex "IPv6" "address scopes"
14309 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14310 can, in principle, have the same link-local IPv6 address on different
14311 interfaces. Thus, additional information is needed, over and above the IP
14312 address, to distinguish individual interfaces. A convention of using a
14313 percent sign followed by something (often the interface name) has been
14314 adopted in some cases, leading to addresses like this:
14315 .code
14316 fe80::202:b3ff:fe03:45c1%eth0
14317 .endd
14318 To accommodate this usage, a percent sign followed by an arbitrary string is
14319 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14320 to convert a textual IPv6 address for actual use. This function recognizes the
14321 percent convention in operating systems that support it, and it processes the
14322 address appropriately. Unfortunately, some older libraries have problems with
14323 &[getaddrinfo()]&. If
14324 .code
14325 IPV6_USE_INET_PTON=yes
14326 .endd
14327 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14328 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14329 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14330 function.) Of course, this means that the additional functionality of
14331 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14332
14333 .section "Disabling IPv6" "SECID93"
14334 .cindex "IPv6" "disabling"
14335 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14336 run on a host whose kernel does not support IPv6. The binary will fall back to
14337 using IPv4, but it may waste resources looking up AAAA records, and trying to
14338 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14339 .oindex "&%disable_ipv6%&"
14340 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14341 activities take place. AAAA records are never looked up, and any IPv6 addresses
14342 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14343 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14344 to handle IPv6 literal addresses.
14345
14346 On the other hand, when IPv6 is in use, there may be times when you want to
14347 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14348 option to globally suppress the lookup of AAAA records for specified domains,
14349 and you can use the &%ignore_target_hosts%& generic router option to ignore
14350 IPv6 addresses in an individual router.
14351
14352
14353
14354 .section "Examples of starting a listening daemon" "SECID94"
14355 The default case in an IPv6 environment is
14356 .code
14357 daemon_smtp_ports = smtp
14358 local_interfaces = <; ::0 ; 0.0.0.0
14359 .endd
14360 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14361 Either one or two sockets may be used, depending on the characteristics of
14362 the TCP/IP stack. (This is complicated and messy; for more information,
14363 read the comments in the &_daemon.c_& source file.)
14364
14365 To specify listening on ports 25 and 26 on all interfaces:
14366 .code
14367 daemon_smtp_ports = 25 : 26
14368 .endd
14369 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14370 .code
14371 local_interfaces = <; ::0.25     ; ::0.26 \
14372                       0.0.0.0.25 ; 0.0.0.0.26
14373 .endd
14374 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14375 IPv4 loopback address only:
14376 .code
14377 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14378 .endd
14379 To specify listening on the default port on specific interfaces only:
14380 .code
14381 local_interfaces = 10.0.0.67 : 192.168.34.67
14382 .endd
14383 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14384
14385
14386
14387 .section "Recognizing the local host" "SECTreclocipadd"
14388 The &%local_interfaces%& option is also used when Exim needs to determine
14389 whether or not an IP address refers to the local host. That is, the IP
14390 addresses of all the interfaces on which a daemon is listening are always
14391 treated as local.
14392
14393 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14394 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14395 available interfaces from the operating system, and extracts the relevant
14396 (that is, IPv4 or IPv6) addresses to use for checking.
14397
14398 Some systems set up large numbers of virtual interfaces in order to provide
14399 many virtual web servers. In this situation, you may want to listen for
14400 email on only a few of the available interfaces, but nevertheless treat all
14401 interfaces as local when routing. You can do this by setting
14402 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14403 &"all"& wildcard values. These addresses are recognized as local, but are not
14404 used for listening. Consider this example:
14405 .code
14406 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14407                       192.168.53.235 ; \
14408                       3ffe:2101:12:1:a00:20ff:fe86:a061
14409
14410 extra_local_interfaces = <; ::0 ; 0.0.0.0
14411 .endd
14412 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14413 address, but all available interface addresses are treated as local when
14414 Exim is routing.
14415
14416 In some environments the local host name may be in an MX list, but with an IP
14417 address that is not assigned to any local interface. In other cases it may be
14418 desirable to treat other host names as if they referred to the local host. Both
14419 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14420 This contains host names rather than IP addresses. When a host is referenced
14421 during routing, either via an MX record or directly, it is treated as the local
14422 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14423 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14424
14425
14426
14427 .section "Delivering to a remote host" "SECID95"
14428 Delivery to a remote host is handled by the smtp transport. By default, it
14429 allows the system's TCP/IP functions to choose which interface to use (if
14430 there is more than one) when connecting to a remote host. However, the
14431 &%interface%& option can be set to specify which interface is used. See the
14432 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14433 details.
14434
14435
14436
14437
14438 . ////////////////////////////////////////////////////////////////////////////
14439 . ////////////////////////////////////////////////////////////////////////////
14440
14441 .chapter "Main configuration" "CHAPmainconfig"
14442 .scindex IIDconfima "configuration file" "main section"
14443 .scindex IIDmaiconf "main configuration"
14444 The first part of the runtime configuration file contains three types of item:
14445
14446 .ilist
14447 Macro definitions: These lines start with an upper case letter. See section
14448 &<<SECTmacrodefs>>& for details of macro processing.
14449 .next
14450 Named list definitions: These lines start with one of the words &"domainlist"&,
14451 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14452 section &<<SECTnamedlists>>&.
14453 .next
14454 Main configuration settings: Each setting occupies one line of the file
14455 (with possible continuations). If any setting is preceded by the word
14456 &"hide"&, the &%-bP%& command line option displays its value to admin users
14457 only. See section &<<SECTcos>>& for a description of the syntax of these option
14458 settings.
14459 .endlist
14460
14461 This chapter specifies all the main configuration options, along with their
14462 types and default values. For ease of finding a particular option, they appear
14463 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14464 are now so many options, they are first listed briefly in functional groups, as
14465 an aid to finding the name of the option you are looking for. Some options are
14466 listed in more than one group.
14467
14468 .section "Miscellaneous" "SECID96"
14469 .table2
14470 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14471 .row &%debug_store%&                 "do extra internal checks"
14472 .row &%disable_ipv6%&                "do no IPv6 processing"
14473 .row &%keep_malformed%&              "for broken files &-- should not happen"
14474 .row &%localhost_number%&            "for unique message ids in clusters"
14475 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14476 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14477 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14478 .row &%print_topbitchars%&           "top-bit characters are printing"
14479 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14480 .row &%timezone%&                    "force time zone"
14481 .endtable
14482
14483
14484 .section "Exim parameters" "SECID97"
14485 .table2
14486 .row &%exim_group%&                  "override compiled-in value"
14487 .row &%exim_path%&                   "override compiled-in value"
14488 .row &%exim_user%&                   "override compiled-in value"
14489 .row &%primary_hostname%&            "default from &[uname()]&"
14490 .row &%split_spool_directory%&       "use multiple directories"
14491 .row &%spool_directory%&             "override compiled-in value"
14492 .endtable
14493
14494
14495
14496 .section "Privilege controls" "SECID98"
14497 .table2
14498 .row &%admin_groups%&                "groups that are Exim admin users"
14499 .row &%commandline_checks_require_admin%& "require admin for various checks"
14500 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14501 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14502 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14503 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14504 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14505 .row &%never_users%&                 "do not run deliveries as these"
14506 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14507 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14508 .row &%trusted_groups%&              "groups that are trusted"
14509 .row &%trusted_users%&               "users that are trusted"
14510 .endtable
14511
14512
14513
14514 .section "Logging" "SECID99"
14515 .table2
14516 .row &%event_action%&                "custom logging"
14517 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14518 .row &%log_file_path%&               "override compiled-in value"
14519 .row &%log_selector%&                "set/unset optional logging"
14520 .row &%log_timezone%&                "add timezone to log lines"
14521 .row &%message_logs%&                "create per-message logs"
14522 .row &%preserve_message_logs%&       "after message completion"
14523 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14524 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14525 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14526 .row &%syslog_facility%&             "set syslog &""facility""& field"
14527 .row &%syslog_pid%&                  "pid in syslog lines"
14528 .row &%syslog_processname%&          "set syslog &""ident""& field"
14529 .row &%syslog_timestamp%&            "timestamp syslog lines"
14530 .row &%write_rejectlog%&             "control use of message log"
14531 .endtable
14532
14533
14534
14535 .section "Frozen messages" "SECID100"
14536 .table2
14537 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14538 .row &%freeze_tell%&                 "send message when freezing"
14539 .row &%move_frozen_messages%&        "to another directory"
14540 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14541 .endtable
14542
14543
14544
14545 .section "Data lookups" "SECID101"
14546 .table2
14547 .row &%ibase_servers%&               "InterBase servers"
14548 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14549 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14550 .row &%ldap_cert_file%&              "client cert file for LDAP"
14551 .row &%ldap_cert_key%&               "client key file for LDAP"
14552 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14553 .row &%ldap_default_servers%&        "used if no server in query"
14554 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14555 .row &%ldap_start_tls%&              "require TLS within LDAP"
14556 .row &%ldap_version%&                "set protocol version"
14557 .row &%lookup_open_max%&             "lookup files held open"
14558 .row &%mysql_servers%&               "default MySQL servers"
14559 .row &%oracle_servers%&              "Oracle servers"
14560 .row &%pgsql_servers%&               "default PostgreSQL servers"
14561 .row &%sqlite_lock_timeout%&         "as it says"
14562 .endtable
14563
14564
14565
14566 .section "Message ids" "SECID102"
14567 .table2
14568 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14569 .row &%message_id_header_text%&      "ditto"
14570 .endtable
14571
14572
14573
14574 .section "Embedded Perl Startup" "SECID103"
14575 .table2
14576 .row &%perl_at_start%&               "always start the interpreter"
14577 .row &%perl_startup%&                "code to obey when starting Perl"
14578 .row &%perl_taintmode%&              "enable taint mode in Perl"
14579 .endtable
14580
14581
14582
14583 .section "Daemon" "SECID104"
14584 .table2
14585 .row &%daemon_smtp_ports%&           "default ports"
14586 .row &%daemon_startup_retries%&      "number of times to retry"
14587 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14588 .row &%extra_local_interfaces%&      "not necessarily listened on"
14589 .row &%local_interfaces%&            "on which to listen, with optional ports"
14590 .row &%notifier_socket%&             "override compiled-in value"
14591 .row &%pid_file_path%&               "override compiled-in value"
14592 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14593 .endtable
14594
14595
14596
14597 .section "Resource control" "SECID105"
14598 .table2
14599 .row &%check_log_inodes%&            "before accepting a message"
14600 .row &%check_log_space%&             "before accepting a message"
14601 .row &%check_spool_inodes%&          "before accepting a message"
14602 .row &%check_spool_space%&           "before accepting a message"
14603 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14604 .row &%queue_only_load%&             "queue incoming if load high"
14605 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14606 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14607 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14608 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14609 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14610 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14611 .row &%smtp_accept_max_per_connection%& "messages per connection"
14612 .row &%smtp_accept_max_per_host%&    "connections from one host"
14613 .row &%smtp_accept_queue%&           "queue mail if more connections"
14614 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14615                                            connection"
14616 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14617 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14618 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14619 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14620 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14621 .endtable
14622
14623
14624
14625 .section "Policy controls" "SECID106"
14626 .table2
14627 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14628 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14629 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14630 .row &%acl_smtp_auth%&               "ACL for AUTH"
14631 .row &%acl_smtp_connect%&            "ACL for connection"
14632 .row &%acl_smtp_data%&               "ACL for DATA"
14633 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14634 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14635 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14636 .row &%acl_smtp_expn%&               "ACL for EXPN"
14637 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14638 .row &%acl_smtp_mail%&               "ACL for MAIL"
14639 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14640 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14641 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14642 .row &%acl_smtp_predata%&            "ACL for start of data"
14643 .row &%acl_smtp_quit%&               "ACL for QUIT"
14644 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14645 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14646 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14647 .row &%av_scanner%&                  "specify virus scanner"
14648 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14649                                       words""&"
14650 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14651 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14652 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14653 .row &%header_maxsize%&              "total size of message header"
14654 .row &%header_line_maxsize%&         "individual header line limit"
14655 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14656 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14657 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14658 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14659 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14660 .row &%host_lookup%&                 "host name looked up for these hosts"
14661 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14662 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14663 .row &%host_reject_connection%&      "reject connection from these hosts"
14664 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14665 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14666 .row &%message_size_limit%&          "for all messages"
14667 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14668 .row &%spamd_address%&               "set interface to SpamAssassin"
14669 .row &%strict_acl_vars%&             "object to unset ACL variables"
14670 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14671 .endtable
14672
14673
14674
14675 .section "Callout cache" "SECID107"
14676 .table2
14677 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14678                                          item"
14679 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14680                                          item"
14681 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14682 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14683 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14684 .endtable
14685
14686
14687
14688 .section "TLS" "SECID108"
14689 .table2
14690 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14691 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14692 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14693 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14694 .row &%tls_certificate%&             "location of server certificate"
14695 .row &%tls_crl%&                     "certificate revocation list"
14696 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14697 .row &%tls_dhparam%&                 "DH parameters for server"
14698 .row &%tls_eccurve%&                 "EC curve selection for server"
14699 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14700 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14701 .row &%tls_privatekey%&              "location of server private key"
14702 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14703 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14704 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14705 .row &%tls_verify_certificates%&     "expected client certificates"
14706 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14707 .endtable
14708
14709
14710
14711 .section "Local user handling" "SECID109"
14712 .table2
14713 .row &%finduser_retries%&            "useful in NIS environments"
14714 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14715 .row &%gecos_pattern%&               "ditto"
14716 .row &%max_username_length%&         "for systems that truncate"
14717 .row &%unknown_login%&               "used when no login name found"
14718 .row &%unknown_username%&            "ditto"
14719 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14720 .row &%uucp_from_sender%&            "ditto"
14721 .endtable
14722
14723
14724
14725 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14726 .table2
14727 .row &%header_maxsize%&              "total size of message header"
14728 .row &%header_line_maxsize%&         "individual header line limit"
14729 .row &%message_size_limit%&          "applies to all messages"
14730 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14731 .row &%received_header_text%&        "expanded to make &'Received:'&"
14732 .row &%received_headers_max%&        "for mail loop detection"
14733 .row &%recipients_max%&              "limit per message"
14734 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14735 .endtable
14736
14737
14738
14739
14740 .section "Non-SMTP incoming messages" "SECID111"
14741 .table2
14742 .row &%receive_timeout%&             "for non-SMTP messages"
14743 .endtable
14744
14745
14746
14747
14748
14749 .section "Incoming SMTP messages" "SECID112"
14750 See also the &'Policy controls'& section above.
14751
14752 .table2
14753 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14754 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14755 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14756 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14757 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14758 .row &%dmarc_history_file%&          "DMARC results log"
14759 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14760 .row &%host_lookup%&                 "host name looked up for these hosts"
14761 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14762 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14763 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14764 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14765 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14766 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14767 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14768 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14769 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14770 .row &%smtp_accept_max_per_connection%& "messages per connection"
14771 .row &%smtp_accept_max_per_host%&    "connections from one host"
14772 .row &%smtp_accept_queue%&           "queue mail if more connections"
14773 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14774                                            connection"
14775 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14776 .row &%smtp_active_hostname%&        "host name to use in messages"
14777 .row &%smtp_banner%&                 "text for welcome banner"
14778 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14779 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14780 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14781 .row &%smtp_etrn_command%&           "what to run for ETRN"
14782 .row &%smtp_etrn_serialize%&         "only one at once"
14783 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14784 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14785 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14786 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14787 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14788 .row &%smtp_receive_timeout%&        "per command or data line"
14789 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14790 .row &%smtp_return_error_details%&   "give detail on rejections"
14791 .endtable
14792
14793
14794
14795 .section "SMTP extensions" "SECID113"
14796 .table2
14797 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14798 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14799 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14800 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14801 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14802 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14803 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14804 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14805 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14806 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14807 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14808 .endtable
14809
14810
14811
14812 .section "Processing messages" "SECID114"
14813 .table2
14814 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14815 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14816 .row &%allow_utf8_domains%&          "in addresses"
14817 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14818                                       words""&"
14819 .row &%delivery_date_remove%&        "from incoming messages"
14820 .row &%envelope_to_remove%&          "from incoming messages"
14821 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14822 .row &%headers_charset%&             "default for translations"
14823 .row &%qualify_domain%&              "default for senders"
14824 .row &%qualify_recipient%&           "default for recipients"
14825 .row &%return_path_remove%&          "from incoming messages"
14826 .row &%strip_excess_angle_brackets%& "in addresses"
14827 .row &%strip_trailing_dot%&          "at end of addresses"
14828 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14829 .endtable
14830
14831
14832
14833 .section "System filter" "SECID115"
14834 .table2
14835 .row &%system_filter%&               "locate system filter"
14836 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14837                                             directory"
14838 .row &%system_filter_file_transport%& "transport for delivery to a file"
14839 .row &%system_filter_group%&         "group for filter running"
14840 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14841 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14842 .row &%system_filter_user%&          "user for filter running"
14843 .endtable
14844
14845
14846
14847 .section "Routing and delivery" "SECID116"
14848 .table2
14849 .row &%disable_ipv6%&                "do no IPv6 processing"
14850 .row &%dns_again_means_nonexist%&    "for broken domains"
14851 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14852 .row &%dns_dnssec_ok%&               "parameter for resolver"
14853 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14854 .row &%dns_retrans%&                 "parameter for resolver"
14855 .row &%dns_retry%&                   "parameter for resolver"
14856 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14857 .row &%dns_use_edns0%&               "parameter for resolver"
14858 .row &%hold_domains%&                "hold delivery for these domains"
14859 .row &%local_interfaces%&            "for routing checks"
14860 .row &%queue_domains%&               "no immediate delivery for these"
14861 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14862 .row &%queue_only%&                  "no immediate delivery at all"
14863 .row &%queue_only_file%&             "no immediate delivery if file exists"
14864 .row &%queue_only_load%&             "no immediate delivery if load is high"
14865 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14866 .row &%queue_only_override%&         "allow command line to override"
14867 .row &%queue_run_in_order%&          "order of arrival"
14868 .row &%queue_run_max%&               "of simultaneous queue runners"
14869 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14870 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14871 .row &%remote_sort_domains%&         "order of remote deliveries"
14872 .row &%retry_data_expire%&           "timeout for retry data"
14873 .row &%retry_interval_max%&          "safety net for retry rules"
14874 .endtable
14875
14876
14877
14878 .section "Bounce and warning messages" "SECID117"
14879 .table2
14880 .row &%bounce_message_file%&         "content of bounce"
14881 .row &%bounce_message_text%&         "content of bounce"
14882 .row &%bounce_return_body%&          "include body if returning message"
14883 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14884 .row &%bounce_return_message%&       "include original message in bounce"
14885 .row &%bounce_return_size_limit%&    "limit on returned message"
14886 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14887 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14888 .row &%errors_copy%&                 "copy bounce messages"
14889 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14890 .row &%delay_warning%&               "time schedule"
14891 .row &%delay_warning_condition%&     "condition for warning messages"
14892 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14893 .row &%smtp_return_error_details%&   "give detail on rejections"
14894 .row &%warn_message_file%&           "content of warning message"
14895 .endtable
14896
14897
14898
14899 .section "Alphabetical list of main options" "SECTalomo"
14900 Those options that undergo string expansion before use are marked with
14901 &dagger;.
14902
14903 .option accept_8bitmime main boolean true
14904 .cindex "8BITMIME"
14905 .cindex "8-bit characters"
14906 .cindex "log" "selectors"
14907 .cindex "log" "8BITMIME"
14908 .cindex "ESMTP extensions" 8BITMIME
14909 This option causes Exim to send 8BITMIME in its response to an SMTP
14910 EHLO command, and to accept the BODY= parameter on MAIL commands.
14911 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14912 takes no steps to do anything special with messages received by this route.
14913
14914 Historically Exim kept this option off by default, but the maintainers
14915 feel that in today's Internet, this causes more problems than it solves.
14916 It now defaults to true.
14917 A more detailed analysis of the issues is provided by Dan Bernstein:
14918 .display
14919 &url(https://cr.yp.to/smtp/8bitmime.html)
14920 .endd
14921
14922 To log received 8BITMIME status use
14923 .code
14924 log_selector = +8bitmime
14925 .endd
14926
14927 .option acl_not_smtp main string&!! unset
14928 .cindex "&ACL;" "for non-SMTP messages"
14929 .cindex "non-SMTP messages" "ACLs for"
14930 This option defines the ACL that is run when a non-SMTP message has been
14931 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14932 further details.
14933
14934 .option acl_not_smtp_mime main string&!! unset
14935 This option defines the ACL that is run for individual MIME parts of non-SMTP
14936 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14937 SMTP messages.
14938
14939 .option acl_not_smtp_start main string&!! unset
14940 .cindex "&ACL;" "at start of non-SMTP message"
14941 .cindex "non-SMTP messages" "ACLs for"
14942 This option defines the ACL that is run before Exim starts reading a
14943 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14944
14945 .option acl_smtp_auth main string&!! unset
14946 .cindex "&ACL;" "setting up for SMTP commands"
14947 .cindex "AUTH" "ACL for"
14948 This option defines the ACL that is run when an SMTP AUTH command is
14949 received. See chapter &<<CHAPACL>>& for further details.
14950
14951 .option acl_smtp_connect main string&!! unset
14952 .cindex "&ACL;" "on SMTP connection"
14953 This option defines the ACL that is run when an SMTP connection is received.
14954 See chapter &<<CHAPACL>>& for further details.
14955
14956 .option acl_smtp_data main string&!! unset
14957 .cindex "DATA" "ACL for"
14958 This option defines the ACL that is run after an SMTP DATA command has been
14959 processed and the message itself has been received, but before the final
14960 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14961
14962 .option acl_smtp_data_prdr main string&!! accept
14963 .cindex "PRDR" "ACL for"
14964 .cindex "DATA" "PRDR ACL for"
14965 .cindex "&ACL;" "PRDR-related"
14966 .cindex "&ACL;" "per-user data processing"
14967 This option defines the ACL that,
14968 if the PRDR feature has been negotiated,
14969 is run for each recipient after an SMTP DATA command has been
14970 processed and the message itself has been received, but before the
14971 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14972
14973 .option acl_smtp_dkim main string&!! unset
14974 .cindex DKIM "ACL for"
14975 This option defines the ACL that is run for each DKIM signature
14976 (by default, or as specified in the dkim_verify_signers option)
14977 of a received message.
14978 See section &<<SECDKIMVFY>>& for further details.
14979
14980 .option acl_smtp_etrn main string&!! unset
14981 .cindex "ETRN" "ACL for"
14982 This option defines the ACL that is run when an SMTP ETRN command is
14983 received. See chapter &<<CHAPACL>>& for further details.
14984
14985 .option acl_smtp_expn main string&!! unset
14986 .cindex "EXPN" "ACL for"
14987 This option defines the ACL that is run when an SMTP EXPN command is
14988 received. See chapter &<<CHAPACL>>& for further details.
14989
14990 .option acl_smtp_helo main string&!! unset
14991 .cindex "EHLO" "ACL for"
14992 .cindex "HELO" "ACL for"
14993 This option defines the ACL that is run when an SMTP EHLO or HELO
14994 command is received. See chapter &<<CHAPACL>>& for further details.
14995
14996
14997 .option acl_smtp_mail main string&!! unset
14998 .cindex "MAIL" "ACL for"
14999 This option defines the ACL that is run when an SMTP MAIL command is
15000 received. See chapter &<<CHAPACL>>& for further details.
15001
15002 .option acl_smtp_mailauth main string&!! unset
15003 .cindex "AUTH" "on MAIL command"
15004 This option defines the ACL that is run when there is an AUTH parameter on
15005 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15006 &<<CHAPSMTPAUTH>>& for details of authentication.
15007
15008 .option acl_smtp_mime main string&!! unset
15009 .cindex "MIME content scanning" "ACL for"
15010 This option is available when Exim is built with the content-scanning
15011 extension. It defines the ACL that is run for each MIME part in a message. See
15012 section &<<SECTscanmimepart>>& for details.
15013
15014 .option acl_smtp_notquit main string&!! unset
15015 .cindex "not-QUIT, ACL for"
15016 This option defines the ACL that is run when an SMTP session
15017 ends without a QUIT command being received.
15018 See chapter &<<CHAPACL>>& for further details.
15019
15020 .option acl_smtp_predata main string&!! unset
15021 This option defines the ACL that is run when an SMTP DATA command is
15022 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15023 further details.
15024
15025 .option acl_smtp_quit main string&!! unset
15026 .cindex "QUIT, ACL for"
15027 This option defines the ACL that is run when an SMTP QUIT command is
15028 received. See chapter &<<CHAPACL>>& for further details.
15029
15030 .option acl_smtp_rcpt main string&!! unset
15031 .cindex "RCPT" "ACL for"
15032 This option defines the ACL that is run when an SMTP RCPT command is
15033 received. See chapter &<<CHAPACL>>& for further details.
15034
15035 .option acl_smtp_starttls main string&!! unset
15036 .cindex "STARTTLS, ACL for"
15037 This option defines the ACL that is run when an SMTP STARTTLS command is
15038 received. See chapter &<<CHAPACL>>& for further details.
15039
15040 .option acl_smtp_vrfy main string&!! unset
15041 .cindex "VRFY" "ACL for"
15042 This option defines the ACL that is run when an SMTP VRFY command is
15043 received. See chapter &<<CHAPACL>>& for further details.
15044
15045 .option add_environment main "string list" empty
15046 .cindex "environment" "set values"
15047 This option adds individual environment variables that the
15048 currently linked libraries and programs in child processes may use.
15049 Each list element should be of the form &"name=value"&.
15050
15051 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15052
15053 .option admin_groups main "string list&!!" unset
15054 .cindex "admin user"
15055 This option is expanded just once, at the start of Exim's processing. If the
15056 current group or any of the supplementary groups of an Exim caller is in this
15057 colon-separated list, the caller has admin privileges. If all your system
15058 programmers are in a specific group, for example, you can give them all Exim
15059 admin privileges by putting that group in &%admin_groups%&. However, this does
15060 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15061 To permit this, you have to add individuals to the Exim group.
15062
15063 .option allow_domain_literals main boolean false
15064 .cindex "domain literal"
15065 If this option is set, the RFC 2822 domain literal format is permitted in
15066 email addresses. The option is not set by default, because the domain literal
15067 format is not normally required these days, and few people know about it. It
15068 has, however, been exploited by mail abusers.
15069
15070 Unfortunately, it seems that some DNS black list maintainers are using this
15071 format to report black listing to postmasters. If you want to accept messages
15072 addressed to your hosts by IP address, you need to set
15073 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15074 domains (defined in the named domain list &%local_domains%& in the default
15075 configuration). This &"magic string"& matches the domain literal form of all
15076 the local host's IP addresses.
15077
15078
15079 .option allow_mx_to_ip main boolean false
15080 .cindex "MX record" "pointing to IP address"
15081 It appears that more and more DNS zone administrators are breaking the rules
15082 and putting domain names that look like IP addresses on the right hand side of
15083 MX records. Exim follows the rules and rejects this, giving an error message
15084 that explains the misconfiguration. However, some other MTAs support this
15085 practice, so to avoid &"Why can't Exim do this?"& complaints,
15086 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15087 recommended, except when you have no other choice.
15088
15089 .option allow_utf8_domains main boolean false
15090 .cindex "domain" "UTF-8 characters in"
15091 .cindex "UTF-8" "in domain name"
15092 Lots of discussion is going on about internationalized domain names. One
15093 camp is strongly in favour of just using UTF-8 characters, and it seems
15094 that at least two other MTAs permit this.
15095 This option allows Exim users to experiment if they wish.
15096
15097 If it is set true, Exim's domain parsing function allows valid
15098 UTF-8 multicharacters to appear in domain name components, in addition to
15099 letters, digits, and hyphens.
15100
15101 If Exim is built with internationalization support
15102 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15103 this option can be left as default.
15104 Without that,
15105 if you want to look up such domain names in the DNS, you must also
15106 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15107 suitable setting is:
15108 .code
15109 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15110   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15111 .endd
15112 Alternatively, you can just disable this feature by setting
15113 .code
15114 dns_check_names_pattern =
15115 .endd
15116 That is, set the option to an empty string so that no check is done.
15117
15118
15119 .option auth_advertise_hosts main "host list&!!" *
15120 .cindex "authentication" "advertising"
15121 .cindex "AUTH" "advertising"
15122 .cindex "ESMTP extensions" AUTH
15123 If any server authentication mechanisms are configured, Exim advertises them in
15124 response to an EHLO command only if the calling host matches this list.
15125 Otherwise, Exim does not advertise AUTH.
15126 Exim does not accept AUTH commands from clients to which it has not
15127 advertised the availability of AUTH. The advertising of individual
15128 authentication mechanisms can be controlled by the use of the
15129 &%server_advertise_condition%& generic authenticator option on the individual
15130 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15131
15132 Certain mail clients (for example, Netscape) require the user to provide a name
15133 and password for authentication if AUTH is advertised, even though it may
15134 not be needed (the host may accept messages from hosts on its local LAN without
15135 authentication, for example). The &%auth_advertise_hosts%& option can be used
15136 to make these clients more friendly by excluding them from the set of hosts to
15137 which Exim advertises AUTH.
15138
15139 .cindex "AUTH" "advertising when encrypted"
15140 If you want to advertise the availability of AUTH only when the connection
15141 is encrypted using TLS, you can make use of the fact that the value of this
15142 option is expanded, with a setting like this:
15143 .code
15144 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15145 .endd
15146 .vindex "&$tls_in_cipher$&"
15147 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15148 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15149 expansion is *, which matches all hosts.
15150
15151
15152 .option auto_thaw main time 0s
15153 .cindex "thawing messages"
15154 .cindex "unfreezing messages"
15155 If this option is set to a time greater than zero, a queue runner will try a
15156 new delivery attempt on any frozen message, other than a bounce message, if
15157 this much time has passed since it was frozen. This may result in the message
15158 being re-frozen if nothing has changed since the last attempt. It is a way of
15159 saying &"keep on trying, even though there are big problems"&.
15160
15161 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15162 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15163 thought to be very useful any more, and its use should probably be avoided.
15164
15165
15166 .option av_scanner main string "see below"
15167 This option is available if Exim is built with the content-scanning extension.
15168 It specifies which anti-virus scanner to use. The default value is:
15169 .code
15170 sophie:/var/run/sophie
15171 .endd
15172 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15173 before use. See section &<<SECTscanvirus>>& for further details.
15174
15175
15176 .option bi_command main string unset
15177 .oindex "&%-bi%&"
15178 This option supplies the name of a command that is run when Exim is called with
15179 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15180 just the command name, it is not a complete command line. If an argument is
15181 required, it must come from the &%-oA%& command line option.
15182
15183
15184 .option bounce_message_file main string&!! unset
15185 .cindex "bounce message" "customizing"
15186 .cindex "customizing" "bounce message"
15187 This option defines a template file containing paragraphs of text to be used
15188 for constructing bounce messages.  Details of the file's contents are given in
15189 chapter &<<CHAPemsgcust>>&.
15190 .cindex bounce_message_file "tainted data"
15191 The option is expanded to give the file path, which must be
15192 absolute and untainted.
15193 See also &%warn_message_file%&.
15194
15195
15196 .option bounce_message_text main string unset
15197 When this option is set, its contents are included in the default bounce
15198 message immediately after &"This message was created automatically by mail
15199 delivery software."& It is not used if &%bounce_message_file%& is set.
15200
15201 .option bounce_return_body main boolean true
15202 .cindex "bounce message" "including body"
15203 This option controls whether the body of an incoming message is included in a
15204 bounce message when &%bounce_return_message%& is true. The default setting
15205 causes the entire message, both header and body, to be returned (subject to the
15206 value of &%bounce_return_size_limit%&). If this option is false, only the
15207 message header is included. In the case of a non-SMTP message containing an
15208 error that is detected during reception, only those header lines preceding the
15209 point at which the error was detected are returned.
15210 .cindex "bounce message" "including original"
15211
15212 .option bounce_return_linesize_limit main integer 998
15213 .cindex "size" "of bounce lines, limit"
15214 .cindex "bounce message" "line length limit"
15215 .cindex "limit" "bounce message line length"
15216 This option sets a limit in bytes on the line length of messages
15217 that are returned to senders due to delivery problems,
15218 when &%bounce_return_message%& is true.
15219 The default value corresponds to RFC limits.
15220 If the message being returned has lines longer than this value it is
15221 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15222
15223 The option also applies to bounces returned when an error is detected
15224 during reception of a message.
15225 In this case lines from the original are truncated.
15226
15227 The option does not apply to messages generated by an &(autoreply)& transport.
15228
15229
15230 .option bounce_return_message main boolean true
15231 If this option is set false, none of the original message is included in
15232 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15233 &%bounce_return_body%&.
15234
15235
15236 .option bounce_return_size_limit main integer 100K
15237 .cindex "size" "of bounce, limit"
15238 .cindex "bounce message" "size limit"
15239 .cindex "limit" "bounce message size"
15240 This option sets a limit in bytes on the size of messages that are returned to
15241 senders as part of bounce messages when &%bounce_return_message%& is true. The
15242 limit should be less than the value of the global &%message_size_limit%& and of
15243 any &%message_size_limit%& settings on transports, to allow for the bounce text
15244 that Exim generates. If this option is set to zero there is no limit.
15245
15246 When the body of any message that is to be included in a bounce message is
15247 greater than the limit, it is truncated, and a comment pointing this out is
15248 added at the top. The actual cutoff may be greater than the value given, owing
15249 to the use of buffering for transferring the message in chunks (typically 8K in
15250 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15251 messages.
15252
15253 .option bounce_sender_authentication main string unset
15254 .cindex "bounce message" "sender authentication"
15255 .cindex "authentication" "bounce message"
15256 .cindex "AUTH" "on bounce message"
15257 This option provides an authenticated sender address that is sent with any
15258 bounce messages generated by Exim that are sent over an authenticated SMTP
15259 connection. A typical setting might be:
15260 .code
15261 bounce_sender_authentication = mailer-daemon@my.domain.example
15262 .endd
15263 which would cause bounce messages to be sent using the SMTP command:
15264 .code
15265 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15266 .endd
15267 The value of &%bounce_sender_authentication%& must always be a complete email
15268 address.
15269
15270 .option callout_domain_negative_expire main time 3h
15271 .cindex "caching" "callout timeouts"
15272 .cindex "callout" "caching timeouts"
15273 This option specifies the expiry time for negative callout cache data for a
15274 domain. See section &<<SECTcallver>>& for details of callout verification, and
15275 section &<<SECTcallvercache>>& for details of the caching.
15276
15277
15278 .option callout_domain_positive_expire main time 7d
15279 This option specifies the expiry time for positive callout cache data for a
15280 domain. See section &<<SECTcallver>>& for details of callout verification, and
15281 section &<<SECTcallvercache>>& for details of the caching.
15282
15283
15284 .option callout_negative_expire main time 2h
15285 This option specifies the expiry time for negative callout cache data for an
15286 address. See section &<<SECTcallver>>& for details of callout verification, and
15287 section &<<SECTcallvercache>>& for details of the caching.
15288
15289
15290 .option callout_positive_expire main time 24h
15291 This option specifies the expiry time for positive callout cache data for an
15292 address. See section &<<SECTcallver>>& for details of callout verification, and
15293 section &<<SECTcallvercache>>& for details of the caching.
15294
15295
15296 .option callout_random_local_part main string&!! "see below"
15297 This option defines the &"random"& local part that can be used as part of
15298 callout verification. The default value is
15299 .code
15300 $primary_hostname-$tod_epoch-testing
15301 .endd
15302 See section &<<CALLaddparcall>>& for details of how this value is used.
15303
15304
15305 .option check_log_inodes main integer 100
15306 See &%check_spool_space%& below.
15307
15308
15309 .option check_log_space main integer 10M
15310 See &%check_spool_space%& below.
15311
15312 .oindex "&%check_rfc2047_length%&"
15313 .cindex "RFC 2047" "disabling length check"
15314 .option check_rfc2047_length main boolean true
15315 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15316 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15317 word; strings to be encoded that exceed this length are supposed to use
15318 multiple encoded words. By default, Exim does not recognize encoded words that
15319 exceed the maximum length. However, it seems that some software, in violation
15320 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15321 set false, Exim recognizes encoded words of any length.
15322
15323
15324 .option check_spool_inodes main integer 100
15325 See &%check_spool_space%& below.
15326
15327
15328 .option check_spool_space main integer 10M
15329 .cindex "checking disk space"
15330 .cindex "disk space, checking"
15331 .cindex "spool directory" "checking space"
15332 The four &%check_...%& options allow for checking of disk resources before a
15333 message is accepted.
15334
15335 .vindex "&$log_inodes$&"
15336 .vindex "&$log_space$&"
15337 .vindex "&$spool_inodes$&"
15338 .vindex "&$spool_space$&"
15339 When any of these options are nonzero, they apply to all incoming messages. If you
15340 want to apply different checks to different kinds of message, you can do so by
15341 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15342 &$spool_space$& in an ACL with appropriate additional conditions.
15343
15344
15345 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15346 either value is greater than zero, for example:
15347 .code
15348 check_spool_space = 100M
15349 check_spool_inodes = 100
15350 .endd
15351 The spool partition is the one that contains the directory defined by
15352 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15353 transit.
15354
15355 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15356 files are written if either is greater than zero. These should be set only if
15357 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15358
15359 If there is less space or fewer inodes than requested, Exim refuses to accept
15360 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15361 error response to the MAIL command. If ESMTP is in use and there was a
15362 SIZE parameter on the MAIL command, its value is added to the
15363 &%check_spool_space%& value, and the check is performed even if
15364 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15365
15366 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15367 number of kilobytes (though specified in bytes).
15368 If a non-multiple of 1024 is specified, it is rounded up.
15369
15370 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15371 failure a message is written to stderr and Exim exits with a non-zero code, as
15372 it obviously cannot send an error message of any kind.
15373
15374 There is a slight performance penalty for these checks.
15375 Versions of Exim preceding 4.88 had these disabled by default;
15376 high-rate installations confident they will never run out of resources
15377 may wish to deliberately disable them.
15378
15379 .option chunking_advertise_hosts main "host list&!!" *
15380 .cindex CHUNKING advertisement
15381 .cindex "RFC 3030" "CHUNKING"
15382 .cindex "ESMTP extensions" CHUNKING
15383 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15384 these hosts.
15385 Hosts may use the BDAT command as an alternate to DATA.
15386
15387 .option commandline_checks_require_admin main boolean &`false`&
15388 .cindex "restricting access to features"
15389 This option restricts various basic checking features to require an
15390 administrative user.
15391 This affects most of the &%-b*%& options, such as &%-be%&.
15392
15393 .option debug_store main boolean &`false`&
15394 .cindex debugging "memory corruption"
15395 .cindex memory debugging
15396 This option, when true, enables extra checking in Exim's internal memory
15397 management.  For use when a memory corruption issue is being investigated,
15398 it should normally be left as default.
15399
15400 .option daemon_smtp_ports main string &`smtp`&
15401 .cindex "port" "for daemon"
15402 .cindex "TCP/IP" "setting listening ports"
15403 This option specifies one or more default SMTP ports on which the Exim daemon
15404 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15405 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15406
15407 .option daemon_startup_retries main integer 9
15408 .cindex "daemon startup, retrying"
15409 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15410 the daemon at startup when it cannot immediately bind a listening socket
15411 (typically because the socket is already in use): &%daemon_startup_retries%&
15412 defines the number of retries after the first failure, and
15413 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15414
15415 .option daemon_startup_sleep main time 30s
15416 See &%daemon_startup_retries%&.
15417
15418 .option delay_warning main "time list" 24h
15419 .cindex "warning of delay"
15420 .cindex "delay warning, specifying"
15421 .cindex "queue" "delay warning"
15422 When a message is delayed, Exim sends a warning message to the sender at
15423 intervals specified by this option. The data is a colon-separated list of times
15424 after which to send warning messages. If the value of the option is an empty
15425 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15426 message has been in the queue for longer than the last time, the last interval
15427 between the times is used to compute subsequent warning times. For example,
15428 with
15429 .code
15430 delay_warning = 4h:8h:24h
15431 .endd
15432 the first message is sent after 4 hours, the second after 8 hours, and
15433 the third one after 24 hours. After that, messages are sent every 16 hours,
15434 because that is the interval between the last two times on the list. If you set
15435 just one time, it specifies the repeat interval. For example, with:
15436 .code
15437 delay_warning = 6h
15438 .endd
15439 messages are repeated every six hours. To stop warnings after a given time, set
15440 a very large time at the end of the list. For example:
15441 .code
15442 delay_warning = 2h:12h:99d
15443 .endd
15444 Note that the option is only evaluated at the time a delivery attempt fails,
15445 which depends on retry and queue-runner configuration.
15446 Typically retries will be configured more frequently than warning messages.
15447
15448 .option delay_warning_condition main string&!! "see below"
15449 .vindex "&$domain$&"
15450 The string is expanded at the time a warning message might be sent. If all the
15451 deferred addresses have the same domain, it is set in &$domain$& during the
15452 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15453 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15454 &"false"& (the comparison being done caselessly) then the warning message is
15455 not sent. The default is:
15456 .code
15457 delay_warning_condition = ${if or {\
15458   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15459   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15460   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15461   } {no}{yes}}
15462 .endd
15463 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15464 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15465 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15466 &"auto-replied"& in an &'Auto-Submitted:'& header.
15467
15468 .option deliver_drop_privilege main boolean false
15469 .cindex "unprivileged delivery"
15470 .cindex "delivery" "unprivileged"
15471 If this option is set true, Exim drops its root privilege at the start of a
15472 delivery process, and runs as the Exim user throughout. This severely restricts
15473 the kinds of local delivery that are possible, but is viable in certain types
15474 of configuration. There is a discussion about the use of root privilege in
15475 chapter &<<CHAPsecurity>>&.
15476
15477 .option deliver_queue_load_max main fixed-point unset
15478 .cindex "load average"
15479 .cindex "queue runner" "abandoning"
15480 When this option is set, a queue run is abandoned if the system load average
15481 becomes greater than the value of the option. The option has no effect on
15482 ancient operating systems on which Exim cannot determine the load average.
15483 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15484
15485
15486 .option delivery_date_remove main boolean true
15487 .cindex "&'Delivery-date:'& header line"
15488 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15489 message when it is delivered, in exactly the same way as &'Return-path:'& is
15490 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15491 should not be present in incoming messages, and this option causes them to be
15492 removed at the time the message is received, to avoid any problems that might
15493 occur when a delivered message is subsequently sent on to some other recipient.
15494
15495 .option disable_fsync main boolean false
15496 .cindex "&[fsync()]&, disabling"
15497 This option is available only if Exim was built with the compile-time option
15498 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15499 a runtime configuration generates an &"unknown option"& error. You should not
15500 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15501 really, really, really understand what you are doing. &'No pre-compiled
15502 distributions of Exim should ever make this option available.'&
15503
15504 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15505 updated files' data to be written to disc before continuing. Unexpected events
15506 such as crashes and power outages may cause data to be lost or scrambled.
15507 Here be Dragons. &*Beware.*&
15508
15509
15510 .option disable_ipv6 main boolean false
15511 .cindex "IPv6" "disabling"
15512 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15513 activities take place. AAAA records are never looked up, and any IPv6 addresses
15514 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15515 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15516 to handle IPv6 literal addresses.
15517
15518
15519 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15520 .cindex DKIM "selecting signature algorithms"
15521 This option gives a list of hash types which are acceptable in signatures,
15522 and an order of processing.
15523 Signatures with algorithms not in the list will be ignored.
15524
15525 Acceptable values include:
15526 .code
15527 sha1
15528 sha256
15529 sha512
15530 .endd
15531
15532 Note that the acceptance of sha1 violates RFC 8301.
15533
15534 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15535 This option gives a list of key types which are acceptable in signatures,
15536 and an order of processing.
15537 Signatures with algorithms not in the list will be ignored.
15538
15539
15540 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15541 This option gives a list of key sizes which are acceptable in signatures.
15542 The list is keyed by the algorithm type for the key; the values are in bits.
15543 Signatures with keys smaller than given by this option will fail verification.
15544
15545 The default enforces the RFC 8301 minimum key size for RSA signatures.
15546
15547 .option dkim_verify_minimal main boolean false
15548 If set to true, verification of signatures will terminate after the
15549 first success.
15550
15551 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15552 .cindex DKIM "controlling calls to the ACL"
15553 This option gives a list of DKIM domains for which the DKIM ACL is run.
15554 It is expanded after the message is received; by default it runs
15555 the ACL once for each signature in the message.
15556 See section &<<SECDKIMVFY>>&.
15557
15558
15559 .option dmarc_forensic_sender main string&!! unset
15560 .option dmarc_history_file main string unset
15561 .option dmarc_tld_file main string unset
15562 .cindex DMARC "main section options"
15563 These options control DMARC processing.
15564 See section &<<SECDMARC>>& for details.
15565
15566
15567 .option dns_again_means_nonexist main "domain list&!!" unset
15568 .cindex "DNS" "&""try again""& response; overriding"
15569 DNS lookups give a &"try again"& response for the DNS errors
15570 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15571 keep trying to deliver a message, or to give repeated temporary errors to
15572 incoming mail. Sometimes the effect is caused by a badly set up name server and
15573 may persist for a long time. If a domain which exhibits this problem matches
15574 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15575 This option should be used with care. You can make it apply to reverse lookups
15576 by a setting such as this:
15577 .code
15578 dns_again_means_nonexist = *.in-addr.arpa
15579 .endd
15580 This option applies to all DNS lookups that Exim does. It also applies when the
15581 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15582 since these are most likely to be caused by DNS lookup problems. The
15583 &(dnslookup)& router has some options of its own for controlling what happens
15584 when lookups for MX or SRV records give temporary errors. These more specific
15585 options are applied after this global option.
15586
15587 .option dns_check_names_pattern main string "see below"
15588 .cindex "DNS" "pre-check of name syntax"
15589 When this option is set to a non-empty string, it causes Exim to check domain
15590 names for characters that are not allowed in host names before handing them to
15591 the DNS resolver, because some resolvers give temporary errors for names that
15592 contain unusual characters. If a domain name contains any unwanted characters,
15593 a &"not found"& result is forced, and the resolver is not called. The check is
15594 done by matching the domain name against a regular expression, which is the
15595 value of this option. The default pattern is
15596 .code
15597 dns_check_names_pattern = \
15598   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15599 .endd
15600 which permits only letters, digits, slashes, and hyphens in components, but
15601 they must start and end with a letter or digit. Slashes are not, in fact,
15602 permitted in host names, but they are found in certain NS records (which can be
15603 accessed in Exim by using a &%dnsdb%& lookup). If you set
15604 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15605 empty string.
15606
15607 .option dns_csa_search_limit main integer 5
15608 This option controls the depth of parental searching for CSA SRV records in the
15609 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15610
15611 .option dns_csa_use_reverse main boolean true
15612 This option controls whether or not an IP address, given as a CSA domain, is
15613 reversed and looked up in the reverse DNS, as described in more detail in
15614 section &<<SECTverifyCSA>>&.
15615
15616 .option dns_cname_loops main integer 1
15617 .cindex DNS "CNAME following"
15618 This option controls the following of CNAME chains, needed if the resolver does
15619 not do it internally.
15620 As of 2018 most should, and the default can be left.
15621 If you have an ancient one, a value of 10 is likely needed.
15622
15623 The default value of one CNAME-follow is needed
15624 thanks to the observed return for an MX request,
15625 given no MX presence but a CNAME to an A, of the CNAME.
15626
15627
15628 .option dns_dnssec_ok main integer -1
15629 .cindex "DNS" "resolver options"
15630 .cindex "DNS" "DNSSEC"
15631 If this option is set to a non-negative number then Exim will initialise the
15632 DNS resolver library to either use or not use DNSSEC, overriding the system
15633 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15634
15635 If the resolver library does not support DNSSEC then this option has no effect.
15636
15637 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15638 will default to stripping out a successful validation status.
15639 This will break a previously working Exim installation.
15640 Provided that you do trust the resolver (ie, is on localhost) you can tell
15641 glibc to pass through any successful validation with a new option in
15642 &_/etc/resolv.conf_&:
15643 .code
15644 options trust-ad
15645 .endd
15646
15647
15648 .option dns_ipv4_lookup main "domain list&!!" unset
15649 .cindex "IPv6" "DNS lookup for AAAA records"
15650 .cindex "DNS" "IPv6 lookup for AAAA records"
15651 .cindex DNS "IPv6 disabling"
15652 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15653 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15654 (A records) when trying to find IP addresses for hosts, unless the host's
15655 domain matches this list.
15656
15657 This is a fudge to help with name servers that give big delays or otherwise do
15658 not work for the AAAA record type. In due course, when the world's name
15659 servers have all been upgraded, there should be no need for this option.
15660 Note that all lookups, including those done for verification, are affected;
15661 this will result in verify failure for IPv6 connections or ones using names
15662 only valid for IPv6 addresses.
15663
15664
15665 .option dns_retrans main time 0s
15666 .cindex "DNS" "resolver options"
15667 .cindex timeout "dns lookup"
15668 .cindex "DNS" timeout
15669 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15670 retransmission and retry parameters for DNS lookups. Values of zero (the
15671 defaults) leave the system default settings unchanged. The first value is the
15672 time between retries, and the second is the number of retries. It isn't
15673 totally clear exactly how these settings affect the total time a DNS lookup may
15674 take. I haven't found any documentation about timeouts on DNS lookups; these
15675 parameter values are available in the external resolver interface structure,
15676 but nowhere does it seem to describe how they are used or what you might want
15677 to set in them.
15678 See also the &%slow_lookup_log%& option.
15679
15680
15681 .option dns_retry main integer 0
15682 See &%dns_retrans%& above.
15683
15684
15685 .option dns_trust_aa main "domain list&!!" unset
15686 .cindex "DNS" "resolver options"
15687 .cindex "DNS" "DNSSEC"
15688 If this option is set then lookup results marked with the AA bit
15689 (Authoritative Answer) are trusted the same way as if they were
15690 DNSSEC-verified. The authority section's name of the answer must
15691 match with this expanded domain list.
15692
15693 Use this option only if you talk directly to a resolver that is
15694 authoritative for some zones and does not set the AD (Authentic Data)
15695 bit in the answer. Some DNS servers may have an configuration option to
15696 mark the answers from their own zones as verified (they set the AD bit).
15697 Others do not have this option. It is considered as poor practice using
15698 a resolver that is an authoritative server for some zones.
15699
15700 Use this option only if you really have to (e.g. if you want
15701 to use DANE for remote delivery to a server that is listed in the DNS
15702 zones that your resolver is authoritative for).
15703
15704 If the DNS answer packet has the AA bit set and contains resource record
15705 in the answer section, the name of the first NS record appearing in the
15706 authority section is compared against the list. If the answer packet is
15707 authoritative but the answer section is empty, the name of the first SOA
15708 record in the authoritative section is used instead.
15709
15710 .cindex "DNS" "resolver options"
15711 .option dns_use_edns0 main integer -1
15712 .cindex "DNS" "resolver options"
15713 .cindex "DNS" "EDNS0"
15714 .cindex "DNS" "OpenBSD
15715 If this option is set to a non-negative number then Exim will initialise the
15716 DNS resolver library to either use or not use EDNS0 extensions, overriding
15717 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15718 on.
15719
15720 If the resolver library does not support EDNS0 then this option has no effect.
15721
15722 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15723 means that DNSSEC will not work with Exim on that platform either, unless Exim
15724 is linked against an alternative DNS client library.
15725
15726
15727 .option drop_cr main boolean false
15728 This is an obsolete option that is now a no-op. It used to affect the way Exim
15729 handled CR and LF characters in incoming messages. What happens now is
15730 described in section &<<SECTlineendings>>&.
15731
15732 .option dsn_advertise_hosts main "host list&!!" unset
15733 .cindex "bounce messages" "success"
15734 .cindex "DSN" "success"
15735 .cindex "Delivery Status Notification" "success"
15736 .cindex "ESMTP extensions" DSN
15737 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15738 and accepted from, these hosts.
15739 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15740 and RET and ORCPT options on MAIL FROM commands.
15741 A NOTIFY=SUCCESS option requests success-DSN messages.
15742 A NOTIFY= option with no argument requests that no delay or failure DSNs
15743 are sent.
15744 &*Note*&: Supplying success-DSN messages has been criticised
15745 on privacy grounds; it can leak details of internal forwarding.
15746
15747 .option dsn_from main "string&!!" "see below"
15748 .cindex "&'From:'& header line" "in bounces"
15749 .cindex "bounce messages" "&'From:'& line, specifying"
15750 This option can be used to vary the contents of &'From:'& header lines in
15751 bounces and other automatically generated messages (&"Delivery Status
15752 Notifications"& &-- hence the name of the option). The default setting is:
15753 .code
15754 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15755 .endd
15756 The value is expanded every time it is needed. If the expansion fails, a
15757 panic is logged, and the default value is used.
15758
15759 .option envelope_to_remove main boolean true
15760 .cindex "&'Envelope-to:'& header line"
15761 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15762 message when it is delivered, in exactly the same way as &'Return-path:'& is
15763 handled. &'Envelope-to:'& records the original recipient address from the
15764 message's envelope that caused the delivery to happen. Such headers should not
15765 be present in incoming messages, and this option causes them to be removed at
15766 the time the message is received, to avoid any problems that might occur when a
15767 delivered message is subsequently sent on to some other recipient.
15768
15769
15770 .option errors_copy main "string list&!!" unset
15771 .cindex "bounce message" "copy to other address"
15772 .cindex "copy of bounce message"
15773 Setting this option causes Exim to send bcc copies of bounce messages that it
15774 generates to other addresses. &*Note*&: This does not apply to bounce messages
15775 coming from elsewhere. The value of the option is a colon-separated list of
15776 items. Each item consists of a pattern, terminated by white space, followed by
15777 a comma-separated list of email addresses. If a pattern contains spaces, it
15778 must be enclosed in double quotes.
15779
15780 Each pattern is processed in the same way as a single item in an address list
15781 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15782 the bounce message, the message is copied to the addresses on the list. The
15783 items are scanned in order, and once a matching one is found, no further items
15784 are examined. For example:
15785 .code
15786 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15787               rqps@mydomain   hostmaster@mydomain.example,\
15788                               postmaster@mydomain.example
15789 .endd
15790 .vindex "&$domain$&"
15791 .vindex "&$local_part$&"
15792 The address list is expanded before use. The expansion variables &$local_part$&
15793 and &$domain$& are set from the original recipient of the error message, and if
15794 there was any wildcard matching in the pattern, the expansion
15795 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15796 variables &$0$&, &$1$&, etc. are set in the normal way.
15797
15798
15799 .option errors_reply_to main string unset
15800 .cindex "bounce message" "&'Reply-to:'& in"
15801 By default, Exim's bounce and delivery warning messages contain the header line
15802 .display
15803 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15804 .endd
15805 .oindex &%quota_warn_message%&
15806 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15807 A warning message that is generated by the &%quota_warn_message%& option in an
15808 &(appendfile)& transport may contain its own &'From:'& header line that
15809 overrides the default.
15810
15811 Experience shows that people reply to bounce messages. If the
15812 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15813 and warning messages. For example:
15814 .code
15815 errors_reply_to = postmaster@my.domain.example
15816 .endd
15817 The value of the option is not expanded. It must specify a valid RFC 2822
15818 address. However, if a warning message that is generated by the
15819 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15820 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15821 not used.
15822
15823
15824 .option event_action main string&!! unset
15825 .cindex events
15826 This option declares a string to be expanded for Exim's events mechanism.
15827 For details see chapter &<<CHAPevents>>&.
15828
15829
15830 .option exim_group main string "compile-time configured"
15831 .cindex "gid (group id)" "Exim's own"
15832 .cindex "Exim group"
15833 This option changes the gid under which Exim runs when it gives up root
15834 privilege. The default value is compiled into the binary. The value of this
15835 option is used only when &%exim_user%& is also set. Unless it consists entirely
15836 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15837 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15838 security issues.
15839
15840
15841 .option exim_path main string "see below"
15842 .cindex "Exim binary, path name"
15843 This option specifies the path name of the Exim binary, which is used when Exim
15844 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15845 the directory configured at compile time by the BIN_DIRECTORY setting. It
15846 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15847 other place.
15848 &*Warning*&: Do not use a macro to define the value of this option, because
15849 you will break those Exim utilities that scan the configuration file to find
15850 where the binary is. (They then use the &%-bP%& option to extract option
15851 settings such as the value of &%spool_directory%&.)
15852
15853
15854 .option exim_user main string "compile-time configured"
15855 .cindex "uid (user id)" "Exim's own"
15856 .cindex "Exim user"
15857 This option changes the uid under which Exim runs when it gives up root
15858 privilege. The default value is compiled into the binary. Ownership of the run
15859 time configuration file and the use of the &%-C%& and &%-D%& command line
15860 options is checked against the values in the binary, not what is set here.
15861
15862 Unless it consists entirely of digits, the string is looked up using
15863 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15864 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15865 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15866
15867
15868 .option exim_version main string "current version"
15869 .cindex "Exim version"
15870 .cindex customizing "version number"
15871 .cindex "version number of Exim" override
15872 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15873 various places.  Use with care; this may fool stupid security scanners.
15874
15875
15876 .option extra_local_interfaces main "string list" unset
15877 This option defines network interfaces that are to be considered local when
15878 routing, but which are not used for listening by the daemon. See section
15879 &<<SECTreclocipadd>>& for details.
15880
15881
15882 . Allow this long option name to split; give it unsplit as a fifth argument
15883 . for the automatic .oindex that is generated by .option.
15884
15885 .option "extract_addresses_remove_arguments" main boolean true &&&
15886          extract_addresses_remove_arguments
15887 .oindex "&%-t%&"
15888 .cindex "command line" "addresses with &%-t%&"
15889 .cindex "Sendmail compatibility" "&%-t%& option"
15890 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15891 are present on the command line when the &%-t%& option is used to build an
15892 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15893 line addresses are removed from the recipients list. This is also how Smail
15894 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15895 command line addresses are added to those obtained from the header lines. When
15896 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15897 argument headers. If it is set false, Exim adds rather than removes argument
15898 addresses.
15899
15900
15901 .option finduser_retries main integer 0
15902 .cindex "NIS, retrying user lookups"
15903 On systems running NIS or other schemes in which user and group information is
15904 distributed from a remote system, there can be times when &[getpwnam()]& and
15905 related functions fail, even when given valid data, because things time out.
15906 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15907 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15908 many extra times to find a user or a group, waiting for one second between
15909 retries.
15910
15911 .cindex "&_/etc/passwd_&" "multiple reading of"
15912 You should not set this option greater than zero if your user information is in
15913 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15914 search the file multiple times for non-existent users, and also cause delay.
15915
15916
15917
15918 .option freeze_tell main "string list, comma separated" unset
15919 .cindex "freezing messages" "sending a message when freezing"
15920 On encountering certain errors, or when configured to do so in a system filter,
15921 ACL, or special router, Exim freezes a message. This means that no further
15922 delivery attempts take place until an administrator thaws the message, or the
15923 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15924 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15925 warning message whenever it freezes something, unless the message it is
15926 freezing is a locally-generated bounce message. (Without this exception there
15927 is the possibility of looping.) The warning message is sent to the addresses
15928 supplied as the comma-separated value of this option. If several of the
15929 message's addresses cause freezing, only a single message is sent. If the
15930 freezing was automatic, the reason(s) for freezing can be found in the message
15931 log. If you configure freezing in a filter or ACL, you must arrange for any
15932 logging that you require.
15933
15934
15935 .option gecos_name main string&!! unset
15936 .cindex "HP-UX"
15937 .cindex "&""gecos""& field, parsing"
15938 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15939 password file to hold other information in addition to users' real names. Exim
15940 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15941 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15942 of the field are used unchanged, except that, if an ampersand is encountered,
15943 it is replaced by the user's login name with the first character forced to
15944 upper case, since this is a convention that is observed on many systems.
15945
15946 When these options are set, &%gecos_pattern%& is treated as a regular
15947 expression that is to be applied to the field (again with && replaced by the
15948 login name), and if it matches, &%gecos_name%& is expanded and used as the
15949 user's name.
15950
15951 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15952 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15953 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15954 name terminates at the first comma, the following can be used:
15955 .code
15956 gecos_pattern = ([^,]*)
15957 gecos_name = $1
15958 .endd
15959
15960 .option gecos_pattern main string unset
15961 See &%gecos_name%& above.
15962
15963
15964 .option gnutls_compat_mode main boolean unset
15965 This option controls whether GnuTLS is used in compatibility mode in an Exim
15966 server. This reduces security slightly, but improves interworking with older
15967 implementations of TLS.
15968
15969
15970 .option gnutls_allow_auto_pkcs11 main boolean unset
15971 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15972 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15973
15974 See
15975 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15976 for documentation.
15977
15978
15979
15980 .option headers_charset main string "see below"
15981 This option sets a default character set for translating from encoded MIME
15982 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15983 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15984 ultimate default is ISO-8859-1. For more details see the description of header
15985 insertions in section &<<SECTexpansionitems>>&.
15986
15987
15988
15989 .option header_maxsize main integer "see below"
15990 .cindex "header section" "maximum size of"
15991 .cindex "limit" "size of message header section"
15992 This option controls the overall maximum size of a message's header
15993 section. The default is the value of HEADER_MAXSIZE in
15994 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15995 sections are rejected.
15996
15997
15998 .option header_line_maxsize main integer 0
15999 .cindex "header lines" "maximum size of"
16000 .cindex "limit" "size of one header line"
16001 This option limits the length of any individual header line in a message, after
16002 all the continuations have been joined together. Messages with individual
16003 header lines that are longer than the limit are rejected. The default value of
16004 zero means &"no limit"&.
16005
16006
16007
16008
16009 .option helo_accept_junk_hosts main "host list&!!" unset
16010 .cindex "HELO" "accepting junk data"
16011 .cindex "EHLO" "accepting junk data"
16012 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16013 mail, and gives an error response for invalid data. Unfortunately, there are
16014 some SMTP clients that send syntactic junk. They can be accommodated by setting
16015 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16016 if you want to do semantic checking.
16017 See also &%helo_allow_chars%& for a way of extending the permitted character
16018 set.
16019
16020
16021 .option helo_allow_chars main string unset
16022 .cindex "HELO" "underscores in"
16023 .cindex "EHLO" "underscores in"
16024 .cindex "underscore in EHLO/HELO"
16025 This option can be set to a string of rogue characters that are permitted in
16026 all EHLO and HELO names in addition to the standard letters, digits,
16027 hyphens, and dots. If you really must allow underscores, you can set
16028 .code
16029 helo_allow_chars = _
16030 .endd
16031 Note that the value is one string, not a list.
16032
16033
16034 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16035 .cindex "HELO" "forcing reverse lookup"
16036 .cindex "EHLO" "forcing reverse lookup"
16037 If the domain given by a client in a HELO or EHLO command matches this
16038 list, a reverse lookup is done in order to establish the host's true name. The
16039 default forces a lookup if the client host gives the server's name or any of
16040 its IP addresses (in brackets), something that broken clients have been seen to
16041 do.
16042
16043
16044 .option helo_try_verify_hosts main "host list&!!" unset
16045 .cindex "HELO verifying" "optional"
16046 .cindex "EHLO" "verifying, optional"
16047 By default, Exim just checks the syntax of HELO and EHLO commands (see
16048 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16049 to do more extensive checking of the data supplied by these commands. The ACL
16050 condition &`verify = helo`& is provided to make this possible.
16051 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16052 to force the check to occur. From release 4.53 onwards, this is no longer
16053 necessary. If the check has not been done before &`verify = helo`& is
16054 encountered, it is done at that time. Consequently, this option is obsolete.
16055 Its specification is retained here for backwards compatibility.
16056
16057 When an EHLO or HELO command is received, if the calling host matches
16058 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16059 EHLO command either:
16060
16061 .ilist
16062 is an IP literal matching the calling address of the host, or
16063 .next
16064 .cindex "DNS" "reverse lookup"
16065 .cindex "reverse DNS lookup"
16066 matches the host name that Exim obtains by doing a reverse lookup of the
16067 calling host address, or
16068 .next
16069 when looked up in DNS yields the calling host address.
16070 .endlist
16071
16072 However, the EHLO or HELO command is not rejected if any of the checks
16073 fail. Processing continues, but the result of the check is remembered, and can
16074 be detected later in an ACL by the &`verify = helo`& condition.
16075
16076 If DNS was used for successful verification, the variable
16077 .cindex "DNS" "DNSSEC"
16078 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16079
16080 .option helo_verify_hosts main "host list&!!" unset
16081 .cindex "HELO verifying" "mandatory"
16082 .cindex "EHLO" "verifying, mandatory"
16083 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16084 backwards compatibility. For hosts that match this option, Exim checks the host
16085 name given in the HELO or EHLO in the same way as for
16086 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16087 rejected with a 550 error, and entries are written to the main and reject logs.
16088 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16089 error.
16090
16091 .option hold_domains main "domain list&!!" unset
16092 .cindex "domain" "delaying delivery"
16093 .cindex "delivery" "delaying certain domains"
16094 This option allows mail for particular domains to be held in the queue
16095 manually. The option is overridden if a message delivery is forced with the
16096 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16097 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16098 item in &%hold_domains%&, no routing or delivery for that address is done, and
16099 it is deferred every time the message is looked at.
16100
16101 This option is intended as a temporary operational measure for delaying the
16102 delivery of mail while some problem is being sorted out, or some new
16103 configuration tested. If you just want to delay the processing of some
16104 domains until a queue run occurs, you should use &%queue_domains%& or
16105 &%queue_smtp_domains%&, not &%hold_domains%&.
16106
16107 A setting of &%hold_domains%& does not override Exim's code for removing
16108 messages from the queue if they have been there longer than the longest retry
16109 time in any retry rule. If you want to hold messages for longer than the normal
16110 retry times, insert a dummy retry rule with a long retry time.
16111
16112
16113 .option host_lookup main "host list&!!" unset
16114 .cindex "host name" "lookup, forcing"
16115 Exim does not look up the name of a calling host from its IP address unless it
16116 is required to compare against some host list, or the host matches
16117 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16118 option (which normally contains IP addresses rather than host names). The
16119 default configuration file contains
16120 .code
16121 host_lookup = *
16122 .endd
16123 which causes a lookup to happen for all hosts. If the expense of these lookups
16124 is felt to be too great, the setting can be changed or removed.
16125
16126 After a successful reverse lookup, Exim does a forward lookup on the name it
16127 has obtained, to verify that it yields the IP address that it started with. If
16128 this check fails, Exim behaves as if the name lookup failed.
16129
16130 .vindex "&$host_lookup_failed$&"
16131 .vindex "&$sender_host_name$&"
16132 After any kind of failure, the host name (in &$sender_host_name$&) remains
16133 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16134 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16135 &`verify = reverse_host_lookup`& in ACLs.
16136
16137
16138 .option host_lookup_order main "string list" &`bydns:byaddr`&
16139 This option specifies the order of different lookup methods when Exim is trying
16140 to find a host name from an IP address. The default is to do a DNS lookup
16141 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16142 if that fails. You can change the order of these lookups, or omit one entirely,
16143 if you want.
16144
16145 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16146 multiple PTR records in the DNS and the IP address is not listed in
16147 &_/etc/hosts_&. Different operating systems give different results in this
16148 case. That is why the default tries a DNS lookup first.
16149
16150
16151
16152 .option host_reject_connection main "host list&!!" unset
16153 .cindex "host" "rejecting connections from"
16154 If this option is set, incoming SMTP calls from the hosts listed are rejected
16155 as soon as the connection is made.
16156 This option is obsolete, and retained only for backward compatibility, because
16157 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16158 connections immediately.
16159
16160 The ability to give an immediate rejection (either by this option or using an
16161 ACL) is provided for use in unusual cases. Many hosts will just try again,
16162 sometimes without much delay. Normally, it is better to use an ACL to reject
16163 incoming messages at a later stage, such as after RCPT commands. See
16164 chapter &<<CHAPACL>>&.
16165
16166
16167 .option hosts_connection_nolog main "host list&!!" unset
16168 .cindex "host" "not logging connections from"
16169 This option defines a list of hosts for which connection logging does not
16170 happen, even though the &%smtp_connection%& log selector is set. For example,
16171 you might want not to log SMTP connections from local processes, or from
16172 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16173 the daemon; you should therefore strive to restrict its value to a short inline
16174 list of IP addresses and networks. To disable logging SMTP connections from
16175 local processes, you must create a host list with an empty item. For example:
16176 .code
16177 hosts_connection_nolog = :
16178 .endd
16179 If the &%smtp_connection%& log selector is not set, this option has no effect.
16180
16181
16182
16183 .option hosts_proxy main "host list&!!" unset
16184 .cindex proxy "proxy protocol"
16185 This option enables use of Proxy Protocol proxies for incoming
16186 connections.  For details see section &<<SECTproxyInbound>>&.
16187
16188
16189 .option hosts_treat_as_local main "domain list&!!" unset
16190 .cindex "local host" "domains treated as"
16191 .cindex "host" "treated as local"
16192 If this option is set, any host names that match the domain list are treated as
16193 if they were the local host when Exim is scanning host lists obtained from MX
16194 records
16195 or other sources. Note that the value of this option is a domain list, not a
16196 host list, because it is always used to check host names, not IP addresses.
16197
16198 This option also applies when Exim is matching the special items
16199 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16200 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16201 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16202 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16203 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16204 interfaces and recognizing the local host.
16205
16206
16207 .option ibase_servers main "string list" unset
16208 .cindex "InterBase" "server list"
16209 This option provides a list of InterBase servers and associated connection data,
16210 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16211 The option is available only if Exim has been built with InterBase support.
16212
16213
16214
16215 .option ignore_bounce_errors_after main time 10w
16216 .cindex "bounce message" "discarding"
16217 .cindex "discarding bounce message"
16218 This option affects the processing of bounce messages that cannot be delivered,
16219 that is, those that suffer a permanent delivery failure. (Bounce messages that
16220 suffer temporary delivery failures are of course retried in the usual way.)
16221
16222 After a permanent delivery failure, bounce messages are frozen,
16223 because there is no sender to whom they can be returned. When a frozen bounce
16224 message has been in the queue for more than the given time, it is unfrozen at
16225 the next queue run, and a further delivery is attempted. If delivery fails
16226 again, the bounce message is discarded. This makes it possible to keep failed
16227 bounce messages around for a shorter time than the normal maximum retry time
16228 for frozen messages. For example,
16229 .code
16230 ignore_bounce_errors_after = 12h
16231 .endd
16232 retries failed bounce message deliveries after 12 hours, discarding any further
16233 failures. If the value of this option is set to a zero time period, bounce
16234 failures are discarded immediately. Setting a very long time (as in the default
16235 value) has the effect of disabling this option. For ways of automatically
16236 dealing with other kinds of frozen message, see &%auto_thaw%& and
16237 &%timeout_frozen_after%&.
16238
16239
16240 .option ignore_fromline_hosts main "host list&!!" unset
16241 .cindex "&""From""& line"
16242 .cindex "UUCP" "&""From""& line"
16243 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16244 the headers of a message. By default this is treated as the start of the
16245 message's body, which means that any following headers are not recognized as
16246 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16247 match those hosts that insist on sending it. If the sender is actually a local
16248 process rather than a remote host, and is using &%-bs%& to inject the messages,
16249 &%ignore_fromline_local%& must be set to achieve this effect.
16250
16251
16252 .option ignore_fromline_local main boolean false
16253 See &%ignore_fromline_hosts%& above.
16254
16255 .option keep_environment main "string list" unset
16256 .cindex "environment" "values from"
16257 This option contains a string list of environment variables to keep.
16258 You have to trust these variables or you have to be sure that
16259 these variables do not impose any security risk. Keep in mind that
16260 during the startup phase Exim is running with an effective UID 0 in most
16261 installations. As the default value is an empty list, the default
16262 environment for using libraries, running embedded Perl code, or running
16263 external binaries is empty, and does not not even contain PATH or HOME.
16264
16265 Actually the list is interpreted as a list of patterns
16266 (&<<SECTlistexpand>>&), except that it is not expanded first.
16267
16268 WARNING: Macro substitution is still done first, so having a macro
16269 FOO and having FOO_HOME in your &%keep_environment%& option may have
16270 unexpected results. You may work around this using a regular expression
16271 that does not match the macro name: ^[F]OO_HOME$.
16272
16273 Current versions of Exim issue a warning during startup if you do not mention
16274 &%keep_environment%& in your runtime configuration file and if your
16275 current environment is not empty. Future versions may not issue that warning
16276 anymore.
16277
16278 See the &%add_environment%& main config option for a way to set
16279 environment variables to a fixed value.  The environment for &(pipe)&
16280 transports is handled separately, see section &<<SECTpipeenv>>& for
16281 details.
16282
16283
16284 .option keep_malformed main time 4d
16285 This option specifies the length of time to keep messages whose spool files
16286 have been corrupted in some way. This should, of course, never happen. At the
16287 next attempt to deliver such a message, it gets removed. The incident is
16288 logged.
16289
16290
16291 .option ldap_ca_cert_dir main string unset
16292 .cindex "LDAP", "TLS CA certificate directory"
16293 .cindex certificate "directory for LDAP"
16294 This option indicates which directory contains CA certificates for verifying
16295 a TLS certificate presented by an LDAP server.
16296 While Exim does not provide a default value, your SSL library may.
16297 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16298 and constrained to be a directory.
16299
16300
16301 .option ldap_ca_cert_file main string unset
16302 .cindex "LDAP", "TLS CA certificate file"
16303 .cindex certificate "file for LDAP"
16304 This option indicates which file contains CA certificates for verifying
16305 a TLS certificate presented by an LDAP server.
16306 While Exim does not provide a default value, your SSL library may.
16307 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16308 and constrained to be a file.
16309
16310
16311 .option ldap_cert_file main string unset
16312 .cindex "LDAP" "TLS client certificate file"
16313 .cindex certificate "file for LDAP"
16314 This option indicates which file contains an TLS client certificate which
16315 Exim should present to the LDAP server during TLS negotiation.
16316 Should be used together with &%ldap_cert_key%&.
16317
16318
16319 .option ldap_cert_key main string unset
16320 .cindex "LDAP" "TLS client key file"
16321 .cindex certificate "key for LDAP"
16322 This option indicates which file contains the secret/private key to use
16323 to prove identity to the LDAP server during TLS negotiation.
16324 Should be used together with &%ldap_cert_file%&, which contains the
16325 identity to be proven.
16326
16327
16328 .option ldap_cipher_suite main string unset
16329 .cindex "LDAP" "TLS cipher suite"
16330 This controls the TLS cipher-suite negotiation during TLS negotiation with
16331 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16332 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16333
16334
16335 .option ldap_default_servers main "string list" unset
16336 .cindex "LDAP" "default servers"
16337 This option provides a list of LDAP servers which are tried in turn when an
16338 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16339 details of LDAP queries. This option is available only when Exim has been built
16340 with LDAP support.
16341
16342
16343 .option ldap_require_cert main string unset.
16344 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16345 This should be one of the values "hard", "demand", "allow", "try" or "never".
16346 A value other than one of these is interpreted as "never".
16347 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16348 Although Exim does not set a default, the LDAP library probably defaults
16349 to hard/demand.
16350
16351
16352 .option ldap_start_tls main boolean false
16353 .cindex "LDAP" "whether or not to negotiate TLS"
16354 If set, Exim will attempt to negotiate TLS with the LDAP server when
16355 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16356 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16357 of SSL-on-connect.
16358 In the event of failure to negotiate TLS, the action taken is controlled
16359 by &%ldap_require_cert%&.
16360 This option is ignored for &`ldapi`& connections.
16361
16362
16363 .option ldap_version main integer unset
16364 .cindex "LDAP" "protocol version, forcing"
16365 This option can be used to force Exim to set a specific protocol version for
16366 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16367 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16368 the LDAP headers; otherwise it is 2. This option is available only when Exim
16369 has been built with LDAP support.
16370
16371
16372
16373 .option local_from_check main boolean true
16374 .cindex "&'Sender:'& header line" "disabling addition of"
16375 .cindex "&'From:'& header line" "disabling checking of"
16376 When a message is submitted locally (that is, not over a TCP/IP connection) by
16377 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16378 checks that the &'From:'& header line matches the login of the calling user and
16379 the domain specified by &%qualify_domain%&.
16380
16381 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16382 locally submitted message is automatically qualified by Exim, unless the
16383 &%-bnq%& command line option is used.
16384
16385 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16386 on the local part. If the &'From:'& header line does not match, Exim adds a
16387 &'Sender:'& header with an address constructed from the calling user's login
16388 and the default qualify domain.
16389
16390 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16391 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16392 &'Sender:'& header lines supplied by untrusted users, you must also set
16393 &%local_sender_retain%& to be true.
16394
16395 .cindex "envelope from"
16396 .cindex "envelope sender"
16397 These options affect only the header lines in the message. The envelope sender
16398 is still forced to be the login id at the qualify domain unless
16399 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16400
16401 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16402 request similar header line checking. See section &<<SECTthesenhea>>&, which
16403 has more details about &'Sender:'& processing.
16404
16405
16406
16407
16408 .option local_from_prefix main string unset
16409 When Exim checks the &'From:'& header line of locally submitted messages for
16410 matching the login id (see &%local_from_check%& above), it can be configured to
16411 ignore certain prefixes and suffixes in the local part of the address. This is
16412 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16413 appropriate lists, in the same form as the &%local_part_prefix%& and
16414 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16415 example, if
16416 .code
16417 local_from_prefix = *-
16418 .endd
16419 is set, a &'From:'& line containing
16420 .code
16421 From: anything-user@your.domain.example
16422 .endd
16423 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16424 matches the actual sender address that is constructed from the login name and
16425 qualify domain.
16426
16427
16428 .option local_from_suffix main string unset
16429 See &%local_from_prefix%& above.
16430
16431
16432 .option local_interfaces main "string list" "see below"
16433 This option controls which network interfaces are used by the daemon for
16434 listening; they are also used to identify the local host when routing. Chapter
16435 &<<CHAPinterfaces>>& contains a full description of this option and the related
16436 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16437 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16438 &%local_interfaces%& is
16439 .code
16440 local_interfaces = 0.0.0.0
16441 .endd
16442 when Exim is built without IPv6 support; otherwise it is
16443 .code
16444 local_interfaces = <; ::0 ; 0.0.0.0
16445 .endd
16446
16447 .option local_scan_timeout main time 5m
16448 .cindex "timeout" "for &[local_scan()]& function"
16449 .cindex "&[local_scan()]& function" "timeout"
16450 This timeout applies to the &[local_scan()]& function (see chapter
16451 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16452 the incoming message is rejected with a temporary error if it is an SMTP
16453 message. For a non-SMTP message, the message is dropped and Exim ends with a
16454 non-zero code. The incident is logged on the main and reject logs.
16455
16456
16457
16458 .option local_sender_retain main boolean false
16459 .cindex "&'Sender:'& header line" "retaining from local submission"
16460 When a message is submitted locally (that is, not over a TCP/IP connection) by
16461 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16462 do not want this to happen, you must set &%local_sender_retain%&, and you must
16463 also set &%local_from_check%& to be false (Exim will complain if you do not).
16464 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16465 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16466
16467
16468
16469
16470 .option localhost_number main string&!! unset
16471 .cindex "host" "locally unique number for"
16472 .cindex "message ids" "with multiple hosts"
16473 .vindex "&$localhost_number$&"
16474 Exim's message ids are normally unique only within the local host. If
16475 uniqueness among a set of hosts is required, each host must set a different
16476 value for the &%localhost_number%& option. The string is expanded immediately
16477 after reading the configuration file (so that a number can be computed from the
16478 host name, for example) and the result of the expansion must be a number in the
16479 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16480 systems). This is available in subsequent string expansions via the variable
16481 &$localhost_number$&. When &%localhost_number is set%&, the final two
16482 characters of the message id, instead of just being a fractional part of the
16483 time, are computed from the time and the local host number as described in
16484 section &<<SECTmessiden>>&.
16485
16486
16487
16488 .option log_file_path main "string list&!!" "set at compile time"
16489 .cindex "log" "file path for"
16490 This option sets the path which is used to determine the names of Exim's log
16491 files, or indicates that logging is to be to syslog, or both. It is expanded
16492 when Exim is entered, so it can, for example, contain a reference to the host
16493 name. If no specific path is set for the log files at compile or runtime,
16494 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16495 they are written in a sub-directory called &_log_& in Exim's spool directory.
16496 A path must start with a slash.
16497 To send to syslog, use the word &"syslog"&.
16498 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16499 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16500 used. If this string is fixed at your installation (contains no expansion
16501 variables) it is recommended that you do not set this option in the
16502 configuration file, but instead supply the path using LOG_FILE_PATH in
16503 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16504 early on &-- in particular, failure to read the configuration file.
16505
16506
16507 .option log_selector main string unset
16508 .cindex "log" "selectors"
16509 This option can be used to reduce or increase the number of things that Exim
16510 writes to its log files. Its argument is made up of names preceded by plus or
16511 minus characters. For example:
16512 .code
16513 log_selector = +arguments -retry_defer
16514 .endd
16515 A list of possible names and what they control is given in the chapter on
16516 logging, in section &<<SECTlogselector>>&.
16517
16518
16519 .option log_timezone main boolean false
16520 .cindex "log" "timezone for entries"
16521 .vindex "&$tod_log$&"
16522 .vindex "&$tod_zone$&"
16523 By default, the timestamps on log lines are in local time without the
16524 timezone. This means that if your timezone changes twice a year, the timestamps
16525 in log lines are ambiguous for an hour when the clocks go back. One way of
16526 avoiding this problem is to set the timezone to UTC. An alternative is to set
16527 &%log_timezone%& true. This turns on the addition of the timezone offset to
16528 timestamps in log lines. Turning on this option can add quite a lot to the size
16529 of log files because each line is extended by 6 characters. Note that the
16530 &$tod_log$& variable contains the log timestamp without the zone, but there is
16531 another variable called &$tod_zone$& that contains just the timezone offset.
16532
16533
16534 .option lookup_open_max main integer 25
16535 .cindex "too many open files"
16536 .cindex "open files, too many"
16537 .cindex "file" "too many open"
16538 .cindex "lookup" "maximum open files"
16539 .cindex "limit" "open files for lookups"
16540 This option limits the number of simultaneously open files for single-key
16541 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16542 Exim normally keeps these files open during routing, because often the same
16543 file is required several times. If the limit is reached, Exim closes the least
16544 recently used file. Note that if you are using the &'ndbm'& library, it
16545 actually opens two files for each logical DBM database, though it still counts
16546 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16547 open files"& errors with NDBM, you need to reduce the value of
16548 &%lookup_open_max%&.
16549
16550
16551 .option max_username_length main integer 0
16552 .cindex "length of login name"
16553 .cindex "user name" "maximum length"
16554 .cindex "limit" "user name length"
16555 Some operating systems are broken in that they truncate long arguments to
16556 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16557 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16558 an argument that is longer behaves as if &[getpwnam()]& failed.
16559
16560
16561 .option message_body_newlines main bool false
16562 .cindex "message body" "newlines in variables"
16563 .cindex "newline" "in message body variables"
16564 .vindex "&$message_body$&"
16565 .vindex "&$message_body_end$&"
16566 By default, newlines in the message body are replaced by spaces when setting
16567 the &$message_body$& and &$message_body_end$& expansion variables. If this
16568 option is set true, this no longer happens.
16569
16570
16571 .option message_body_visible main integer 500
16572 .cindex "body of message" "visible size"
16573 .cindex "message body" "visible size"
16574 .vindex "&$message_body$&"
16575 .vindex "&$message_body_end$&"
16576 This option specifies how much of a message's body is to be included in the
16577 &$message_body$& and &$message_body_end$& expansion variables.
16578
16579
16580 .option message_id_header_domain main string&!! unset
16581 .cindex "&'Message-ID:'& header line"
16582 If this option is set, the string is expanded and used as the right hand side
16583 (domain) of the &'Message-ID:'& header that Exim creates if a
16584 locally-originated incoming message does not have one. &"Locally-originated"&
16585 means &"not received over TCP/IP."&
16586 Otherwise, the primary host name is used.
16587 Only letters, digits, dot and hyphen are accepted; any other characters are
16588 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16589 empty string, the option is ignored.
16590
16591
16592 .option message_id_header_text main string&!! unset
16593 If this variable is set, the string is expanded and used to augment the text of
16594 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16595 message does not have one. The text of this header is required by RFC 2822 to
16596 take the form of an address. By default, Exim uses its internal message id as
16597 the local part, and the primary host name as the domain. If this option is set,
16598 it is expanded, and provided the expansion is not forced to fail, and does not
16599 yield an empty string, the result is inserted into the header immediately
16600 before the @, separated from the internal message id by a dot. Any characters
16601 that are illegal in an address are automatically converted into hyphens. This
16602 means that variables such as &$tod_log$& can be used, because the spaces and
16603 colons will become hyphens.
16604
16605
16606 .option message_logs main boolean true
16607 .cindex "message logs" "disabling"
16608 .cindex "log" "message log; disabling"
16609 If this option is turned off, per-message log files are not created in the
16610 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16611 Exim, by reducing the number of files involved in handling a message from a
16612 minimum of four (header spool file, body spool file, delivery journal, and
16613 per-message log) to three. The other major I/O activity is Exim's main log,
16614 which is not affected by this option.
16615
16616
16617 .option message_size_limit main string&!! 50M
16618 .cindex "message" "size limit"
16619 .cindex "limit" "message size"
16620 .cindex "size" "of message, limit"
16621 This option limits the maximum size of message that Exim will process. The
16622 value is expanded for each incoming connection so, for example, it can be made
16623 to depend on the IP address of the remote host for messages arriving via
16624 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16625 optionally followed by K or M.
16626
16627 .cindex "SIZE" "ESMTP extension, advertising"
16628 .cindex "ESMTP extensions" SIZE
16629 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16630 service extension keyword.
16631
16632 &*Note*&: This limit cannot be made to depend on a message's sender or any
16633 other properties of an individual message, because it has to be advertised in
16634 the server's response to EHLO. String expansion failure causes a temporary
16635 error. A value of zero means no limit, but its use is not recommended. See also
16636 &%bounce_return_size_limit%&.
16637
16638 Incoming SMTP messages are failed with a 552 error if the limit is
16639 exceeded; locally-generated messages either get a stderr message or a delivery
16640 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16641 an oversized message is logged in both the main and the reject logs. See also
16642 the generic transport option &%message_size_limit%&, which limits the size of
16643 message that an individual transport can process.
16644
16645 If you use a virus-scanner and set this option to to a value larger than the
16646 maximum size that your virus-scanner is configured to support, you may get
16647 failures triggered by large mails.  The right size to configure for the
16648 virus-scanner depends upon what data is passed and the options in use but it's
16649 probably safest to just set it to a little larger than this value.  E.g., with a
16650 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16651 some problems may result.
16652
16653 A value of 0 will disable size limit checking; Exim will still advertise the
16654 SIZE extension in an EHLO response, but without a limit, so as to permit
16655 SMTP clients to still indicate the message size along with the MAIL verb.
16656
16657
16658 .option move_frozen_messages main boolean false
16659 .cindex "frozen messages" "moving"
16660 This option, which is available only if Exim has been built with the setting
16661 .code
16662 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16663 .endd
16664 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16665 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16666 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16667 standard utilities for handling such moved messages, and they do not show up in
16668 lists generated by &%-bp%& or by the Exim monitor.
16669
16670
16671 .option mua_wrapper main boolean false
16672 Setting this option true causes Exim to run in a very restrictive mode in which
16673 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16674 contains a full description of this facility.
16675
16676
16677
16678 .option mysql_servers main "string list" unset
16679 .cindex "MySQL" "server list"
16680 This option provides a list of MySQL servers and associated connection data, to
16681 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16682 option is available only if Exim has been built with MySQL support.
16683
16684
16685 .option never_users main "string list&!!" unset
16686 This option is expanded just once, at the start of Exim's processing. Local
16687 message deliveries are normally run in processes that are setuid to the
16688 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16689 It is usually desirable to prevent any deliveries from running as root, as a
16690 safety precaution.
16691
16692 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16693 list of users that must not be used for local deliveries. This list is fixed in
16694 the binary and cannot be overridden by the configuration file. By default, it
16695 contains just the single user name &"root"&. The &%never_users%& runtime option
16696 can be used to add more users to the fixed list.
16697
16698 If a message is to be delivered as one of the users on the fixed list or the
16699 &%never_users%& list, an error occurs, and delivery is deferred. A common
16700 example is
16701 .code
16702 never_users = root:daemon:bin
16703 .endd
16704 Including root is redundant if it is also on the fixed list, but it does no
16705 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16706 transport driver.
16707
16708
16709 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16710 This option gives the name for a unix-domain socket on which the daemon
16711 listens for work and information-requests.
16712 Only installations running multiple daemons sharing a spool directory
16713 should need to modify the default.
16714
16715 The option is expanded before use.
16716 If the platform supports Linux-style abstract socket names, the result
16717 is used with a nul byte prefixed.
16718 Otherwise,
16719 .new "if nonempty,"
16720 it should be a full path name and use a directory accessible
16721 to Exim.
16722
16723 .new
16724 If this option is set as empty,
16725 or the command line &%-oY%& option is used, or
16726 .wen
16727 the command line uses a &%-oX%& option and does not use &%-oP%&,
16728 then a notifier socket is not created.
16729
16730
16731 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16732 .cindex "OpenSSL "compatibility options"
16733 This option allows an administrator to adjust the SSL options applied
16734 by OpenSSL to connections.  It is given as a space-separated list of items,
16735 each one to be +added or -subtracted from the current value.
16736
16737 This option is only available if Exim is built against OpenSSL.  The values
16738 available for this option vary according to the age of your OpenSSL install.
16739 The &"all"& value controls a subset of flags which are available, typically
16740 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16741 list the values known on your system and Exim should support all the
16742 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16743 names lose the leading &"SSL_OP_"& and are lower-cased.
16744
16745 Note that adjusting the options can have severe impact upon the security of
16746 SSL as used by Exim.  It is possible to disable safety checks and shoot
16747 yourself in the foot in various unpleasant ways.  This option should not be
16748 adjusted lightly.  An unrecognised item will be detected at startup, by
16749 invoking Exim with the &%-bV%& flag.
16750
16751 The option affects Exim operating both as a server and as a client.
16752
16753 Historical note: prior to release 4.80, Exim defaulted this value to
16754 "+dont_insert_empty_fragments", which may still be needed for compatibility
16755 with some clients, but which lowers security by increasing exposure to
16756 some now infamous attacks.
16757
16758 Examples:
16759 .code
16760 # Make both old MS and old Eudora happy:
16761 openssl_options = -all +microsoft_big_sslv3_buffer \
16762                        +dont_insert_empty_fragments
16763
16764 # Disable older protocol versions:
16765 openssl_options = +no_sslv2 +no_sslv3
16766 .endd
16767
16768 Possible options may include:
16769 .ilist
16770 &`all`&
16771 .next
16772 &`allow_unsafe_legacy_renegotiation`&
16773 .next
16774 &`cipher_server_preference`&
16775 .next
16776 &`dont_insert_empty_fragments`&
16777 .next
16778 &`ephemeral_rsa`&
16779 .next
16780 &`legacy_server_connect`&
16781 .next
16782 &`microsoft_big_sslv3_buffer`&
16783 .next
16784 &`microsoft_sess_id_bug`&
16785 .next
16786 &`msie_sslv2_rsa_padding`&
16787 .next
16788 &`netscape_challenge_bug`&
16789 .next
16790 &`netscape_reuse_cipher_change_bug`&
16791 .next
16792 &`no_compression`&
16793 .next
16794 &`no_session_resumption_on_renegotiation`&
16795 .next
16796 &`no_sslv2`&
16797 .next
16798 &`no_sslv3`&
16799 .next
16800 &`no_ticket`&
16801 .next
16802 &`no_tlsv1`&
16803 .next
16804 &`no_tlsv1_1`&
16805 .next
16806 &`no_tlsv1_2`&
16807 .next
16808 &`safari_ecdhe_ecdsa_bug`&
16809 .next
16810 &`single_dh_use`&
16811 .next
16812 &`single_ecdh_use`&
16813 .next
16814 &`ssleay_080_client_dh_bug`&
16815 .next
16816 &`sslref2_reuse_cert_type_bug`&
16817 .next
16818 &`tls_block_padding_bug`&
16819 .next
16820 &`tls_d5_bug`&
16821 .next
16822 &`tls_rollback_bug`&
16823 .endlist
16824
16825 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16826 all clients connecting using the MacOS SecureTransport TLS facility prior
16827 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16828 to negotiate TLS then this option value might help, provided that your OpenSSL
16829 release is new enough to contain this work-around.  This may be a situation
16830 where you have to upgrade OpenSSL to get buggy clients working.
16831
16832
16833 .option oracle_servers main "string list" unset
16834 .cindex "Oracle" "server list"
16835 This option provides a list of Oracle servers and associated connection data,
16836 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16837 The option is available only if Exim has been built with Oracle support.
16838
16839
16840 .option percent_hack_domains main "domain list&!!" unset
16841 .cindex "&""percent hack""&"
16842 .cindex "source routing" "in email address"
16843 .cindex "address" "source-routed"
16844 The &"percent hack"& is the convention whereby a local part containing a
16845 percent sign is re-interpreted as a new email address, with the percent
16846 replaced by @. This is sometimes called &"source routing"&, though that term is
16847 also applied to RFC 2822 addresses that begin with an @ character. If this
16848 option is set, Exim implements the percent facility for those domains listed,
16849 but no others. This happens before an incoming SMTP address is tested against
16850 an ACL.
16851
16852 &*Warning*&: The &"percent hack"& has often been abused by people who are
16853 trying to get round relaying restrictions. For this reason, it is best avoided
16854 if at all possible. Unfortunately, a number of less security-conscious MTAs
16855 implement it unconditionally. If you are running Exim on a gateway host, and
16856 routing mail through to internal MTAs without processing the local parts, it is
16857 a good idea to reject recipient addresses with percent characters in their
16858 local parts. Exim's default configuration does this.
16859
16860
16861 .option perl_at_start main boolean false
16862 .cindex "Perl"
16863 This option is available only when Exim is built with an embedded Perl
16864 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16865
16866
16867 .option perl_startup main string unset
16868 .cindex "Perl"
16869 This option is available only when Exim is built with an embedded Perl
16870 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16871
16872 .option perl_taintmode main boolean false
16873 .cindex "Perl"
16874 This option enables the taint mode of the embedded Perl interpreter.
16875
16876
16877 .option pgsql_servers main "string list" unset
16878 .cindex "PostgreSQL lookup type" "server list"
16879 This option provides a list of PostgreSQL servers and associated connection
16880 data, to be used in conjunction with &(pgsql)& lookups (see section
16881 &<<SECID72>>&). The option is available only if Exim has been built with
16882 PostgreSQL support.
16883
16884
16885 .option pid_file_path main string&!! "set at compile time"
16886 .cindex "daemon" "pid file path"
16887 .cindex "pid file, path for"
16888 This option sets the name of the file to which the Exim daemon writes its
16889 process id. The string is expanded, so it can contain, for example, references
16890 to the host name:
16891 .code
16892 pid_file_path = /var/log/$primary_hostname/exim.pid
16893 .endd
16894 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16895 spool directory.
16896 The value set by the option can be overridden by the &%-oP%& command line
16897 option. A pid file is not written if a &"non-standard"& daemon is run by means
16898 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16899
16900
16901 .option pipelining_advertise_hosts main "host list&!!" *
16902 .cindex "PIPELINING" "suppressing advertising"
16903 .cindex "ESMTP extensions" PIPELINING
16904 This option can be used to suppress the advertisement of the SMTP
16905 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16906 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16907 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16908 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16909 that clients will use it; &"out of order"& commands that are &"expected"& do
16910 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16911
16912 .option pipelining_connect_advertise_hosts main "host list&!!" *
16913 .cindex "pipelining" "early connection"
16914 .cindex "pipelining" PIPE_CONNECT
16915 .cindex "ESMTP extensions" X_PIPE_CONNECT
16916 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16917 this option controls which hosts the facility is advertised to
16918 and from which pipeline early-connection (before MAIL) SMTP
16919 commands are acceptable.
16920 When used, the pipelining saves on roundtrip times.
16921
16922 See also the &%hosts_pipe_connect%& smtp transport option.
16923
16924 Currently the option name &"X_PIPE_CONNECT"& is used.
16925
16926
16927 .option prdr_enable main boolean false
16928 .cindex "PRDR" "enabling on server"
16929 .cindex "ESMTP extensions" PRDR
16930 This option can be used to enable the Per-Recipient Data Response extension
16931 to SMTP, defined by Eric Hall.
16932 If the option is set, PRDR is advertised by Exim when operating as a server.
16933 If the client requests PRDR, and more than one recipient, for a message
16934 an additional ACL is called for each recipient after the message content
16935 is received.  See section &<<SECTPRDRACL>>&.
16936
16937 .option preserve_message_logs main boolean false
16938 .cindex "message logs" "preserving"
16939 If this option is set, message log files are not deleted when messages are
16940 completed. Instead, they are moved to a sub-directory of the spool directory
16941 called &_msglog.OLD_&, where they remain available for statistical or debugging
16942 purposes. This is a dangerous option to set on systems with any appreciable
16943 volume of mail. Use with care!
16944
16945
16946 .option primary_hostname main string "see below"
16947 .cindex "name" "of local host"
16948 .cindex "host" "name of local"
16949 .cindex "local host" "name of"
16950 .vindex "&$primary_hostname$&"
16951 This specifies the name of the current host. It is used in the default EHLO or
16952 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16953 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16954 The value is also used by default in some SMTP response messages from an Exim
16955 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16956
16957 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16958 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16959 contains only one component, Exim passes it to &[gethostbyname()]& (or
16960 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16961 version. The variable &$primary_hostname$& contains the host name, whether set
16962 explicitly by this option, or defaulted.
16963
16964
16965 .option print_topbitchars main boolean false
16966 .cindex "printing characters"
16967 .cindex "8-bit characters"
16968 By default, Exim considers only those characters whose codes lie in the range
16969 32&--126 to be printing characters. In a number of circumstances (for example,
16970 when writing log entries) non-printing characters are converted into escape
16971 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16972 is set, code values of 128 and above are also considered to be printing
16973 characters.
16974
16975 This option also affects the header syntax checks performed by the
16976 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16977 the user's full name when constructing From: and Sender: addresses (as
16978 described in section &<<SECTconstr>>&). Setting this option can cause
16979 Exim to generate eight bit message headers that do not conform to the
16980 standards.
16981
16982
16983 .option process_log_path main string unset
16984 .cindex "process log path"
16985 .cindex "log" "process log"
16986 .cindex "&'exiwhat'&"
16987 This option sets the name of the file to which an Exim process writes its
16988 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16989 utility script. If this option is unset, the file called &_exim-process.info_&
16990 in Exim's spool directory is used. The ability to specify the name explicitly
16991 can be useful in environments where two different Exims are running, using
16992 different spool directories.
16993
16994
16995 .option prod_requires_admin main boolean true
16996 .cindex "restricting access to features"
16997 .oindex "&%-M%&"
16998 .oindex "&%-R%&"
16999 .oindex "&%-q%&"
17000 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17001 admin user unless &%prod_requires_admin%& is set false. See also
17002 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17003
17004
17005 .option qualify_domain main string "see below"
17006 .cindex "domain" "for qualifying addresses"
17007 .cindex "address" "qualification"
17008 This option specifies the domain name that is added to any envelope sender
17009 addresses that do not have a domain qualification. It also applies to
17010 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17011 are accepted by default only for locally-generated messages. Qualification is
17012 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17013 locally-generated messages, unless the &%-bnq%& command line option is used.
17014
17015 Messages from external sources must always contain fully qualified addresses,
17016 unless the sending host matches &%sender_unqualified_hosts%& or
17017 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17018 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17019 necessary. Internally, Exim always works with fully qualified envelope
17020 addresses. If &%qualify_domain%& is not set, it defaults to the
17021 &%primary_hostname%& value.
17022
17023
17024 .option qualify_recipient main string "see below"
17025 This option allows you to specify a different domain for qualifying recipient
17026 addresses to the one that is used for senders. See &%qualify_domain%& above.
17027
17028
17029
17030 .option queue_domains main "domain list&!!" unset
17031 .cindex "domain" "specifying non-immediate delivery"
17032 .cindex "queueing incoming messages"
17033 .cindex "message" "queueing certain domains"
17034 This option lists domains for which immediate delivery is not required.
17035 A delivery process is started whenever a message is received, but only those
17036 domains that do not match are processed. All other deliveries wait until the
17037 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17038
17039
17040 .new
17041 .option queue_fast_ramp main boolean false
17042 .cindex "queue runner" "two phase"
17043 .cindex "queue" "double scanning"
17044 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17045 command line, may start parallel delivery processes during their first
17046 phase.  This will be done when a threshold number of messages have been
17047 routed for a single host.
17048 .wen
17049
17050
17051 .option queue_list_requires_admin main boolean true
17052 .cindex "restricting access to features"
17053 .oindex "&%-bp%&"
17054 The &%-bp%& command-line option, which lists the messages that are on the
17055 queue, requires the caller to be an admin user unless
17056 &%queue_list_requires_admin%& is set false.
17057 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17058
17059
17060 .option queue_only main boolean false
17061 .cindex "queueing incoming messages"
17062 .cindex "message" "queueing unconditionally"
17063 If &%queue_only%& is set, a delivery process is not automatically started
17064 whenever a message is received. Instead, the message waits in the queue for the
17065 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17066 delivered immediately when certain conditions (such as heavy load) occur.
17067
17068 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17069 and &%-odi%& command line options override &%queue_only%& unless
17070 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17071 &%queue_only_load%&, and &%smtp_accept_queue%&.
17072
17073
17074 .option queue_only_file main string unset
17075 .cindex "queueing incoming messages"
17076 .cindex "message" "queueing by file existence"
17077 This option can be set to a colon-separated list of absolute path names, each
17078 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17079 it tests for the existence of each listed path using a call to &[stat()]&. For
17080 each path that exists, the corresponding queueing option is set.
17081 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17082 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17083 .code
17084 queue_only_file = smtp/some/file
17085 .endd
17086 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17087 &_/some/file_& exists.
17088
17089
17090 .option queue_only_load main fixed-point unset
17091 .cindex "load average"
17092 .cindex "queueing incoming messages"
17093 .cindex "message" "queueing by load"
17094 If the system load average is higher than this value, incoming messages from
17095 all sources are queued, and no automatic deliveries are started. If this
17096 happens during local or remote SMTP input, all subsequent messages received on
17097 the same SMTP connection are queued by default, whatever happens to the load in
17098 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17099 false.
17100
17101 Deliveries will subsequently be performed by queue runner processes. This
17102 option has no effect on ancient operating systems on which Exim cannot
17103 determine the load average. See also &%deliver_queue_load_max%& and
17104 &%smtp_load_reserve%&.
17105
17106
17107 .option queue_only_load_latch main boolean true
17108 .cindex "load average" "re-evaluating per message"
17109 When this option is true (the default), once one message has been queued
17110 because the load average is higher than the value set by &%queue_only_load%&,
17111 all subsequent messages received on the same SMTP connection are also queued.
17112 This is a deliberate choice; even though the load average may fall below the
17113 threshold, it doesn't seem right to deliver later messages on the same
17114 connection when not delivering earlier ones. However, there are special
17115 circumstances such as very long-lived connections from scanning appliances
17116 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17117 should be set false. This causes the value of the load average to be
17118 re-evaluated for each message.
17119
17120
17121 .option queue_only_override main boolean true
17122 .cindex "queueing incoming messages"
17123 When this option is true, the &%-od%&&'x'& command line options override the
17124 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17125 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17126 to override; they are accepted, but ignored.
17127
17128
17129 .option queue_run_in_order main boolean false
17130 .cindex "queue runner" "processing messages in order"
17131 If this option is set, queue runs happen in order of message arrival instead of
17132 in an arbitrary order. For this to happen, a complete list of the entire queue
17133 must be set up before the deliveries start. When the queue is all held in a
17134 single directory (the default), a single list is created for both the ordered
17135 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17136 single list is not created when &%queue_run_in_order%& is false. In this case,
17137 the sub-directories are processed one at a time (in a random order), and this
17138 avoids setting up one huge list for the whole queue. Thus, setting
17139 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17140 when the queue is large, because of the extra work in setting up the single,
17141 large list. In most situations, &%queue_run_in_order%& should not be set.
17142
17143
17144
17145 .option queue_run_max main integer&!! 5
17146 .cindex "queue runner" "maximum number of"
17147 This controls the maximum number of queue runner processes that an Exim daemon
17148 can run simultaneously. This does not mean that it starts them all at once,
17149 but rather that if the maximum number are still running when the time comes to
17150 start another one, it refrains from starting another one. This can happen with
17151 very large queues and/or very sluggish deliveries. This option does not,
17152 however, interlock with other processes, so additional queue runners can be
17153 started by other means, or by killing and restarting the daemon.
17154
17155 Setting this option to zero does not suppress queue runs; rather, it disables
17156 the limit, allowing any number of simultaneous queue runner processes to be
17157 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17158 the daemon's command line.
17159
17160 .cindex queues named
17161 .cindex "named queues" "resource limit"
17162 To set limits for different named queues use
17163 an expansion depending on the &$queue_name$& variable.
17164
17165 .option queue_smtp_domains main "domain list&!!" unset
17166 .cindex "queueing incoming messages"
17167 .cindex "message" "queueing remote deliveries"
17168 .cindex "first pass routing"
17169 When this option is set, a delivery process is started whenever a message is
17170 received, routing is performed, and local deliveries take place.
17171 However, if any SMTP deliveries are required for domains that match
17172 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17173 message waits in the queue for the next queue run. Since routing of the message
17174 has taken place, Exim knows to which remote hosts it must be delivered, and so
17175 when the queue run happens, multiple messages for the same host are delivered
17176 over a single SMTP connection. The &%-odqs%& command line option causes all
17177 SMTP deliveries to be queued in this way, and is equivalent to setting
17178 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17179 &%queue_domains%&.
17180
17181
17182 .option receive_timeout main time 0s
17183 .cindex "timeout" "for non-SMTP input"
17184 This option sets the timeout for accepting a non-SMTP message, that is, the
17185 maximum time that Exim waits when reading a message on the standard input. If
17186 the value is zero, it will wait forever. This setting is overridden by the
17187 &%-or%& command line option. The timeout for incoming SMTP messages is
17188 controlled by &%smtp_receive_timeout%&.
17189
17190 .option received_header_text main string&!! "see below"
17191 .cindex "customizing" "&'Received:'& header"
17192 .cindex "&'Received:'& header line" "customizing"
17193 This string defines the contents of the &'Received:'& message header that is
17194 added to each message, except for the timestamp, which is automatically added
17195 on at the end (preceded by a semicolon). The string is expanded each time it is
17196 used. If the expansion yields an empty string, no &'Received:'& header line is
17197 added to the message. Otherwise, the string should start with the text
17198 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17199 header lines.
17200 The default setting is:
17201
17202 .code
17203 received_header_text = Received: \
17204   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17205     {${if def:sender_ident \
17206       {from ${quote_local_part:$sender_ident} }}\
17207         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17208   by $primary_hostname \
17209   ${if def:received_protocol {with $received_protocol }}\
17210   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17211   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17212   (Exim $version_number)\n\t\
17213   ${if def:sender_address \
17214   {(envelope-from <$sender_address>)\n\t}}\
17215   id $message_exim_id\
17216   ${if def:received_for {\n\tfor $received_for}}
17217 .endd
17218
17219 The references to the TLS version and cipher are
17220 omitted when Exim is built without TLS
17221 support. The use of conditional expansions ensures that this works for both
17222 locally generated messages and messages received from remote hosts, giving
17223 header lines such as the following:
17224 .code
17225 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17226 by marley.carol.example with esmtp (Exim 4.00)
17227 (envelope-from <bob@carol.example>)
17228 id 16IOWa-00019l-00
17229 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17230 Received: by scrooge.carol.example with local (Exim 4.00)
17231 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17232 .endd
17233 Until the body of the message has been received, the timestamp is the time when
17234 the message started to be received. Once the body has arrived, and all policy
17235 checks have taken place, the timestamp is updated to the time at which the
17236 message was accepted.
17237
17238
17239 .option received_headers_max main integer 30
17240 .cindex "loop" "prevention"
17241 .cindex "mail loop prevention"
17242 .cindex "&'Received:'& header line" "counting"
17243 When a message is to be delivered, the number of &'Received:'& headers is
17244 counted, and if it is greater than this parameter, a mail loop is assumed to
17245 have occurred, the delivery is abandoned, and an error message is generated.
17246 This applies to both local and remote deliveries.
17247
17248
17249 .option recipient_unqualified_hosts main "host list&!!" unset
17250 .cindex "unqualified addresses"
17251 .cindex "host" "unqualified addresses from"
17252 This option lists those hosts from which Exim is prepared to accept unqualified
17253 recipient addresses in message envelopes. The addresses are made fully
17254 qualified by the addition of the &%qualify_recipient%& value. This option also
17255 affects message header lines. Exim does not reject unqualified recipient
17256 addresses in headers, but it qualifies them only if the message came from a
17257 host that matches &%recipient_unqualified_hosts%&,
17258 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17259 option was not set.
17260
17261
17262 .option recipients_max main integer 0
17263 .cindex "limit" "number of recipients"
17264 .cindex "recipient" "maximum number"
17265 If this option is set greater than zero, it specifies the maximum number of
17266 original recipients for any message. Additional recipients that are generated
17267 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17268 all recipients over the limit; earlier recipients are delivered as normal.
17269 Non-SMTP messages with too many recipients are failed, and no deliveries are
17270 done.
17271
17272 .cindex "RCPT" "maximum number of incoming"
17273 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17274 RCPT commands in a single message.
17275
17276
17277 .option recipients_max_reject main boolean false
17278 If this option is set true, Exim rejects SMTP messages containing too many
17279 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17280 error to the eventual DATA command. Otherwise (the default) it gives a 452
17281 error to the surplus RCPT commands and accepts the message on behalf of the
17282 initial set of recipients. The remote server should then re-send the message
17283 for the remaining recipients at a later time.
17284
17285
17286 .option remote_max_parallel main integer 2
17287 .cindex "delivery" "parallelism for remote"
17288 This option controls parallel delivery of one message to a number of remote
17289 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17290 does all the remote deliveries for a message one by one. Otherwise, if a single
17291 message has to be delivered to more than one remote host, or if several copies
17292 have to be sent to the same remote host, up to &%remote_max_parallel%&
17293 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17294 deliveries are required, the maximum number of processes are started, and as
17295 each one finishes, another is begun. The order of starting processes is the
17296 same as if sequential delivery were being done, and can be controlled by the
17297 &%remote_sort_domains%& option. If parallel delivery takes place while running
17298 with debugging turned on, the debugging output from each delivery process is
17299 tagged with its process id.
17300
17301 This option controls only the maximum number of parallel deliveries for one
17302 message in one Exim delivery process. Because Exim has no central queue
17303 manager, there is no way of controlling the total number of simultaneous
17304 deliveries if the configuration allows a delivery attempt as soon as a message
17305 is received.
17306
17307 .cindex "number of deliveries"
17308 .cindex "delivery" "maximum number of"
17309 If you want to control the total number of deliveries on the system, you
17310 need to set the &%queue_only%& option. This ensures that all incoming messages
17311 are added to the queue without starting a delivery process. Then set up an Exim
17312 daemon to start queue runner processes at appropriate intervals (probably
17313 fairly often, for example, every minute), and limit the total number of queue
17314 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17315 delivers only one message at a time, the maximum number of deliveries that can
17316 then take place at once is &%queue_run_max%& multiplied by
17317 &%remote_max_parallel%&.
17318
17319 If it is purely remote deliveries you want to control, use
17320 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17321 doing the SMTP routing before queueing, so that several messages for the same
17322 host will eventually get delivered down the same connection.
17323
17324
17325 .option remote_sort_domains main "domain list&!!" unset
17326 .cindex "sorting remote deliveries"
17327 .cindex "delivery" "sorting remote"
17328 When there are a number of remote deliveries for a message, they are sorted by
17329 domain into the order given by this list. For example,
17330 .code
17331 remote_sort_domains = *.cam.ac.uk:*.uk
17332 .endd
17333 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17334 then to those in the &%uk%& domain, then to any others.
17335
17336
17337 .option retry_data_expire main time 7d
17338 .cindex "hints database" "data expiry"
17339 This option sets a &"use before"& time on retry information in Exim's hints
17340 database. Any older retry data is ignored. This means that, for example, once a
17341 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17342 past failures.
17343
17344
17345 .option retry_interval_max main time 24h
17346 .cindex "retry" "limit on interval"
17347 .cindex "limit" "on retry interval"
17348 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17349 intervals between delivery attempts for messages that cannot be delivered
17350 straight away. This option sets an overall limit to the length of time between
17351 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17352 the default value.
17353
17354
17355 .option return_path_remove main boolean true
17356 .cindex "&'Return-path:'& header line" "removing"
17357 RFC 2821, section 4.4, states that an SMTP server must insert a
17358 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17359 The &'Return-path:'& header preserves the sender address as received in the
17360 MAIL command. This description implies that this header should not be present
17361 in an incoming message. If &%return_path_remove%& is true, any existing
17362 &'Return-path:'& headers are removed from messages at the time they are
17363 received. Exim's transports have options for adding &'Return-path:'& headers at
17364 the time of delivery. They are normally used only for final local deliveries.
17365
17366
17367 .option return_size_limit main integer 100K
17368 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17369
17370
17371 .option rfc1413_hosts main "host list&!!" @[]
17372 .cindex "RFC 1413"
17373 .cindex "host" "for RFC 1413 calls"
17374 RFC 1413 identification calls are made to any client host which matches
17375 an item in the list.
17376 The default value specifies just this host, being any local interface
17377 for the system.
17378
17379 .option rfc1413_query_timeout main time 0s
17380 .cindex "RFC 1413" "query timeout"
17381 .cindex "timeout" "for RFC 1413 call"
17382 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17383 no RFC 1413 calls are ever made.
17384
17385
17386 .option sender_unqualified_hosts main "host list&!!" unset
17387 .cindex "unqualified addresses"
17388 .cindex "host" "unqualified addresses from"
17389 This option lists those hosts from which Exim is prepared to accept unqualified
17390 sender addresses. The addresses are made fully qualified by the addition of
17391 &%qualify_domain%&. This option also affects message header lines. Exim does
17392 not reject unqualified addresses in headers that contain sender addresses, but
17393 it qualifies them only if the message came from a host that matches
17394 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17395 using TCP/IP), and the &%-bnq%& option was not set.
17396
17397
17398 .option slow_lookup_log main integer 0
17399 .cindex "logging" "slow lookups"
17400 .cindex "dns" "logging slow lookups"
17401 This option controls logging of slow lookups.
17402 If the value is nonzero it is taken as a number of milliseconds
17403 and lookups taking longer than this are logged.
17404 Currently this applies only to DNS lookups.
17405
17406
17407
17408 .option smtp_accept_keepalive main boolean true
17409 .cindex "keepalive" "on incoming connection"
17410 This option controls the setting of the SO_KEEPALIVE option on incoming
17411 TCP/IP socket connections. When set, it causes the kernel to probe idle
17412 connections periodically, by sending packets with &"old"& sequence numbers. The
17413 other end of the connection should send an acknowledgment if the connection is
17414 still okay or a reset if the connection has been aborted. The reason for doing
17415 this is that it has the beneficial effect of freeing up certain types of
17416 connection that can get stuck when the remote host is disconnected without
17417 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17418 hours to detect unreachable hosts.
17419
17420
17421
17422 .option smtp_accept_max main integer 20
17423 .cindex "limit" "incoming SMTP connections"
17424 .cindex "SMTP" "incoming connection count"
17425 .cindex "inetd"
17426 This option specifies the maximum number of simultaneous incoming SMTP calls
17427 that Exim will accept. It applies only to the listening daemon; there is no
17428 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17429 value is set to zero, no limit is applied. However, it is required to be
17430 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17431 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17432
17433 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17434 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17435 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17436 and &%smtp_load_reserve%& are then checked before accepting the connection.
17437
17438
17439 .option smtp_accept_max_nonmail main integer 10
17440 .cindex "limit" "non-mail SMTP commands"
17441 .cindex "SMTP" "limiting non-mail commands"
17442 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17443 the connection if there are too many. This option defines &"too many"&. The
17444 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17445 client looping sending EHLO, for example. The check is applied only if the
17446 client host matches &%smtp_accept_max_nonmail_hosts%&.
17447
17448 When a new message is expected, one occurrence of RSET is not counted. This
17449 allows a client to send one RSET between messages (this is not necessary,
17450 but some clients do it). Exim also allows one uncounted occurrence of HELO
17451 or EHLO, and one occurrence of STARTTLS between messages. After
17452 starting up a TLS session, another EHLO is expected, and so it too is not
17453 counted. The first occurrence of AUTH in a connection, or immediately
17454 following STARTTLS is not counted. Otherwise, all commands other than
17455 MAIL, RCPT, DATA, and QUIT are counted.
17456
17457
17458 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17459 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17460 check by setting this option. The default value makes it apply to all hosts. By
17461 changing the value, you can exclude any badly-behaved hosts that you have to
17462 live with.
17463
17464
17465 . Allow this long option name to split; give it unsplit as a fifth argument
17466 . for the automatic .oindex that is generated by .option.
17467 . We insert " &~&~" which is both pretty nasty visually and results in
17468 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17469 . zero-width-space, which would be nicer visually and results in (at least)
17470 . html that Firefox will split on when it's forced to reflow (rather than
17471 . inserting a horizontal scrollbar).  However, the text is still not
17472 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17473 . the option name to split.
17474
17475 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17476          smtp_accept_max_per_connection
17477 .cindex "SMTP" "limiting incoming message count"
17478 .cindex "limit" "messages per SMTP connection"
17479 The value of this option limits the number of MAIL commands that Exim is
17480 prepared to accept over a single SMTP connection, whether or not each command
17481 results in the transfer of a message. After the limit is reached, a 421
17482 response is given to subsequent MAIL commands. This limit is a safety
17483 precaution against a client that goes mad (incidents of this type have been
17484 seen).
17485
17486
17487 .option smtp_accept_max_per_host main string&!! unset
17488 .cindex "limit" "SMTP connections from one host"
17489 .cindex "host" "limiting SMTP connections from"
17490 This option restricts the number of simultaneous IP connections from a single
17491 host (strictly, from a single IP address) to the Exim daemon. The option is
17492 expanded, to enable different limits to be applied to different hosts by
17493 reference to &$sender_host_address$&. Once the limit is reached, additional
17494 connection attempts from the same host are rejected with error code 421. This
17495 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17496 of zero imposes no limit. If this option is set greater than zero, it is
17497 required that &%smtp_accept_max%& be non-zero.
17498
17499 &*Warning*&: When setting this option you should not use any expansion
17500 constructions that take an appreciable amount of time. The expansion and test
17501 happen in the main daemon loop, in order to reject additional connections
17502 without forking additional processes (otherwise a denial-of-service attack
17503 could cause a vast number or processes to be created). While the daemon is
17504 doing this processing, it cannot accept any other incoming connections.
17505
17506
17507
17508 .option smtp_accept_queue main integer 0
17509 .cindex "SMTP" "incoming connection count"
17510 .cindex "queueing incoming messages"
17511 .cindex "message" "queueing by SMTP connection count"
17512 If the number of simultaneous incoming SMTP connections being handled via the
17513 listening daemon exceeds this value, messages received by SMTP are just placed
17514 in the queue; no delivery processes are started automatically. The count is
17515 fixed at the start of an SMTP connection. It cannot be updated in the
17516 subprocess that receives messages, and so the queueing or not queueing applies
17517 to all messages received in the same connection.
17518
17519 A value of zero implies no limit, and clearly any non-zero value is useful only
17520 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17521 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17522 various &%-od%&&'x'& command line options.
17523
17524
17525 . See the comment on smtp_accept_max_per_connection
17526
17527 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17528          smtp_accept_queue_per_connection
17529 .cindex "queueing incoming messages"
17530 .cindex "message" "queueing by message count"
17531 This option limits the number of delivery processes that Exim starts
17532 automatically when receiving messages via SMTP, whether via the daemon or by
17533 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17534 and the number of messages received in a single SMTP session exceeds this
17535 number, subsequent messages are placed in the queue, but no delivery processes
17536 are started. This helps to limit the number of Exim processes when a server
17537 restarts after downtime and there is a lot of mail waiting for it on other
17538 systems. On large systems, the default should probably be increased, and on
17539 dial-in client systems it should probably be set to zero (that is, disabled).
17540
17541
17542 .option smtp_accept_reserve main integer 0
17543 .cindex "SMTP" "incoming call count"
17544 .cindex "host" "reserved"
17545 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17546 number of SMTP connections that are reserved for connections from the hosts
17547 that are specified in &%smtp_reserve_hosts%&. The value set in
17548 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17549 restricted to this number of connections; the option specifies a minimum number
17550 of connection slots for them, not a maximum. It is a guarantee that this group
17551 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17552 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17553 individual host.
17554
17555 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17556 set to 5, once there are 45 active connections (from any hosts), new
17557 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17558 provided the other criteria for acceptance are met.
17559
17560
17561 .option smtp_active_hostname main string&!! unset
17562 .cindex "host" "name in SMTP responses"
17563 .cindex "SMTP" "host name in responses"
17564 .vindex "&$primary_hostname$&"
17565 This option is provided for multi-homed servers that want to masquerade as
17566 several different hosts. At the start of an incoming SMTP connection, its value
17567 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17568 responses. For example, it is used as domain name in the response to an
17569 incoming HELO or EHLO command.
17570
17571 .vindex "&$smtp_active_hostname$&"
17572 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17573 is saved with any messages that are received. It is therefore available for use
17574 in routers and transports when the message is later delivered.
17575
17576 If this option is unset, or if its expansion is forced to fail, or if the
17577 expansion results in an empty string, the value of &$primary_hostname$& is
17578 used. Other expansion failures cause a message to be written to the main and
17579 panic logs, and the SMTP command receives a temporary error. Typically, the
17580 value of &%smtp_active_hostname%& depends on the incoming interface address.
17581 For example:
17582 .code
17583 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17584   {cox.mydomain}{box.mydomain}}
17585 .endd
17586
17587 Although &$smtp_active_hostname$& is primarily concerned with incoming
17588 messages, it is also used as the default for HELO commands in callout
17589 verification if there is no remote transport from which to obtain a
17590 &%helo_data%& value.
17591
17592 .option smtp_banner main string&!! "see below"
17593 .cindex "SMTP" "welcome banner"
17594 .cindex "banner for SMTP"
17595 .cindex "welcome banner for SMTP"
17596 .cindex "customizing" "SMTP banner"
17597 This string, which is expanded every time it is used, is output as the initial
17598 positive response to an SMTP connection. The default setting is:
17599 .code
17600 smtp_banner = $smtp_active_hostname ESMTP Exim \
17601   $version_number $tod_full
17602 .endd
17603 Failure to expand the string causes a panic error. If you want to create a
17604 multiline response to the initial SMTP connection, use &"\n"& in the string at
17605 appropriate points, but not at the end. Note that the 220 code is not included
17606 in this string. Exim adds it automatically (several times in the case of a
17607 multiline response).
17608
17609
17610 .option smtp_check_spool_space main boolean true
17611 .cindex "checking disk space"
17612 .cindex "disk space, checking"
17613 .cindex "spool directory" "checking space"
17614 When this option is set, if an incoming SMTP session encounters the SIZE
17615 option on a MAIL command, it checks that there is enough space in the
17616 spool directory's partition to accept a message of that size, while still
17617 leaving free the amount specified by &%check_spool_space%& (even if that value
17618 is zero). If there isn't enough space, a temporary error code is returned.
17619
17620
17621 .option smtp_connect_backlog main integer 20
17622 .cindex "connection backlog"
17623 .cindex "SMTP" "connection backlog"
17624 .cindex "backlog of connections"
17625 This option specifies a maximum number of waiting SMTP connections. Exim passes
17626 this value to the TCP/IP system when it sets up its listener. Once this number
17627 of connections are waiting for the daemon's attention, subsequent connection
17628 attempts are refused at the TCP/IP level. At least, that is what the manuals
17629 say; in some circumstances such connection attempts have been observed to time
17630 out instead. For large systems it is probably a good idea to increase the
17631 value (to 50, say). It also gives some protection against denial-of-service
17632 attacks by SYN flooding.
17633
17634
17635 .option smtp_enforce_sync main boolean true
17636 .cindex "SMTP" "synchronization checking"
17637 .cindex "synchronization checking in SMTP"
17638 The SMTP protocol specification requires the client to wait for a response from
17639 the server at certain points in the dialogue. Without PIPELINING these
17640 synchronization points are after every command; with PIPELINING they are
17641 fewer, but they still exist.
17642
17643 Some spamming sites send out a complete set of SMTP commands without waiting
17644 for any response. Exim protects against this by rejecting a message if the
17645 client has sent further input when it should not have. The error response &"554
17646 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17647 for this error cannot be perfect because of transmission delays (unexpected
17648 input may be on its way but not yet received when Exim checks). However, it
17649 does detect many instances.
17650
17651 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17652 If you want to disable the check selectively (for example, only for certain
17653 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17654 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17655
17656
17657
17658 .option smtp_etrn_command main string&!! unset
17659 .cindex "ETRN" "command to be run"
17660 .cindex "ESMTP extensions" ETRN
17661 .vindex "&$domain$&"
17662 If this option is set, the given command is run whenever an SMTP ETRN
17663 command is received from a host that is permitted to issue such commands (see
17664 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17665 are independently expanded. The expansion variable &$domain$& is set to the
17666 argument of the ETRN command, and no syntax checking is done on it. For
17667 example:
17668 .code
17669 smtp_etrn_command = /etc/etrn_command $domain \
17670                     $sender_host_address
17671 .endd
17672 If the option is not set, the argument for the ETRN command must
17673 be a &'#'& followed by an address string.
17674 In this case an &'exim -R <string>'& command is used;
17675 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17676
17677 A new process is created to run the command, but Exim does not wait for it to
17678 complete. Consequently, its status cannot be checked. If the command cannot be
17679 run, a line is written to the panic log, but the ETRN caller still receives
17680 a 250 success response. Exim is normally running under its own uid when
17681 receiving SMTP, so it is not possible for it to change the uid before running
17682 the command.
17683
17684
17685 .option smtp_etrn_serialize main boolean true
17686 .cindex "ETRN" "serializing"
17687 When this option is set, it prevents the simultaneous execution of more than
17688 one identical command as a result of ETRN in an SMTP connection. See
17689 section &<<SECTETRN>>& for details.
17690
17691
17692 .option smtp_load_reserve main fixed-point unset
17693 .cindex "load average"
17694 If the system load average ever gets higher than this, incoming SMTP calls are
17695 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17696 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17697 the load is over the limit. The option has no effect on ancient operating
17698 systems on which Exim cannot determine the load average. See also
17699 &%deliver_queue_load_max%& and &%queue_only_load%&.
17700
17701
17702
17703 .option smtp_max_synprot_errors main integer 3
17704 .cindex "SMTP" "limiting syntax and protocol errors"
17705 .cindex "limit" "SMTP syntax and protocol errors"
17706 Exim rejects SMTP commands that contain syntax or protocol errors. In
17707 particular, a syntactically invalid email address, as in this command:
17708 .code
17709 RCPT TO:<abc xyz@a.b.c>
17710 .endd
17711 causes immediate rejection of the command, before any other tests are done.
17712 (The ACL cannot be run if there is no valid address to set up for it.) An
17713 example of a protocol error is receiving RCPT before MAIL. If there are
17714 too many syntax or protocol errors in one SMTP session, the connection is
17715 dropped. The limit is set by this option.
17716
17717 .cindex "PIPELINING" "expected errors"
17718 When the PIPELINING extension to SMTP is in use, some protocol errors are
17719 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17720 Exim assumes that PIPELINING will be used if it advertises it (see
17721 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17722 not count towards the limit.
17723
17724
17725
17726 .option smtp_max_unknown_commands main integer 3
17727 .cindex "SMTP" "limiting unknown commands"
17728 .cindex "limit" "unknown SMTP commands"
17729 If there are too many unrecognized commands in an incoming SMTP session, an
17730 Exim server drops the connection. This is a defence against some kinds of abuse
17731 that subvert web
17732 clients
17733 into making connections to SMTP ports; in these circumstances, a number of
17734 non-SMTP command lines are sent first.
17735
17736
17737
17738 .option smtp_ratelimit_hosts main "host list&!!" unset
17739 .cindex "SMTP" "rate limiting"
17740 .cindex "limit" "rate of message arrival"
17741 .cindex "RCPT" "rate limiting"
17742 Some sites find it helpful to be able to limit the rate at which certain hosts
17743 can send them messages, and the rate at which an individual message can specify
17744 recipients.
17745
17746 Exim has two rate-limiting facilities. This section describes the older
17747 facility, which can limit rates within a single connection. The newer
17748 &%ratelimit%& ACL condition can limit rates across all connections. See section
17749 &<<SECTratelimiting>>& for details of the newer facility.
17750
17751 When a host matches &%smtp_ratelimit_hosts%&, the values of
17752 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17753 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17754 respectively. Each option, if set, must contain a set of four comma-separated
17755 values:
17756
17757 .ilist
17758 A threshold, before which there is no rate limiting.
17759 .next
17760 An initial time delay. Unlike other times in Exim, numbers with decimal
17761 fractional parts are allowed here.
17762 .next
17763 A factor by which to increase the delay each time.
17764 .next
17765 A maximum value for the delay. This should normally be less than 5 minutes,
17766 because after that time, the client is liable to timeout the SMTP command.
17767 .endlist
17768
17769 For example, these settings have been used successfully at the site which
17770 first suggested this feature, for controlling mail from their customers:
17771 .code
17772 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17773 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17774 .endd
17775 The first setting specifies delays that are applied to MAIL commands after
17776 two have been received over a single connection. The initial delay is 0.5
17777 seconds, increasing by a factor of 1.05 each time. The second setting applies
17778 delays to RCPT commands when more than four occur in a single message.
17779
17780
17781 .option smtp_ratelimit_mail main string unset
17782 See &%smtp_ratelimit_hosts%& above.
17783
17784
17785 .option smtp_ratelimit_rcpt main string unset
17786 See &%smtp_ratelimit_hosts%& above.
17787
17788
17789 .option smtp_receive_timeout main time&!! 5m
17790 .cindex "timeout" "for SMTP input"
17791 .cindex "SMTP" "input timeout"
17792 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17793 input, including batch SMTP. If a line of input (either an SMTP command or a
17794 data line) is not received within this time, the SMTP connection is dropped and
17795 the message is abandoned.
17796 A line is written to the log containing one of the following messages:
17797 .code
17798 SMTP command timeout on connection from...
17799 SMTP data timeout on connection from...
17800 .endd
17801 The former means that Exim was expecting to read an SMTP command; the latter
17802 means that it was in the DATA phase, reading the contents of a message.
17803
17804 If the first character of the option is a &"$"& the option is
17805 expanded before use and may depend on
17806 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17807
17808
17809 .oindex "&%-os%&"
17810 The value set by this option can be overridden by the
17811 &%-os%& command-line option. A setting of zero time disables the timeout, but
17812 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17813 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17814 timeout is controlled by &%receive_timeout%& and &%-or%&.
17815
17816
17817 .option smtp_reserve_hosts main "host list&!!" unset
17818 This option defines hosts for which SMTP connections are reserved; see
17819 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17820
17821
17822 .option smtp_return_error_details main boolean false
17823 .cindex "SMTP" "details policy failures"
17824 .cindex "policy control" "rejection, returning details"
17825 In the default state, Exim uses bland messages such as
17826 &"Administrative prohibition"& when it rejects SMTP commands for policy
17827 reasons. Many sysadmins like this because it gives away little information
17828 to spammers. However, some other sysadmins who are applying strict checking
17829 policies want to give out much fuller information about failures. Setting
17830 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17831 example, instead of &"Administrative prohibition"&, it might give:
17832 .code
17833 550-Rejected after DATA: '>' missing at end of address:
17834 550 failing address in "From" header is: <user@dom.ain
17835 .endd
17836
17837
17838 .option smtputf8_advertise_hosts main "host list&!!" *
17839 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17840 .cindex "ESMTP extensions" SMTPUTF8
17841 When Exim is built with support for internationalised mail names,
17842 the availability thereof is advertised in
17843 response to EHLO only to those client hosts that match this option. See
17844 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17845
17846
17847 .option spamd_address main string "127.0.0.1 783"
17848 This option is available when Exim is compiled with the content-scanning
17849 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17850 See section &<<SECTscanspamass>>& for more details.
17851
17852
17853
17854 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17855 This option is available when Exim is compiled with SPF support.
17856 See section &<<SECSPF>>& for more details.
17857
17858 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17859 This option is available when Exim is compiled with SPF support.  It
17860 allows the customisation of the SMTP comment that the SPF library
17861 generates.  You are strongly encouraged to link to your own explanative
17862 site. The template must not contain spaces. If you need spaces in the
17863 output, use the proper placeholder. If libspf2 can not parse the
17864 template, it uses a built-in default broken link. The following placeholders
17865 (along with Exim variables (but see below)) are allowed in the template:
17866 .ilist
17867 &*%_*&: A space.
17868 .next
17869 &*%{L}*&: Envelope sender's local part.
17870 .next
17871 &*%{S}*&: Envelope sender.
17872 .next
17873 &*%{O}*&: Envelope sender's domain.
17874 .next
17875 &*%{D}*&: Current(?) domain.
17876 .next
17877 &*%{I}*&: SMTP client Ip.
17878 .next
17879 &*%{C}*&: SMTP client pretty IP.
17880 .next
17881 &*%{T}*&: Epoch time (UTC).
17882 .next
17883 &*%{P}*&: SMTP client domain name.
17884 .next
17885 &*%{V}*&: IP version.
17886 .next
17887 &*%{H}*&: EHLO/HELO domain.
17888 .next
17889 &*%{R}*&: Receiving domain.
17890 .endlist
17891 The capitalized placeholders do proper URL encoding, if you use them
17892 lowercased, no encoding takes place.  This list was compiled from the
17893 libspf2 sources.
17894
17895 A note on using Exim variables: As
17896 currently the SPF library is initialized before the SMTP EHLO phase,
17897 the variables useful for expansion are quite limited.
17898
17899
17900 .option split_spool_directory main boolean false
17901 .cindex "multiple spool directories"
17902 .cindex "spool directory" "split"
17903 .cindex "directories, multiple"
17904 If this option is set, it causes Exim to split its input directory into 62
17905 subdirectories, each with a single alphanumeric character as its name. The
17906 sixth character of the message id is used to allocate messages to
17907 subdirectories; this is the least significant base-62 digit of the time of
17908 arrival of the message.
17909
17910 Splitting up the spool in this way may provide better performance on systems
17911 where there are long mail queues, by reducing the number of files in any one
17912 directory. The msglog directory is also split up in a similar way to the input
17913 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17914 are still placed in the single directory &_msglog.OLD_&.
17915
17916 It is not necessary to take any special action for existing messages when
17917 changing &%split_spool_directory%&. Exim notices messages that are in the
17918 &"wrong"& place, and continues to process them. If the option is turned off
17919 after a period of being on, the subdirectories will eventually empty and be
17920 automatically deleted.
17921
17922 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17923 changes. Instead of creating a list of all messages in the queue, and then
17924 trying to deliver each one, in turn, it constructs a list of those in one
17925 sub-directory and tries to deliver them, before moving on to the next
17926 sub-directory. The sub-directories are processed in a random order. This
17927 spreads out the scanning of the input directories, and uses less memory. It is
17928 particularly beneficial when there are lots of messages in the queue. However,
17929 if &%queue_run_in_order%& is set, none of this new processing happens. The
17930 entire queue has to be scanned and sorted before any deliveries can start.
17931
17932
17933 .option spool_directory main string&!! "set at compile time"
17934 .cindex "spool directory" "path to"
17935 This defines the directory in which Exim keeps its spool, that is, the messages
17936 it is waiting to deliver. The default value is taken from the compile-time
17937 configuration setting, if there is one. If not, this option must be set. The
17938 string is expanded, so it can contain, for example, a reference to
17939 &$primary_hostname$&.
17940
17941 If the spool directory name is fixed on your installation, it is recommended
17942 that you set it at build time rather than from this option, particularly if the
17943 log files are being written to the spool directory (see &%log_file_path%&).
17944 Otherwise log files cannot be used for errors that are detected early on, such
17945 as failures in the configuration file.
17946
17947 By using this option to override the compiled-in path, it is possible to run
17948 tests of Exim without using the standard spool.
17949
17950 .option spool_wireformat main boolean false
17951 .cindex "spool directory" "file formats"
17952 If this option is set, Exim may for some messages use an alternative format
17953 for data-files in the spool which matches the wire format.
17954 Doing this permits more efficient message reception and transmission.
17955 Currently it is only done for messages received using the ESMTP CHUNKING
17956 option.
17957
17958 The following variables will not have useful values:
17959 .code
17960 $max_received_linelength
17961 $body_linecount
17962 $body_zerocount
17963 .endd
17964
17965 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17966 and any external programs which are passed a reference to a message data file
17967 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17968 will need to be aware of the different formats potentially available.
17969
17970 Using any of the ACL conditions noted will negate the reception benefit
17971 (as a Unix-mbox-format file is constructed for them).
17972 The transmission benefit is maintained.
17973
17974 .option sqlite_lock_timeout main time 5s
17975 .cindex "sqlite lookup type" "lock timeout"
17976 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17977 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17978
17979 .option strict_acl_vars main boolean false
17980 .cindex "&ACL;" "variables, handling unset"
17981 This option controls what happens if a syntactically valid but undefined ACL
17982 variable is referenced. If it is false (the default), an empty string
17983 is substituted; if it is true, an error is generated. See section
17984 &<<SECTaclvariables>>& for details of ACL variables.
17985
17986 .option strip_excess_angle_brackets main boolean false
17987 .cindex "angle brackets, excess"
17988 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17989 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17990 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17991 passed on to another MTA, the excess angle brackets are not passed on. If this
17992 option is not set, multiple pairs of angle brackets cause a syntax error.
17993
17994
17995 .option strip_trailing_dot main boolean false
17996 .cindex "trailing dot on domain"
17997 .cindex "dot" "trailing on domain"
17998 If this option is set, a trailing dot at the end of a domain in an address is
17999 ignored. If this is in the envelope and the message is passed on to another
18000 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18001 domain causes a syntax error.
18002 However, addresses in header lines are checked only when an ACL requests header
18003 syntax checking.
18004
18005
18006 .option syslog_duplication main boolean true
18007 .cindex "syslog" "duplicate log lines; suppressing"
18008 When Exim is logging to syslog, it writes the log lines for its three
18009 separate logs at different syslog priorities so that they can in principle
18010 be separated on the logging hosts. Some installations do not require this
18011 separation, and in those cases, the duplication of certain log lines is a
18012 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18013 particular log line is written to syslog. For lines that normally go to
18014 both the main log and the reject log, the reject log version (possibly
18015 containing message header lines) is written, at LOG_NOTICE priority.
18016 Lines that normally go to both the main and the panic log are written at
18017 the LOG_ALERT priority.
18018
18019
18020 .option syslog_facility main string unset
18021 .cindex "syslog" "facility; setting"
18022 This option sets the syslog &"facility"& name, used when Exim is logging to
18023 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18024 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18025 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18026 details of Exim's logging.
18027
18028
18029 .option syslog_pid main boolean true
18030 .cindex "syslog" "pid"
18031 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18032 omitted when these lines are sent to syslog. (Syslog normally prefixes
18033 the log lines with the PID of the logging process automatically.) You need
18034 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18035 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18036
18037
18038
18039 .option syslog_processname main string &`exim`&
18040 .cindex "syslog" "process name; setting"
18041 This option sets the syslog &"ident"& name, used when Exim is logging to
18042 syslog. The value must be no longer than 32 characters. See chapter
18043 &<<CHAPlog>>& for details of Exim's logging.
18044
18045
18046
18047 .option syslog_timestamp main boolean true
18048 .cindex "syslog" "timestamps"
18049 .cindex timestamps syslog
18050 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18051 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18052 details of Exim's logging.
18053
18054
18055 .option system_filter main string&!! unset
18056 .cindex "filter" "system filter"
18057 .cindex "system filter" "specifying"
18058 .cindex "Sieve filter" "not available for system filter"
18059 This option specifies an Exim filter file that is applied to all messages at
18060 the start of each delivery attempt, before any routing is done. System filters
18061 must be Exim filters; they cannot be Sieve filters. If the system filter
18062 generates any deliveries to files or pipes, or any new mail messages, the
18063 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18064 which transports are to be used. Details of this facility are given in chapter
18065 &<<CHAPsystemfilter>>&.
18066 A forced expansion failure results in no filter operation.
18067
18068
18069 .option system_filter_directory_transport main string&!! unset
18070 .vindex "&$address_file$&"
18071 This sets the name of the transport driver that is to be used when the
18072 &%save%& command in a system message filter specifies a path ending in &"/"&,
18073 implying delivery of each message into a separate file in some directory.
18074 During the delivery, the variable &$address_file$& contains the path name.
18075
18076
18077 .option system_filter_file_transport main string&!! unset
18078 .cindex "file" "transport for system filter"
18079 This sets the name of the transport driver that is to be used when the &%save%&
18080 command in a system message filter specifies a path not ending in &"/"&. During
18081 the delivery, the variable &$address_file$& contains the path name.
18082
18083 .option system_filter_group main string unset
18084 .cindex "gid (group id)" "system filter"
18085 This option is used only when &%system_filter_user%& is also set. It sets the
18086 gid under which the system filter is run, overriding any gid that is associated
18087 with the user. The value may be numerical or symbolic.
18088
18089 .option system_filter_pipe_transport main string&!! unset
18090 .cindex "&(pipe)& transport" "for system filter"
18091 .vindex "&$address_pipe$&"
18092 This specifies the transport driver that is to be used when a &%pipe%& command
18093 is used in a system filter. During the delivery, the variable &$address_pipe$&
18094 contains the pipe command.
18095
18096
18097 .option system_filter_reply_transport main string&!! unset
18098 .cindex "&(autoreply)& transport" "for system filter"
18099 This specifies the transport driver that is to be used when a &%mail%& command
18100 is used in a system filter.
18101
18102
18103 .option system_filter_user main string unset
18104 .cindex "uid (user id)" "system filter"
18105 If this option is set to root, the system filter is run in the main Exim
18106 delivery process, as root.  Otherwise, the system filter runs in a separate
18107 process, as the given user, defaulting to the Exim run-time user.
18108 Unless the string consists entirely of digits, it
18109 is looked up in the password data. Failure to find the named user causes a
18110 configuration error. The gid is either taken from the password data, or
18111 specified by &%system_filter_group%&. When the uid is specified numerically,
18112 &%system_filter_group%& is required to be set.
18113
18114 If the system filter generates any pipe, file, or reply deliveries, the uid
18115 under which the filter is run is used when transporting them, unless a
18116 transport option overrides.
18117
18118
18119 .option tcp_nodelay main boolean true
18120 .cindex "daemon" "TCP_NODELAY on sockets"
18121 .cindex "Nagle algorithm"
18122 .cindex "TCP_NODELAY on listening sockets"
18123 If this option is set false, it stops the Exim daemon setting the
18124 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18125 turns off the &"Nagle algorithm"&, which is a way of improving network
18126 performance in interactive (character-by-character) situations. Turning it off
18127 should improve Exim's performance a bit, so that is what happens by default.
18128 However, it appears that some broken clients cannot cope, and time out. Hence
18129 this option. It affects only those sockets that are set up for listening by the
18130 daemon. Sockets created by the smtp transport for delivering mail always set
18131 TCP_NODELAY.
18132
18133
18134 .option timeout_frozen_after main time 0s
18135 .cindex "frozen messages" "timing out"
18136 .cindex "timeout" "frozen messages"
18137 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18138 message of any kind that has been in the queue for longer than the given time
18139 is automatically cancelled at the next queue run. If the frozen message is a
18140 bounce message, it is just discarded; otherwise, a bounce is sent to the
18141 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18142 If you want to timeout frozen bounce messages earlier than other kinds of
18143 frozen message, see &%ignore_bounce_errors_after%&.
18144
18145 &*Note:*& the default value of zero means no timeouts; with this setting,
18146 frozen messages remain in the queue forever (except for any frozen bounce
18147 messages that are released by &%ignore_bounce_errors_after%&).
18148
18149
18150 .option timezone main string unset
18151 .cindex "timezone, setting"
18152 .cindex "environment" "values from"
18153 The value of &%timezone%& is used to set the environment variable TZ while
18154 running Exim (if it is different on entry). This ensures that all timestamps
18155 created by Exim are in the required timezone. If you want all your timestamps
18156 to be in UTC (aka GMT) you should set
18157 .code
18158 timezone = UTC
18159 .endd
18160 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18161 or, if that is not set, from the value of the TZ environment variable when Exim
18162 is built. If &%timezone%& is set to the empty string, either at build or run
18163 time, any existing TZ variable is removed from the environment when Exim
18164 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18165 unfortunately not all, operating systems.
18166
18167
18168 .option tls_advertise_hosts main "host list&!!" *
18169 .cindex "TLS" "advertising"
18170 .cindex "encryption" "on SMTP connection"
18171 .cindex "SMTP" "encrypted connection"
18172 .cindex "ESMTP extensions" STARTTLS
18173 When Exim is built with support for TLS encrypted connections, the availability
18174 of the STARTTLS command to set up an encrypted session is advertised in
18175 response to EHLO only to those client hosts that match this option. See
18176 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18177 Note that the default value requires that a certificate be supplied
18178 using the &%tls_certificate%& option.  If TLS support for incoming connections
18179 is not required the &%tls_advertise_hosts%& option should be set empty.
18180
18181
18182 .option tls_certificate main string list&!! unset
18183 .cindex "TLS" "server certificate; location of"
18184 .cindex "certificate" "server, location of"
18185 The value of this option is expanded, and must then be a list of absolute paths to
18186 files which contain the server's certificates (in PEM format).
18187 Commonly only one file is needed.
18188 The server's private key is also
18189 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18190 &<<CHAPTLS>>& for further details.
18191
18192 &*Note*&: The certificates defined by this option are used only when Exim is
18193 receiving incoming messages as a server. If you want to supply certificates for
18194 use when sending messages as a client, you must set the &%tls_certificate%&
18195 option in the relevant &(smtp)& transport.
18196
18197 &*Note*&: If you use filenames based on IP addresses, change the list
18198 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18199
18200 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18201 when a list of more than one
18202 file is used, the &$tls_in_ourcert$& variable is unreliable.
18203 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18204
18205 .cindex SNI "selecting server certificate based on"
18206 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18207 if the OpenSSL build supports TLS extensions and the TLS client sends the
18208 Server Name Indication extension, then this option and others documented in
18209 &<<SECTtlssni>>& will be re-expanded.
18210
18211 If this option is unset or empty a fresh self-signed certificate will be
18212 generated for every connection.
18213
18214 .option tls_crl main string&!! unset
18215 .cindex "TLS" "server certificate revocation list"
18216 .cindex "certificate" "revocation list for server"
18217 This option specifies a certificate revocation list. The expanded value must
18218 be the name of a file that contains CRLs in PEM format.
18219
18220 Under OpenSSL the option can specify a directory with CRL files.
18221
18222 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18223 for each signing element of the certificate chain (i.e. all but the leaf).
18224 For the file variant this can be multiple PEM blocks in the one file.
18225
18226 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18227
18228
18229 .option tls_dh_max_bits main integer 2236
18230 .cindex "TLS" "D-H bit count"
18231 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18232 the chosen TLS library.  That value might prove to be too high for
18233 interoperability.  This option provides a maximum clamp on the value
18234 suggested, trading off security for interoperability.
18235
18236 The value must be at least 1024.
18237
18238 The value 2236 was chosen because, at time of adding the option, it was the
18239 hard-coded maximum value supported by the NSS cryptographic library, as used
18240 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18241
18242 If you prefer more security and are willing to break some clients, raise this
18243 number.
18244
18245 Note that the value passed to GnuTLS for *generating* a new prime may be a
18246 little less than this figure, because GnuTLS is inexact and may produce a
18247 larger prime than requested.
18248
18249
18250 .option tls_dhparam main string&!! unset
18251 .cindex "TLS" "D-H parameters for server"
18252 The value of this option is expanded and indicates the source of DH parameters
18253 to be used by Exim.
18254
18255 This option is ignored for GnuTLS version 3.6.0 and later.
18256 The library manages parameter negotiation internally.
18257
18258 &*Note: The Exim Maintainers strongly recommend,
18259 for other TLS library versions,
18260 using a filename with site-generated
18261 local DH parameters*&, which has been supported across all versions of Exim.  The
18262 other specific constants available are a fallback so that even when
18263 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18264
18265 If &%tls_dhparam%& is a filename starting with a &`/`&,
18266 then it names a file from which DH
18267 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18268 PKCS#3 representation of the DH prime.  If the file does not exist, for
18269 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18270 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18271 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18272 and treated as though the &%tls_dhparam%& were set to "none".
18273
18274 If this option expands to the string "none", then no DH parameters will be
18275 loaded by Exim.
18276
18277 If this option expands to the string "historic" and Exim is using GnuTLS, then
18278 Exim will attempt to load a file from inside the spool directory.  If the file
18279 does not exist, Exim will attempt to create it.
18280 See section &<<SECTgnutlsparam>>& for further details.
18281
18282 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18283 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18284
18285 In older versions of Exim the default was the 2048 bit prime described in section
18286 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18287 in IKE is assigned number 23.
18288
18289 Otherwise, the option must expand to the name used by Exim for any of a number
18290 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18291 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18292 the number used by IKE, or "default" which corresponds to
18293 &`exim.dev.20160529.3`&.
18294
18295 The available standard primes are:
18296 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18297 &`ike1`&, &`ike2`&, &`ike5`&,
18298 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18299 &`ike22`&, &`ike23`& and &`ike24`&.
18300
18301 The available additional primes are:
18302 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18303
18304 Some of these will be too small to be accepted by clients.
18305 Some may be too large to be accepted by clients.
18306 The open cryptographic community has suspicions about the integrity of some
18307 of the later IKE values, which led into RFC7919 providing new fixed constants
18308 (the "ffdhe" identifiers).
18309
18310 At this point, all of the "ike" values should be considered obsolete;
18311 they're still in Exim to avoid breaking unusual configurations, but are
18312 candidates for removal the next time we have backwards-incompatible changes.
18313
18314 The TLS protocol does not negotiate an acceptable size for this; clients tend
18315 to hard-drop connections if what is offered by the server is unacceptable,
18316 whether too large or too small, and there's no provision for the client to
18317 tell the server what these constraints are.  Thus, as a server operator, you
18318 need to make an educated guess as to what is most likely to work for your
18319 userbase.
18320
18321 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18322 is most likely to maximise interoperability.  The upper bound comes from
18323 applications using the Mozilla Network Security Services (NSS) library, which
18324 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18325 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18326 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18327 acceptable bound from 1024 to 2048.
18328
18329
18330 .option tls_eccurve main string&!! &`auto`&
18331 .cindex TLS "EC cryptography"
18332 This option selects a EC curve for use by Exim when used with OpenSSL.
18333 It has no effect when Exim is used with GnuTLS.
18334
18335 After expansion it must contain a valid EC curve parameter, such as
18336 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18337 for valid selections.
18338
18339 For OpenSSL versions before (and not including) 1.0.2, the string
18340 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18341 &`auto`& tells the library to choose.
18342
18343 If the option expands to an empty string, no EC curves will be enabled.
18344
18345
18346 .option tls_ocsp_file main string&!! unset
18347 .cindex TLS "certificate status"
18348 .cindex TLS "OCSP proof file"
18349 This option
18350 must if set expand to the absolute path to a file which contains a current
18351 status proof for the server's certificate, as obtained from the
18352 Certificate Authority.
18353
18354 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18355 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18356
18357 For OpenSSL 1.1.0 or later, and
18358 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18359 of files, to match a list given for the &%tls_certificate%& option.
18360 The ordering of the two lists must match.
18361 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18362
18363 The file(s) should be in DER format,
18364 except for GnuTLS 3.6.3 or later
18365 or for OpenSSL,
18366 when an optional filetype prefix can be used.
18367 The prefix must be one of "DER" or "PEM", followed by
18368 a single space.  If one is used it sets the format for subsequent
18369 files in the list; the initial format is DER.
18370 If multiple proofs are wanted, for multiple chain elements
18371 (this only works under TLS1.3)
18372 they must be coded as a combined OCSP response.
18373
18374 Although GnuTLS will accept PEM files with multiple separate
18375 PEM blobs (ie. separate OCSP responses), it sends them in the
18376 TLS Certificate record interleaved with the certificates of the chain;
18377 although a GnuTLS client is happy with that, an OpenSSL client is not.
18378
18379 .option tls_on_connect_ports main "string list" unset
18380 .cindex SSMTP
18381 .cindex SMTPS
18382 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18383 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18384 set up without waiting for the client to issue a STARTTLS command. For
18385 further details, see section &<<SECTsupobssmt>>&.
18386
18387
18388
18389 .option tls_privatekey main string list&!! unset
18390 .cindex "TLS" "server private key; location of"
18391 The value of this option is expanded, and must then be a list of absolute paths to
18392 files which contains the server's private keys.
18393 If this option is unset, or if
18394 the expansion is forced to fail, or the result is an empty string, the private
18395 key is assumed to be in the same file as the server's certificates. See chapter
18396 &<<CHAPTLS>>& for further details.
18397
18398 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18399
18400
18401 .option tls_remember_esmtp main boolean false
18402 .cindex "TLS" "esmtp state; remembering"
18403 .cindex "TLS" "broken clients"
18404 If this option is set true, Exim violates the RFCs by remembering that it is in
18405 &"esmtp"& state after successfully negotiating a TLS session. This provides
18406 support for broken clients that fail to send a new EHLO after starting a
18407 TLS session.
18408
18409
18410 .option tls_require_ciphers main string&!! unset
18411 .cindex "TLS" "requiring specific ciphers"
18412 .cindex "cipher" "requiring specific"
18413 This option controls which ciphers can be used for incoming TLS connections.
18414 The &(smtp)& transport has an option of the same name for controlling outgoing
18415 connections. This option is expanded for each connection, so can be varied for
18416 different clients if required. The value of this option must be a list of
18417 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18418 in somewhat different ways. If GnuTLS is being used, the client controls the
18419 preference order of the available ciphers. Details are given in sections
18420 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18421
18422
18423 .new
18424 .option tls_resumption_hosts main "host list&!!" unset
18425 .cindex TLS resumption
18426 This option controls which connections to offer the TLS resumption feature.
18427 See &<<SECTresumption>>& for details.
18428 .wen
18429
18430
18431 .option tls_try_verify_hosts main "host list&!!" unset
18432 .cindex "TLS" "client certificate verification"
18433 .cindex "certificate" "verification of client"
18434 See &%tls_verify_hosts%& below.
18435
18436
18437 .option tls_verify_certificates main string&!! system
18438 .cindex "TLS" "client certificate verification"
18439 .cindex "certificate" "verification of client"
18440 The value of this option is expanded, and must then be either the
18441 word "system"
18442 or the absolute path to
18443 a file or directory containing permitted certificates for clients that
18444 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18445
18446 The "system" value for the option will use a
18447 system default location compiled into the SSL library.
18448 This is not available for GnuTLS versions preceding 3.0.20,
18449 and will be taken as empty; an explicit location
18450 must be specified.
18451
18452 The use of a directory for the option value is not available for GnuTLS versions
18453 preceding 3.3.6 and a single file must be used.
18454
18455 With OpenSSL the certificates specified
18456 explicitly
18457 either by file or directory
18458 are added to those given by the system default location.
18459
18460 These certificates should be for the certificate authorities trusted, rather
18461 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18462 the value is a file then the certificates are sent by Exim as a server to
18463 connecting clients, defining the list of accepted certificate authorities.
18464 Thus the values defined should be considered public data.  To avoid this,
18465 use the explicit directory version.
18466
18467 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18468
18469 A forced expansion failure or setting to an empty string is equivalent to
18470 being unset.
18471
18472
18473 .option tls_verify_hosts main "host list&!!" unset
18474 .cindex "TLS" "client certificate verification"
18475 .cindex "certificate" "verification of client"
18476 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18477 certificates from clients. The expected certificates are defined by
18478 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18479 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18480 &%tls_verify_certificates%& is not set.
18481
18482 Any client that matches &%tls_verify_hosts%& is constrained by
18483 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18484 present one of the listed certificates. If it does not, the connection is
18485 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18486 the host to use TLS. It can still send SMTP commands through unencrypted
18487 connections. Forcing a client to use TLS has to be done separately using an
18488 ACL to reject inappropriate commands when the connection is not encrypted.
18489
18490 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18491 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18492 certificate and checks it against &%tls_verify_certificates%&, but does not
18493 abort the connection if there is no certificate or if it does not match. This
18494 state can be detected in an ACL, which makes it possible to implement policies
18495 such as &"accept for relay only if a verified certificate has been received,
18496 but accept for local delivery if encrypted, even without a verified
18497 certificate"&.
18498
18499 Client hosts that match neither of these lists are not asked to present
18500 certificates.
18501
18502
18503 .option trusted_groups main "string list&!!" unset
18504 .cindex "trusted groups"
18505 .cindex "groups" "trusted"
18506 This option is expanded just once, at the start of Exim's processing. If this
18507 option is set, any process that is running in one of the listed groups, or
18508 which has one of them as a supplementary group, is trusted. The groups can be
18509 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18510 details of what trusted callers are permitted to do. If neither
18511 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18512 are trusted.
18513
18514 .option trusted_users main "string list&!!" unset
18515 .cindex "trusted users"
18516 .cindex "user" "trusted"
18517 This option is expanded just once, at the start of Exim's processing. If this
18518 option is set, any process that is running as one of the listed users is
18519 trusted. The users can be specified numerically or by name. See section
18520 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18521 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18522 Exim user are trusted.
18523
18524 .option unknown_login main string&!! unset
18525 .cindex "uid (user id)" "unknown caller"
18526 .vindex "&$caller_uid$&"
18527 This is a specialized feature for use in unusual configurations. By default, if
18528 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18529 gives up. The &%unknown_login%& option can be used to set a login name to be
18530 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18531 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18532 is used for the user's real name (gecos field), unless this has been set by the
18533 &%-F%& option.
18534
18535 .option unknown_username main string unset
18536 See &%unknown_login%&.
18537
18538 .option untrusted_set_sender main "address list&!!" unset
18539 .cindex "trusted users"
18540 .cindex "sender" "setting by untrusted user"
18541 .cindex "untrusted user setting sender"
18542 .cindex "user" "untrusted setting sender"
18543 .cindex "envelope from"
18544 .cindex "envelope sender"
18545 When an untrusted user submits a message to Exim using the standard input, Exim
18546 normally creates an envelope sender address from the user's login and the
18547 default qualification domain. Data from the &%-f%& option (for setting envelope
18548 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18549 is used) is ignored.
18550
18551 However, untrusted users are permitted to set an empty envelope sender address,
18552 to declare that a message should never generate any bounces. For example:
18553 .code
18554 exim -f '<>' user@domain.example
18555 .endd
18556 .vindex "&$sender_ident$&"
18557 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18558 other envelope sender addresses in a controlled way. When it is set, untrusted
18559 users are allowed to set envelope sender addresses that match any of the
18560 patterns in the list. Like all address lists, the string is expanded. The
18561 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18562 users to setting senders that start with their login ids
18563 followed by a hyphen
18564 by a setting like this:
18565 .code
18566 untrusted_set_sender = ^$sender_ident-
18567 .endd
18568 If you want to allow untrusted users to set envelope sender addresses without
18569 restriction, you can use
18570 .code
18571 untrusted_set_sender = *
18572 .endd
18573 The &%untrusted_set_sender%& option applies to all forms of local input, but
18574 only to the setting of the envelope sender. It does not permit untrusted users
18575 to use the other options which trusted user can use to override message
18576 parameters. Furthermore, it does not stop Exim from removing an existing
18577 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18578 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18579 overriding these actions. The handling of the &'Sender:'& header is also
18580 described in section &<<SECTthesenhea>>&.
18581
18582 The log line for a message's arrival shows the envelope sender following
18583 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18584 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18585 envelope sender address, the user's login is shown in parentheses after the
18586 sender address.
18587
18588
18589 .option uucp_from_pattern main string "see below"
18590 .cindex "&""From""& line"
18591 .cindex "UUCP" "&""From""& line"
18592 Some applications that pass messages to an MTA via a command line interface use
18593 an initial line starting with &"From&~"& to pass the envelope sender. In
18594 particular, this is used by UUCP software. Exim recognizes such a line by means
18595 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18596 matches, the sender address is constructed by expanding the contents of
18597 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18598 default pattern recognizes lines in the following two forms:
18599 .code
18600 From ph10 Fri Jan  5 12:35 GMT 1996
18601 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18602 .endd
18603 The pattern can be seen by running
18604 .code
18605 exim -bP uucp_from_pattern
18606 .endd
18607 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18608 year in the second case. The first word after &"From&~"& is matched in the
18609 regular expression by a parenthesized subpattern. The default value for
18610 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18611 (&"ph10"& in the example above) as the message's sender. See also
18612 &%ignore_fromline_hosts%&.
18613
18614
18615 .option uucp_from_sender main string&!! &`$1`&
18616 See &%uucp_from_pattern%& above.
18617
18618
18619 .option warn_message_file main string&!! unset
18620 .cindex "warning of delay" "customizing the message"
18621 .cindex "customizing" "warning message"
18622 This option defines a template file containing paragraphs of text to be used
18623 for constructing the warning message which is sent by Exim when a message has
18624 been in the queue for a specified amount of time, as specified by
18625 &%delay_warning%&. Details of the file's contents are given in chapter
18626 &<<CHAPemsgcust>>&.
18627 .cindex warn_message_file "tainted data"
18628 The option is expanded to give the file path, which must be
18629 absolute and untainted.
18630 See also &%bounce_message_file%&.
18631
18632
18633 .option write_rejectlog main boolean true
18634 .cindex "reject log" "disabling"
18635 If this option is set false, Exim no longer writes anything to the reject log.
18636 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18637 .ecindex IIDconfima
18638 .ecindex IIDmaiconf
18639
18640
18641
18642
18643 . ////////////////////////////////////////////////////////////////////////////
18644 . ////////////////////////////////////////////////////////////////////////////
18645
18646 .chapter "Generic options for routers" "CHAProutergeneric"
18647 .scindex IIDgenoprou1 "options" "generic; for routers"
18648 .scindex IIDgenoprou2 "generic options" "router"
18649 This chapter describes the generic options that apply to all routers.
18650 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18651
18652 For a general description of how a router operates, see sections
18653 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18654 which the preconditions are tested. The order of expansion of the options that
18655 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18656 &%headers_remove%&, &%transport%&.
18657
18658
18659
18660 .option address_data routers string&!! unset
18661 .cindex "router" "data attached to address"
18662 The string is expanded just before the router is run, that is, after all the
18663 precondition tests have succeeded. If the expansion is forced to fail, the
18664 router declines, the value of &%address_data%& remains unchanged, and the
18665 &%more%& option controls what happens next. Other expansion failures cause
18666 delivery of the address to be deferred.
18667
18668 .vindex "&$address_data$&"
18669 When the expansion succeeds, the value is retained with the address, and can be
18670 accessed using the variable &$address_data$& in the current router, subsequent
18671 routers, and the eventual transport.
18672
18673 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18674 that runs a user's filter file, the contents of &$address_data$& are accessible
18675 in the filter. This is not normally a problem, because such data is usually
18676 either not confidential or it &"belongs"& to the current user, but if you do
18677 put confidential data into &$address_data$& you need to remember this point.
18678
18679 Even if the router declines or passes, the value of &$address_data$& remains
18680 with the address, though it can be changed by another &%address_data%& setting
18681 on a subsequent router. If a router generates child addresses, the value of
18682 &$address_data$& propagates to them. This also applies to the special kind of
18683 &"child"& that is generated by a router with the &%unseen%& option.
18684
18685 The idea of &%address_data%& is that you can use it to look up a lot of data
18686 for the address once, and then pick out parts of the data later. For example,
18687 you could use a single LDAP lookup to return a string of the form
18688 .code
18689 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18690 .endd
18691 In the transport you could pick out the mailbox by a setting such as
18692 .code
18693 file = ${extract{mailbox}{$address_data}}
18694 .endd
18695 This makes the configuration file less messy, and also reduces the number of
18696 lookups (though Exim does cache lookups).
18697
18698 See also the &%set%& option below.
18699
18700 .vindex "&$sender_address_data$&"
18701 .vindex "&$address_data$&"
18702 The &%address_data%& facility is also useful as a means of passing information
18703 from one router to another, and from a router to a transport. In addition, if
18704 &$address_data$& is set by a router when verifying a recipient address from an
18705 ACL, it remains available for use in the rest of the ACL statement. After
18706 verifying a sender, the value is transferred to &$sender_address_data$&.
18707
18708
18709
18710 .option address_test routers&!? boolean true
18711 .oindex "&%-bt%&"
18712 .cindex "router" "skipping when address testing"
18713 If this option is set false, the router is skipped when routing is being tested
18714 by means of the &%-bt%& command line option. This can be a convenience when
18715 your first router sends messages to an external scanner, because it saves you
18716 having to set the &"already scanned"& indicator when testing real address
18717 routing.
18718
18719
18720
18721 .option cannot_route_message routers string&!! unset
18722 .cindex "router" "customizing &""cannot route""& message"
18723 .cindex "customizing" "&""cannot route""& message"
18724 This option specifies a text message that is used when an address cannot be
18725 routed because Exim has run out of routers. The default message is
18726 &"Unrouteable address"&. This option is useful only on routers that have
18727 &%more%& set false, or on the very last router in a configuration, because the
18728 value that is used is taken from the last router that is considered. This
18729 includes a router that is skipped because its preconditions are not met, as
18730 well as a router that declines. For example, using the default configuration,
18731 you could put:
18732 .code
18733 cannot_route_message = Remote domain not found in DNS
18734 .endd
18735 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18736 and
18737 .code
18738 cannot_route_message = Unknown local user
18739 .endd
18740 on the final router that checks for local users. If string expansion fails for
18741 this option, the default message is used. Unless the expansion failure was
18742 explicitly forced, a message about the failure is written to the main and panic
18743 logs, in addition to the normal message about the routing failure.
18744
18745
18746 .option caseful_local_part routers boolean false
18747 .cindex "case of local parts"
18748 .cindex "router" "case of local parts"
18749 By default, routers handle the local parts of addresses in a case-insensitive
18750 manner, though the actual case is preserved for transmission with the message.
18751 If you want the case of letters to be significant in a router, you must set
18752 this option true. For individual router options that contain address or local
18753 part lists (for example, &%local_parts%&), case-sensitive matching can be
18754 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18755 more details.
18756
18757 .vindex "&$local_part$&"
18758 .vindex "&$original_local_part$&"
18759 .vindex "&$parent_local_part$&"
18760 The value of the &$local_part$& variable is forced to lower case while a
18761 router is running unless &%caseful_local_part%& is set. When a router assigns
18762 an address to a transport, the value of &$local_part$& when the transport runs
18763 is the same as it was in the router. Similarly, when a router generates child
18764 addresses by aliasing or forwarding, the values of &$original_local_part$&
18765 and &$parent_local_part$& are those that were used by the redirecting router.
18766
18767 This option applies to the processing of an address by a router. When a
18768 recipient address is being processed in an ACL, there is a separate &%control%&
18769 modifier that can be used to specify case-sensitive processing within the ACL
18770 (see section &<<SECTcontrols>>&).
18771
18772
18773
18774 .option check_local_user routers&!? boolean false
18775 .cindex "local user, checking in router"
18776 .cindex "router" "checking for local user"
18777 .cindex "&_/etc/passwd_&"
18778 .vindex "&$home$&"
18779 When this option is true, Exim checks that the local part of the recipient
18780 address (with affixes removed if relevant) is the name of an account on the
18781 local system. The check is done by calling the &[getpwnam()]& function rather
18782 than trying to read &_/etc/passwd_& directly. This means that other methods of
18783 holding password data (such as NIS) are supported. If the local part is a local
18784 user, &$home$& is set from the password data, and can be tested in other
18785 preconditions that are evaluated after this one (the order of evaluation is
18786 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18787 overridden by &%router_home_directory%&. If the local part is not a local user,
18788 the router is skipped.
18789
18790 If you want to check that the local part is either the name of a local user
18791 or matches something else, you cannot combine &%check_local_user%& with a
18792 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18793 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18794 setting to achieve this. For example:
18795 .code
18796 local_parts = passwd;$local_part : lsearch;/etc/other/users
18797 .endd
18798 Note, however, that the side effects of &%check_local_user%& (such as setting
18799 up a home directory) do not occur when a &(passwd)& lookup is used in a
18800 &%local_parts%& (or any other) precondition.
18801
18802
18803
18804 .option condition routers&!? string&!! unset
18805 .cindex "router" "customized precondition"
18806 This option specifies a general precondition test that has to succeed for the
18807 router to be called. The &%condition%& option is the last precondition to be
18808 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18809 result is a forced failure, or an empty string, or one of the strings &"0"& or
18810 &"no"& or &"false"& (checked without regard to the case of the letters), the
18811 router is skipped, and the address is offered to the next one.
18812
18813 If the result is any other value, the router is run (as this is the last
18814 precondition to be evaluated, all the other preconditions must be true).
18815
18816 This option is unusual in that multiple &%condition%& options may be present.
18817 All &%condition%& options must succeed.
18818
18819 The &%condition%& option provides a means of applying custom conditions to the
18820 running of routers. Note that in the case of a simple conditional expansion,
18821 the default expansion values are exactly what is wanted. For example:
18822 .code
18823 condition = ${if >{$message_age}{600}}
18824 .endd
18825 Because of the default behaviour of the string expansion, this is equivalent to
18826 .code
18827 condition = ${if >{$message_age}{600}{true}{}}
18828 .endd
18829
18830 A multiple condition example, which succeeds:
18831 .code
18832 condition = ${if >{$message_age}{600}}
18833 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18834 condition = foobar
18835 .endd
18836
18837 If the expansion fails (other than forced failure) delivery is deferred. Some
18838 of the other precondition options are common special cases that could in fact
18839 be specified using &%condition%&.
18840
18841 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18842 are far older, and use one set of semantics.  ACLs are newer and when
18843 they were created, the ACL &%condition%& process was given far stricter
18844 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18845 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18846 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18847 Router rules processing behavior.
18848
18849 This is best illustrated in an example:
18850 .code
18851 # If used in an ACL condition will fail with a syntax error, but
18852 # in a router condition any extra characters are treated as a string
18853
18854 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18855 true {yes} {no}}
18856
18857 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18858  {yes} {no}}
18859 .endd
18860 In each example above, the &%if%& statement actually ends after
18861 &"{google.com}}"&.  Since no true or false braces were defined, the
18862 default &%if%& behavior is to return a boolean true or a null answer
18863 (which evaluates to false). The rest of the line is then treated as a
18864 string. So the first example resulted in the boolean answer &"true"&
18865 with the string &" {yes} {no}}"& appended to it. The second example
18866 resulted in the null output (indicating false) with the string
18867 &" {yes} {no}}"& appended to it.
18868
18869 In fact you can put excess forward braces in too.  In the router
18870 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18871 mean something, like after a &"$"& or when required as part of a
18872 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18873 string characters.
18874
18875 Thus, in a Router, the above expansion strings will both always evaluate
18876 true, as the result of expansion is a non-empty string which doesn't
18877 match an explicit false value.  This can be tricky to debug.  By
18878 contrast, in an ACL either of those strings will always result in an
18879 expansion error because the result doesn't look sufficiently boolean.
18880
18881
18882 .option debug_print routers string&!! unset
18883 .cindex "testing" "variables in drivers"
18884 If this option is set and debugging is enabled (see the &%-d%& command line
18885 option) or in address-testing mode (see the &%-bt%& command line option),
18886 the string is expanded and included in the debugging output.
18887 If expansion of the string fails, the error message is written to the debugging
18888 output, and Exim carries on processing.
18889 This option is provided to help with checking out the values of variables and
18890 so on when debugging router configurations. For example, if a &%condition%&
18891 option appears not to be working, &%debug_print%& can be used to output the
18892 variables it references. The output happens after checks for &%domains%&,
18893 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18894 are tested. A newline is added to the text if it does not end with one.
18895 The variable &$router_name$& contains the name of the router.
18896
18897
18898
18899 .option disable_logging routers boolean false
18900 If this option is set true, nothing is logged for any routing errors
18901 or for any deliveries caused by this router. You should not set this option
18902 unless you really, really know what you are doing. See also the generic
18903 transport option of the same name.
18904
18905 .option dnssec_request_domains routers "domain list&!!" *
18906 .cindex "MX record" "security"
18907 .cindex "DNSSEC" "MX lookup"
18908 .cindex "security" "MX lookup"
18909 .cindex "DNS" "DNSSEC"
18910 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18911 the dnssec request bit set.
18912 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18913
18914 .option dnssec_require_domains routers "domain list&!!" unset
18915 .cindex "MX record" "security"
18916 .cindex "DNSSEC" "MX lookup"
18917 .cindex "security" "MX lookup"
18918 .cindex "DNS" "DNSSEC"
18919 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18920 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18921 (AD bit) set will be ignored and logged as a host-lookup failure.
18922 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18923
18924
18925 .option domains routers&!? "domain list&!!" unset
18926 .cindex "router" "restricting to specific domains"
18927 .vindex "&$domain_data$&"
18928 If this option is set, the router is skipped unless the current domain matches
18929 the list. If the match is achieved by means of a file lookup, the data that the
18930 lookup returned for the domain is placed in &$domain_data$& for use in string
18931 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18932 a list of the order in which preconditions are evaluated.
18933
18934
18935
18936 .option driver routers string unset
18937 This option must always be set. It specifies which of the available routers is
18938 to be used.
18939
18940
18941 .option dsn_lasthop routers boolean false
18942 .cindex "DSN" "success"
18943 .cindex "Delivery Status Notification" "success"
18944 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18945 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18946 instead send a success DSN as if the next hop does not support DSN.
18947 Not effective on redirect routers.
18948
18949
18950
18951 .option errors_to routers string&!! unset
18952 .cindex "envelope from"
18953 .cindex "envelope sender"
18954 .cindex "router" "changing address for errors"
18955 If a router successfully handles an address, it may assign the address to a
18956 transport for delivery or it may generate child addresses. In both cases, if
18957 there is a delivery problem during later processing, the resulting bounce
18958 message is sent to the address that results from expanding this string,
18959 provided that the address verifies successfully. The &%errors_to%& option is
18960 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18961
18962 The &%errors_to%& setting associated with an address can be overridden if it
18963 subsequently passes through other routers that have their own &%errors_to%&
18964 settings, or if the message is delivered by a transport with a &%return_path%&
18965 setting.
18966
18967 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18968 the expansion fails to verify, the errors address associated with the incoming
18969 address is used. At top level, this is the envelope sender. A non-forced
18970 expansion failure causes delivery to be deferred.
18971
18972 If an address for which &%errors_to%& has been set ends up being delivered over
18973 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18974 any bounces that are generated by other MTAs on the delivery route are also
18975 sent there. You can set &%errors_to%& to the empty string by either of these
18976 settings:
18977 .code
18978 errors_to =
18979 errors_to = ""
18980 .endd
18981 An expansion item that yields an empty string has the same effect. If you do
18982 this, a locally detected delivery error for addresses processed by this router
18983 no longer gives rise to a bounce message; the error is discarded. If the
18984 address is delivered to a remote host, the return path is set to &`<>`&, unless
18985 overridden by the &%return_path%& option on the transport.
18986
18987 .vindex "&$address_data$&"
18988 If for some reason you want to discard local errors, but use a non-empty
18989 MAIL command for remote delivery, you can preserve the original return
18990 path in &$address_data$& in the router, and reinstate it in the transport by
18991 setting &%return_path%&.
18992
18993 The most common use of &%errors_to%& is to direct mailing list bounces to the
18994 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18995 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18996
18997
18998
18999 .option expn routers&!? boolean true
19000 .cindex "address" "testing"
19001 .cindex "testing" "addresses"
19002 .cindex "EXPN" "router skipping"
19003 .cindex "router" "skipping for EXPN"
19004 If this option is turned off, the router is skipped when testing an address
19005 as a result of processing an SMTP EXPN command. You might, for example,
19006 want to turn it off on a router for users' &_.forward_& files, while leaving it
19007 on for the system alias file.
19008 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19009 are evaluated.
19010
19011 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19012 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19013 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19014
19015
19016
19017 .option fail_verify routers boolean false
19018 .cindex "router" "forcing verification failure"
19019 Setting this option has the effect of setting both &%fail_verify_sender%& and
19020 &%fail_verify_recipient%& to the same value.
19021
19022
19023
19024 .option fail_verify_recipient routers boolean false
19025 If this option is true and an address is accepted by this router when
19026 verifying a recipient, verification fails.
19027
19028
19029
19030 .option fail_verify_sender routers boolean false
19031 If this option is true and an address is accepted by this router when
19032 verifying a sender, verification fails.
19033
19034
19035
19036 .option fallback_hosts routers "string list" unset
19037 .cindex "router" "fallback hosts"
19038 .cindex "fallback" "hosts specified on router"
19039 String expansion is not applied to this option. The argument must be a
19040 colon-separated list of host names or IP addresses. The list separator can be
19041 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19042 each name or address. In fact, the format of each item is exactly the same as
19043 defined for the list of hosts in a &(manualroute)& router (see section
19044 &<<SECTformatonehostitem>>&).
19045
19046 If a router queues an address for a remote transport, this host list is
19047 associated with the address, and used instead of the transport's fallback host
19048 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19049 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19050 transport for further details.
19051
19052
19053 .option group routers string&!! "see below"
19054 .cindex "gid (group id)" "local delivery"
19055 .cindex "local transports" "uid and gid"
19056 .cindex "transport" "local"
19057 .cindex "router" "setting group"
19058 When a router queues an address for a transport, and the transport does not
19059 specify a group, the group given here is used when running the delivery
19060 process.
19061 The group may be specified numerically or by name. If expansion fails, the
19062 error is logged and delivery is deferred.
19063 The default is unset, unless &%check_local_user%& is set, when the default
19064 is taken from the password information. See also &%initgroups%& and &%user%&
19065 and the discussion in chapter &<<CHAPenvironment>>&.
19066
19067
19068
19069 .option headers_add routers list&!! unset
19070 .cindex "header lines" "adding"
19071 .cindex "router" "adding header lines"
19072 This option specifies a list of text headers,
19073 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19074 that is associated with any addresses that are accepted by the router.
19075 Each item is separately expanded, at routing time.  However, this
19076 option has no effect when an address is just being verified. The way in which
19077 the text is used to add header lines at transport time is described in section
19078 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19079 message is in the process of being transported. This means that references to
19080 header lines in string expansions in the transport's configuration do not
19081 &"see"& the added header lines.
19082
19083 The &%headers_add%& option is expanded after &%errors_to%&, but before
19084 &%headers_remove%& and &%transport%&. If an item is empty, or if
19085 an item expansion is forced to fail, the item has no effect. Other expansion
19086 failures are treated as configuration errors.
19087
19088 Unlike most options, &%headers_add%& can be specified multiple times
19089 for a router; all listed headers are added.
19090
19091 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19092 router that has the &%one_time%& option set.
19093
19094 .cindex "duplicate addresses"
19095 .oindex "&%unseen%&"
19096 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19097 additions are deleted when the address is passed on to subsequent routers.
19098 For a &%redirect%& router, if a generated address is the same as the incoming
19099 address, this can lead to duplicate addresses with different header
19100 modifications. Exim does not do duplicate deliveries (except, in certain
19101 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19102 which of the duplicates is discarded, so this ambiguous situation should be
19103 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19104
19105
19106
19107 .option headers_remove routers list&!! unset
19108 .cindex "header lines" "removing"
19109 .cindex "router" "removing header lines"
19110 This option specifies a list of text headers,
19111 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19112 that is associated with any addresses that are accepted by the router.
19113 However, the option has no effect when an address is just being verified.
19114 Each list item is separately expanded, at transport time.
19115 If an item ends in *, it will match any header with the given prefix.
19116 The way in which
19117 the text is used to remove header lines at transport time is described in
19118 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19119 the message is in the process of being transported. This means that references
19120 to header lines in string expansions in the transport's configuration still
19121 &"see"& the original header lines.
19122
19123 The &%headers_remove%& option is handled after &%errors_to%& and
19124 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19125 the item has no effect. Other expansion failures are treated as configuration
19126 errors.
19127
19128 Unlike most options, &%headers_remove%& can be specified multiple times
19129 for a router; all listed headers are removed.
19130
19131 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19132 router that has the &%one_time%& option set.
19133
19134 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19135 removal requests are deleted when the address is passed on to subsequent
19136 routers, and this can lead to problems with duplicates -- see the similar
19137 warning for &%headers_add%& above.
19138
19139 &*Warning 3*&: Because of the separate expansion of the list items,
19140 items that contain a list separator must have it doubled.
19141 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19142
19143
19144
19145 .option ignore_target_hosts routers "host list&!!" unset
19146 .cindex "IP address" "discarding"
19147 .cindex "router" "discarding IP addresses"
19148 Although this option is a host list, it should normally contain IP address
19149 entries rather than names. If any host that is looked up by the router has an
19150 IP address that matches an item in this list, Exim behaves as if that IP
19151 address did not exist. This option allows you to cope with rogue DNS entries
19152 like
19153 .code
19154 remote.domain.example.  A  127.0.0.1
19155 .endd
19156 by setting
19157 .code
19158 ignore_target_hosts = 127.0.0.1
19159 .endd
19160 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19161 discarded in this way, the router declines. In a conventional configuration, an
19162 attempt to mail to such a domain would normally provoke the &"unrouteable
19163 domain"& error, and an attempt to verify an address in the domain would fail.
19164 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19165 router declines if presented with one of the listed addresses.
19166
19167 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19168 means of the first or the second of the following settings, respectively:
19169 .code
19170 ignore_target_hosts = 0.0.0.0/0
19171 ignore_target_hosts = <; 0::0/0
19172 .endd
19173 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19174 in the second line matches all IPv6 addresses.
19175
19176 This option may also be useful for ignoring link-local and site-local IPv6
19177 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19178 is expanded before use as a list, it is possible to make it dependent on the
19179 domain that is being routed.
19180
19181 .vindex "&$host_address$&"
19182 During its expansion, &$host_address$& is set to the IP address that is being
19183 checked.
19184
19185 .option initgroups routers boolean false
19186 .cindex "additional groups"
19187 .cindex "groups" "additional"
19188 .cindex "local transports" "uid and gid"
19189 .cindex "transport" "local"
19190 If the router queues an address for a transport, and this option is true, and
19191 the uid supplied by the router is not overridden by the transport, the
19192 &[initgroups()]& function is called when running the transport to ensure that
19193 any additional groups associated with the uid are set up. See also &%group%&
19194 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19195
19196
19197
19198 .option local_part_prefix routers&!? "string list" unset
19199 .cindex affix "router precondition"
19200 .cindex "router" "prefix for local part"
19201 .cindex "prefix" "for local part, used in router"
19202 If this option is set, the router is skipped unless the local part starts with
19203 one of the given strings, or &%local_part_prefix_optional%& is true. See
19204 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19205 evaluated.
19206
19207 The list is scanned from left to right, and the first prefix that matches is
19208 used. A limited form of wildcard is available; if the prefix begins with an
19209 asterisk, it matches the longest possible sequence of arbitrary characters at
19210 the start of the local part. An asterisk should therefore always be followed by
19211 some character that does not occur in normal local parts.
19212 .cindex "multiple mailboxes"
19213 .cindex "mailbox" "multiple"
19214 Wildcarding can be used to set up multiple user mailboxes, as described in
19215 section &<<SECTmulbox>>&.
19216
19217 .vindex "&$local_part$&"
19218 .vindex "&$local_part_prefix$&"
19219 During the testing of the &%local_parts%& option, and while the router is
19220 running, the prefix is removed from the local part, and is available in the
19221 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19222 the router accepts the address, this remains true during subsequent delivery by
19223 a transport. In particular, the local part that is transmitted in the RCPT
19224 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19225 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19226 the relevant transport.
19227
19228 .vindex &$local_part_prefix_v$&
19229 If wildcarding (above) was used then the part of the prefix matching the
19230 wildcard is available in &$local_part_prefix_v$&.
19231
19232 When an address is being verified, &%local_part_prefix%& affects only the
19233 behaviour of the router. If the callout feature of verification is in use, this
19234 means that the full address, including the prefix, will be used during the
19235 callout.
19236
19237 The prefix facility is commonly used to handle local parts of the form
19238 &%owner-something%&. Another common use is to support local parts of the form
19239 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19240 to tell a user their forwarding is broken &-- by placing a router like this one
19241 immediately before the router that handles &_.forward_& files:
19242 .code
19243 real_localuser:
19244   driver = accept
19245   local_part_prefix = real-
19246   check_local_user
19247   transport = local_delivery
19248 .endd
19249 For security, it would probably be a good idea to restrict the use of this
19250 router to locally-generated messages, using a condition such as this:
19251 .code
19252   condition = ${if match {$sender_host_address}\
19253                          {\N^(|127\.0\.0\.1)$\N}}
19254 .endd
19255
19256 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19257 both conditions must be met if not optional. Care must be taken if wildcards
19258 are used in both a prefix and a suffix on the same router. Different
19259 separator characters must be used to avoid ambiguity.
19260
19261
19262 .option local_part_prefix_optional routers boolean false
19263 See &%local_part_prefix%& above.
19264
19265
19266
19267 .option local_part_suffix routers&!? "string list" unset
19268 .cindex "router" "suffix for local part"
19269 .cindex "suffix for local part" "used in router"
19270 This option operates in the same way as &%local_part_prefix%&, except that the
19271 local part must end (rather than start) with the given string, the
19272 &%local_part_suffix_optional%& option determines whether the suffix is
19273 mandatory, and the wildcard * character, if present, must be the last
19274 character of the suffix. This option facility is commonly used to handle local
19275 parts of the form &%something-request%& and multiple user mailboxes of the form
19276 &%username-foo%&.
19277
19278
19279 .option local_part_suffix_optional routers boolean false
19280 See &%local_part_suffix%& above.
19281
19282
19283
19284 .option local_parts routers&!? "local part list&!!" unset
19285 .cindex "router" "restricting to specific local parts"
19286 .cindex "local part" "checking in router"
19287 The router is run only if the local part of the address matches the list.
19288 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19289 are evaluated, and
19290 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19291 string is expanded, it is possible to make it depend on the domain, for
19292 example:
19293 .code
19294 local_parts = dbm;/usr/local/specials/$domain
19295 .endd
19296 .vindex "&$local_part_data$&"
19297 If the match is achieved by a lookup, the data that the lookup returned
19298 for the local part is placed in the variable &$local_part_data$& for use in
19299 expansions of the router's private options. You might use this option, for
19300 example, if you have a large number of local virtual domains, and you want to
19301 send all postmaster mail to the same place without having to set up an alias in
19302 each virtual domain:
19303 .code
19304 postmaster:
19305   driver = redirect
19306   local_parts = postmaster
19307   data = postmaster@real.domain.example
19308 .endd
19309
19310
19311 .option log_as_local routers boolean "see below"
19312 .cindex "log" "delivery line"
19313 .cindex "delivery" "log line format"
19314 Exim has two logging styles for delivery, the idea being to make local
19315 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19316 recipient address is given just as the local part, without a domain. The use of
19317 this style is controlled by this option. It defaults to true for the &(accept)&
19318 router, and false for all the others. This option applies only when a
19319 router assigns an address to a transport. It has no effect on routers that
19320 redirect addresses.
19321
19322
19323
19324 .option more routers boolean&!! true
19325 The result of string expansion for this option must be a valid boolean value,
19326 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19327 result causes an error, and delivery is deferred. If the expansion is forced to
19328 fail, the default value for the option (true) is used. Other failures cause
19329 delivery to be deferred.
19330
19331 If this option is set false, and the router declines to handle the address, no
19332 further routers are tried, routing fails, and the address is bounced.
19333 .oindex "&%self%&"
19334 However, if the router explicitly passes an address to the following router by
19335 means of the setting
19336 .code
19337 self = pass
19338 .endd
19339 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19340 does not affect the behaviour if one of the precondition tests fails. In that
19341 case, the address is always passed to the next router.
19342
19343 Note that &%address_data%& is not considered to be a precondition. If its
19344 expansion is forced to fail, the router declines, and the value of &%more%&
19345 controls what happens next.
19346
19347
19348 .option pass_on_timeout routers boolean false
19349 .cindex "timeout" "of router"
19350 .cindex "router" "timeout"
19351 If a router times out during a host lookup, it normally causes deferral of the
19352 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19353 router, overriding &%no_more%&. This may be helpful for systems that are
19354 intermittently connected to the Internet, or those that want to pass to a smart
19355 host any messages that cannot immediately be delivered.
19356
19357 There are occasional other temporary errors that can occur while doing DNS
19358 lookups. They are treated in the same way as a timeout, and this option
19359 applies to all of them.
19360
19361
19362
19363 .option pass_router routers string unset
19364 .cindex "router" "go to after &""pass""&"
19365 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19366 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19367 routing to continue, and overriding a false setting of &%more%&. When one of
19368 these routers returns &"pass"&, the address is normally handed on to the next
19369 router in sequence. This can be changed by setting &%pass_router%& to the name
19370 of another router. However (unlike &%redirect_router%&) the named router must
19371 be below the current router, to avoid loops. Note that this option applies only
19372 to the special case of &"pass"&. It does not apply when a router returns
19373 &"decline"& because it cannot handle an address.
19374
19375
19376
19377 .option redirect_router routers string unset
19378 .cindex "router" "start at after redirection"
19379 Sometimes an administrator knows that it is pointless to reprocess addresses
19380 generated from alias or forward files with the same router again. For
19381 example, if an alias file translates real names into login ids there is no
19382 point searching the alias file a second time, especially if it is a large file.
19383
19384 The &%redirect_router%& option can be set to the name of any router instance.
19385 It causes the routing of any generated addresses to start at the named router
19386 instead of at the first router. This option has no effect if the router in
19387 which it is set does not generate new addresses.
19388
19389
19390
19391 .option require_files routers&!? "string list&!!" unset
19392 .cindex "file" "requiring for router"
19393 .cindex "router" "requiring file existence"
19394 This option provides a general mechanism for predicating the running of a
19395 router on the existence or non-existence of certain files or directories.
19396 Before running a router, as one of its precondition tests, Exim works its way
19397 through the &%require_files%& list, expanding each item separately.
19398
19399 Because the list is split before expansion, any colons in expansion items must
19400 be doubled, or the facility for using a different list separator must be used
19401 (&<<SECTlistsepchange>>&).
19402 If any expansion is forced to fail, the item is ignored. Other expansion
19403 failures cause routing of the address to be deferred.
19404
19405 If any expanded string is empty, it is ignored. Otherwise, except as described
19406 below, each string must be a fully qualified file path, optionally preceded by
19407 &"!"&. The paths are passed to the &[stat()]& function to test for the
19408 existence of the files or directories. The router is skipped if any paths not
19409 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19410
19411 .cindex "NFS"
19412 If &[stat()]& cannot determine whether a file exists or not, delivery of
19413 the message is deferred. This can happen when NFS-mounted filesystems are
19414 unavailable.
19415
19416 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19417 options, so you cannot use it to check for the existence of a file in which to
19418 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19419 full list of the order in which preconditions are evaluated.) However, as
19420 these options are all expanded, you can use the &%exists%& expansion condition
19421 to make such tests. The &%require_files%& option is intended for checking files
19422 that the router may be going to use internally, or which are needed by a
19423 transport (e.g., &_.procmailrc_&).
19424
19425 During delivery, the &[stat()]& function is run as root, but there is a
19426 facility for some checking of the accessibility of a file by another user.
19427 This is not a proper permissions check, but just a &"rough"& check that
19428 operates as follows:
19429
19430 If an item in a &%require_files%& list does not contain any forward slash
19431 characters, it is taken to be the user (and optional group, separated by a
19432 comma) to be checked for subsequent files in the list. If no group is specified
19433 but the user is specified symbolically, the gid associated with the uid is
19434 used. For example:
19435 .code
19436 require_files = mail:/some/file
19437 require_files = $local_part_data:$home/.procmailrc
19438 .endd
19439 If a user or group name in a &%require_files%& list does not exist, the
19440 &%require_files%& condition fails.
19441
19442 Exim performs the check by scanning along the components of the file path, and
19443 checking the access for the given uid and gid. It checks for &"x"& access on
19444 directories, and &"r"& access on the final file. Note that this means that file
19445 access control lists, if the operating system has them, are ignored.
19446
19447 &*Warning 1*&: When the router is being run to verify addresses for an
19448 incoming SMTP message, Exim is not running as root, but under its own uid. This
19449 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19450 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19451 user is not permitted to read one of the directories on the file's path.
19452
19453 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19454 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19455 without root access. In this case, if a check for access by a particular user
19456 is requested, Exim creates a subprocess that runs as that user, and tries the
19457 check again in that process.
19458
19459 The default action for handling an unresolved EACCES is to consider it to
19460 be caused by a configuration error, and routing is deferred because the
19461 existence or non-existence of the file cannot be determined. However, in some
19462 circumstances it may be desirable to treat this condition as if the file did
19463 not exist. If the filename (or the exclamation mark that precedes the filename
19464 for non-existence) is preceded by a plus sign, the EACCES error is treated
19465 as if the file did not exist. For example:
19466 .code
19467 require_files = +/some/file
19468 .endd
19469 If the router is not an essential part of verification (for example, it
19470 handles users' &_.forward_& files), another solution is to set the &%verify%&
19471 option false so that the router is skipped when verifying.
19472
19473
19474
19475 .option retry_use_local_part routers boolean "see below"
19476 .cindex "hints database" "retry keys"
19477 .cindex "local part" "in retry keys"
19478 When a delivery suffers a temporary routing failure, a retry record is created
19479 in Exim's hints database. For addresses whose routing depends only on the
19480 domain, the key for the retry record should not involve the local part, but for
19481 other addresses, both the domain and the local part should be included.
19482 Usually, remote routing is of the former kind, and local routing is of the
19483 latter kind.
19484
19485 This option controls whether the local part is used to form the key for retry
19486 hints for addresses that suffer temporary errors while being handled by this
19487 router. The default value is true for any router that has any of
19488 &%check_local_user%&,
19489 &%local_parts%&,
19490 &%condition%&,
19491 &%local_part_prefix%&,
19492 &%local_part_suffix%&,
19493 &%senders%& or
19494 &%require_files%&
19495 set, and false otherwise. Note that this option does not apply to hints keys
19496 for transport delays; they are controlled by a generic transport option of the
19497 same name.
19498
19499 Failing to set this option when it is needed
19500 (because a remote router handles only some of the local-parts for a domain)
19501 can result in incorrect error messages being generated.
19502
19503 The setting of &%retry_use_local_part%& applies only to the router on which it
19504 appears. If the router generates child addresses, they are routed
19505 independently; this setting does not become attached to them.
19506
19507
19508
19509 .option router_home_directory routers string&!! unset
19510 .cindex "router" "home directory for"
19511 .cindex "home directory" "for router"
19512 .vindex "&$home$&"
19513 This option sets a home directory for use while the router is running. (Compare
19514 &%transport_home_directory%&, which sets a home directory for later
19515 transporting.) In particular, if used on a &(redirect)& router, this option
19516 sets a value for &$home$& while a filter is running. The value is expanded;
19517 forced expansion failure causes the option to be ignored &-- other failures
19518 cause the router to defer.
19519
19520 Expansion of &%router_home_directory%& happens immediately after the
19521 &%check_local_user%& test (if configured), before any further expansions take
19522 place.
19523 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19524 are evaluated.)
19525 While the router is running, &%router_home_directory%& overrides the value of
19526 &$home$& that came from &%check_local_user%&.
19527
19528 When a router accepts an address and assigns it to a local transport (including
19529 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19530 delivery), the home directory setting for the transport is taken from the first
19531 of these values that is set:
19532
19533 .ilist
19534 The &%home_directory%& option on the transport;
19535 .next
19536 The &%transport_home_directory%& option on the router;
19537 .next
19538 The password data if &%check_local_user%& is set on the router;
19539 .next
19540 The &%router_home_directory%& option on the router.
19541 .endlist
19542
19543 In other words, &%router_home_directory%& overrides the password data for the
19544 router, but not for the transport.
19545
19546
19547
19548 .option self routers string freeze
19549 .cindex "MX record" "pointing to local host"
19550 .cindex "local host" "MX pointing to"
19551 This option applies to those routers that use a recipient address to find a
19552 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19553 and &(manualroute)& routers.
19554 Certain configurations of the &(queryprogram)& router can also specify a list
19555 of remote hosts.
19556 Usually such routers are configured to send the message to a remote host via an
19557 &(smtp)& transport. The &%self%& option specifies what happens when the first
19558 host on the list turns out to be the local host.
19559 The way in which Exim checks for the local host is described in section
19560 &<<SECTreclocipadd>>&.
19561
19562 Normally this situation indicates either an error in Exim's configuration (for
19563 example, the router should be configured not to process this domain), or an
19564 error in the DNS (for example, the MX should not point to this host). For this
19565 reason, the default action is to log the incident, defer the address, and
19566 freeze the message. The following alternatives are provided for use in special
19567 cases:
19568
19569 .vlist
19570 .vitem &%defer%&
19571 Delivery of the message is tried again later, but the message is not frozen.
19572
19573 .vitem "&%reroute%&: <&'domain'&>"
19574 The domain is changed to the given domain, and the address is passed back to
19575 be reprocessed by the routers. No rewriting of headers takes place. This
19576 behaviour is essentially a redirection.
19577
19578 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19579 The domain is changed to the given domain, and the address is passed back to be
19580 reprocessed by the routers. Any headers that contain the original domain are
19581 rewritten.
19582
19583 .vitem &%pass%&
19584 .oindex "&%more%&"
19585 .vindex "&$self_hostname$&"
19586 The router passes the address to the next router, or to the router named in the
19587 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19588 subsequent routing and delivery, the variable &$self_hostname$& contains the
19589 name of the local host that the router encountered. This can be used to
19590 distinguish between different cases for hosts with multiple names. The
19591 combination
19592 .code
19593 self = pass
19594 no_more
19595 .endd
19596 ensures that only those addresses that routed to the local host are passed on.
19597 Without &%no_more%&, addresses that were declined for other reasons would also
19598 be passed to the next router.
19599
19600 .vitem &%fail%&
19601 Delivery fails and an error report is generated.
19602
19603 .vitem &%send%&
19604 .cindex "local host" "sending to"
19605 The anomaly is ignored and the address is queued for the transport. This
19606 setting should be used with extreme caution. For an &(smtp)& transport, it
19607 makes sense only in cases where the program that is listening on the SMTP port
19608 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19609 different configuration file that handles the domain in another way.
19610 .endlist
19611
19612
19613
19614 .option senders routers&!? "address list&!!" unset
19615 .cindex "router" "checking senders"
19616 If this option is set, the router is skipped unless the message's sender
19617 address matches something on the list.
19618 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19619 are evaluated.
19620
19621 There are issues concerning verification when the running of routers is
19622 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19623 setting, it sets the sender to the null string. When using the &%-bt%& option
19624 to check a configuration file, it is necessary also to use the &%-f%& option to
19625 set an appropriate sender. For incoming mail, the sender is unset when
19626 verifying the sender, but is available when verifying any recipients. If the
19627 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19628 matters.
19629
19630
19631 .option set routers "string list" unset
19632 .cindex router variables
19633 This option may be used multiple times on a router;
19634 because of this the list aspect is mostly irrelevant.
19635 The list separator is a semicolon but can be changed in the
19636 usual way.
19637
19638 Each list-element given must be of the form &"name = value"&
19639 and the names used must start with the string &"r_"&.
19640 Values containing a list-separator should have them doubled.
19641 When a router runs, the strings are evaluated in order,
19642 to create variables which are added to the set associated with
19643 the address.
19644 The variable is set with the expansion of the value.
19645 The variables can be used by the router options
19646 (not including any preconditions)
19647 and by the transport.
19648 Later definitions of a given named variable will override former ones.
19649 Variable use is via the usual &$r_...$& syntax.
19650
19651 This is similar to the &%address_data%& option, except that
19652 many independent variables can be used, with choice of naming.
19653
19654
19655 .option translate_ip_address routers string&!! unset
19656 .cindex "IP address" "translating"
19657 .cindex "packet radio"
19658 .cindex "router" "IP address translation"
19659 There exist some rare networking situations (for example, packet radio) where
19660 it is helpful to be able to translate IP addresses generated by normal routing
19661 mechanisms into other IP addresses, thus performing a kind of manual IP
19662 routing. This should be done only if the normal IP routing of the TCP/IP stack
19663 is inadequate or broken. Because this is an extremely uncommon requirement, the
19664 code to support this option is not included in the Exim binary unless
19665 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19666
19667 .vindex "&$host_address$&"
19668 The &%translate_ip_address%& string is expanded for every IP address generated
19669 by the router, with the generated address set in &$host_address$&. If the
19670 expansion is forced to fail, no action is taken.
19671 For any other expansion error, delivery of the message is deferred.
19672 If the result of the expansion is an IP address, that replaces the original
19673 address; otherwise the result is assumed to be a host name &-- this is looked
19674 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19675 produce one or more replacement IP addresses. For example, to subvert all IP
19676 addresses in some specific networks, this could be added to a router:
19677 .code
19678 translate_ip_address = \
19679   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19680     {$value}fail}}
19681 .endd
19682 The file would contain lines like
19683 .code
19684 10.2.3.128/26    some.host
19685 10.8.4.34/26     10.44.8.15
19686 .endd
19687 You should not make use of this facility unless you really understand what you
19688 are doing.
19689
19690
19691
19692 .option transport routers string&!! unset
19693 This option specifies the transport to be used when a router accepts an address
19694 and sets it up for delivery. A transport is never needed if a router is used
19695 only for verification. The value of the option is expanded at routing time,
19696 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19697 and result must be the name of one of the configured transports. If it is not,
19698 delivery is deferred.
19699
19700 The &%transport%& option is not used by the &(redirect)& router, but it does
19701 have some private options that set up transports for pipe and file deliveries
19702 (see chapter &<<CHAPredirect>>&).
19703
19704
19705
19706 .option transport_current_directory routers string&!! unset
19707 .cindex "current directory for local transport"
19708 This option associates a current directory with any address that is routed
19709 to a local transport. This can happen either because a transport is
19710 explicitly configured for the router, or because it generates a delivery to a
19711 file or a pipe. During the delivery process (that is, at transport time), this
19712 option string is expanded and is set as the current directory, unless
19713 overridden by a setting on the transport.
19714 If the expansion fails for any reason, including forced failure, an error is
19715 logged, and delivery is deferred.
19716 See chapter &<<CHAPenvironment>>& for details of the local delivery
19717 environment.
19718
19719
19720
19721
19722 .option transport_home_directory routers string&!! "see below"
19723 .cindex "home directory" "for local transport"
19724 This option associates a home directory with any address that is routed to a
19725 local transport. This can happen either because a transport is explicitly
19726 configured for the router, or because it generates a delivery to a file or a
19727 pipe. During the delivery process (that is, at transport time), the option
19728 string is expanded and is set as the home directory, unless overridden by a
19729 setting of &%home_directory%& on the transport.
19730 If the expansion fails for any reason, including forced failure, an error is
19731 logged, and delivery is deferred.
19732
19733 If the transport does not specify a home directory, and
19734 &%transport_home_directory%& is not set for the router, the home directory for
19735 the transport is taken from the password data if &%check_local_user%& is set for
19736 the router. Otherwise it is taken from &%router_home_directory%& if that option
19737 is set; if not, no home directory is set for the transport.
19738
19739 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19740 environment.
19741
19742
19743
19744
19745 .option unseen routers boolean&!! false
19746 .cindex "router" "carrying on after success"
19747 The result of string expansion for this option must be a valid boolean value,
19748 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19749 result causes an error, and delivery is deferred. If the expansion is forced to
19750 fail, the default value for the option (false) is used. Other failures cause
19751 delivery to be deferred.
19752
19753 When this option is set true, routing does not cease if the router accepts the
19754 address. Instead, a copy of the incoming address is passed to the next router,
19755 overriding a false setting of &%more%&. There is little point in setting
19756 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19757 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19758 sometimes true and sometimes false).
19759
19760 .cindex "copy of message (&%unseen%& option)"
19761 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19762 qualifier in filter files. It can be used to cause copies of messages to be
19763 delivered to some other destination, while also carrying out a normal delivery.
19764 In effect, the current address is made into a &"parent"& that has two children
19765 &-- one that is delivered as specified by this router, and a clone that goes on
19766 to be routed further. For this reason, &%unseen%& may not be combined with the
19767 &%one_time%& option in a &(redirect)& router.
19768
19769 &*Warning*&: Header lines added to the address (or specified for removal) by
19770 this router or by previous routers affect the &"unseen"& copy of the message
19771 only. The clone that continues to be processed by further routers starts with
19772 no added headers and none specified for removal. For a &%redirect%& router, if
19773 a generated address is the same as the incoming address, this can lead to
19774 duplicate addresses with different header modifications. Exim does not do
19775 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19776 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19777 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19778 &%redirect%& router may be of help.
19779
19780 Unlike the handling of header modifications, any data that was set by the
19781 &%address_data%& option in the current or previous routers &'is'& passed on to
19782 subsequent routers.
19783
19784
19785 .option user routers string&!! "see below"
19786 .cindex "uid (user id)" "local delivery"
19787 .cindex "local transports" "uid and gid"
19788 .cindex "transport" "local"
19789 .cindex "router" "user for filter processing"
19790 .cindex "filter" "user for processing"
19791 When a router queues an address for a transport, and the transport does not
19792 specify a user, the user given here is used when running the delivery process.
19793 The user may be specified numerically or by name. If expansion fails, the
19794 error is logged and delivery is deferred.
19795 This user is also used by the &(redirect)& router when running a filter file.
19796 The default is unset, except when &%check_local_user%& is set. In this case,
19797 the default is taken from the password information. If the user is specified as
19798 a name, and &%group%& is not set, the group associated with the user is used.
19799 See also &%initgroups%& and &%group%& and the discussion in chapter
19800 &<<CHAPenvironment>>&.
19801
19802
19803
19804 .option verify routers&!? boolean true
19805 Setting this option has the effect of setting &%verify_sender%& and
19806 &%verify_recipient%& to the same value.
19807
19808
19809 .option verify_only routers&!? boolean false
19810 .cindex "EXPN" "with &%verify_only%&"
19811 .oindex "&%-bv%&"
19812 .cindex "router" "used only when verifying"
19813 If this option is set, the router is used only when verifying an address,
19814 delivering in cutthrough mode or
19815 testing with the &%-bv%& option, not when actually doing a delivery, testing
19816 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19817 restricted to verifying only senders or recipients by means of
19818 &%verify_sender%& and &%verify_recipient%&.
19819
19820 &*Warning*&: When the router is being run to verify addresses for an incoming
19821 SMTP message, Exim is not running as root, but under its own uid. If the router
19822 accesses any files, you need to make sure that they are accessible to the Exim
19823 user or group.
19824
19825
19826 .option verify_recipient routers&!? boolean true
19827 If this option is false, the router is skipped when verifying recipient
19828 addresses,
19829 delivering in cutthrough mode
19830 or testing recipient verification using &%-bv%&.
19831 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19832 are evaluated.
19833 See also the &$verify_mode$& variable.
19834
19835
19836 .option verify_sender routers&!? boolean true
19837 If this option is false, the router is skipped when verifying sender addresses
19838 or testing sender verification using &%-bvs%&.
19839 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19840 are evaluated.
19841 See also the &$verify_mode$& variable.
19842 .ecindex IIDgenoprou1
19843 .ecindex IIDgenoprou2
19844
19845
19846
19847
19848
19849
19850 . ////////////////////////////////////////////////////////////////////////////
19851 . ////////////////////////////////////////////////////////////////////////////
19852
19853 .chapter "The accept router" "CHID4"
19854 .cindex "&(accept)& router"
19855 .cindex "routers" "&(accept)&"
19856 The &(accept)& router has no private options of its own. Unless it is being
19857 used purely for verification (see &%verify_only%&) a transport is required to
19858 be defined by the generic &%transport%& option. If the preconditions that are
19859 specified by generic options are met, the router accepts the address and queues
19860 it for the given transport. The most common use of this router is for setting
19861 up deliveries to local mailboxes. For example:
19862 .code
19863 localusers:
19864   driver = accept
19865   domains = mydomain.example
19866   check_local_user
19867   transport = local_delivery
19868 .endd
19869 The &%domains%& condition in this example checks the domain of the address, and
19870 &%check_local_user%& checks that the local part is the login of a local user.
19871 When both preconditions are met, the &(accept)& router runs, and queues the
19872 address for the &(local_delivery)& transport.
19873
19874
19875
19876
19877
19878
19879 . ////////////////////////////////////////////////////////////////////////////
19880 . ////////////////////////////////////////////////////////////////////////////
19881
19882 .chapter "The dnslookup router" "CHAPdnslookup"
19883 .scindex IIDdnsrou1 "&(dnslookup)& router"
19884 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19885 The &(dnslookup)& router looks up the hosts that handle mail for the
19886 recipient's domain in the DNS. A transport must always be set for this router,
19887 unless &%verify_only%& is set.
19888
19889 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19890 SRV records. If none are found, or if SRV support is not configured,
19891 MX records are looked up. If no MX records exist, address records are sought.
19892 However, &%mx_domains%& can be set to disable the direct use of address
19893 records.
19894
19895 MX records of equal priority are sorted by Exim into a random order. Exim then
19896 looks for address records for the host names obtained from MX or SRV records.
19897 When a host has more than one IP address, they are sorted into a random order,
19898 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19899 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19900 generic option, the router declines.
19901
19902 Unless they have the highest priority (lowest MX value), MX records that point
19903 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19904 are discarded, together with any other MX records of equal or lower priority.
19905
19906 .cindex "MX record" "pointing to local host"
19907 .cindex "local host" "MX pointing to"
19908 .oindex "&%self%&" "in &(dnslookup)& router"
19909 If the host pointed to by the highest priority MX record, or looked up as an
19910 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19911 happens is controlled by the generic &%self%& option.
19912
19913
19914 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19915 There have been problems with DNS servers when SRV records are looked up.
19916 Some misbehaving servers return a DNS error or timeout when a non-existent
19917 SRV record is sought. Similar problems have in the past been reported for
19918 MX records. The global &%dns_again_means_nonexist%& option can help with this
19919 problem, but it is heavy-handed because it is a global option.
19920
19921 For this reason, there are two options, &%srv_fail_domains%& and
19922 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19923 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19924 an attempt to look up an SRV or MX record causes one of these results, and the
19925 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19926 such record"&. In the case of an SRV lookup, this means that the router
19927 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19928 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19929 case routing fails.
19930
19931
19932 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19933 .cindex "&(dnslookup)& router" "declines"
19934 There are a few cases where a &(dnslookup)& router will decline to accept
19935 an address; if such a router is expected to handle "all remaining non-local
19936 domains", then it is important to set &%no_more%&.
19937
19938 The router will defer rather than decline if the domain
19939 is found in the &%fail_defer_domains%& router option.
19940
19941 Reasons for a &(dnslookup)& router to decline currently include:
19942 .ilist
19943 The domain does not exist in DNS
19944 .next
19945 The domain exists but the MX record's host part is just "."; this is a common
19946 convention (borrowed from SRV) used to indicate that there is no such service
19947 for this domain and to not fall back to trying A/AAAA records.
19948 .next
19949 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19950 .next
19951 MX record points to a non-existent host.
19952 .next
19953 MX record points to an IP address and the main section option
19954 &%allow_mx_to_ip%& is not set.
19955 .next
19956 MX records exist and point to valid hosts, but all hosts resolve only to
19957 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19958 .next
19959 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19960 &%dns_check_names_pattern%& for handling one variant of this)
19961 .next
19962 &%check_secondary_mx%& is set on this router but the local host can
19963 not be found in the MX records (see below)
19964 .endlist
19965
19966
19967
19968
19969 .section "Private options for dnslookup" "SECID118"
19970 .cindex "options" "&(dnslookup)& router"
19971 The private options for the &(dnslookup)& router are as follows:
19972
19973 .option check_secondary_mx dnslookup boolean false
19974 .cindex "MX record" "checking for secondary"
19975 If this option is set, the router declines unless the local host is found in
19976 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19977 process domains for which the local host is a secondary mail exchanger
19978 differently to other domains. The way in which Exim decides whether a host is
19979 the local host is described in section &<<SECTreclocipadd>>&.
19980
19981
19982 .option check_srv dnslookup string&!! unset
19983 .cindex "SRV record" "enabling use of"
19984 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19985 addition to MX and address records. The support is disabled by default. To
19986 enable SRV support, set the &%check_srv%& option to the name of the service
19987 required. For example,
19988 .code
19989 check_srv = smtp
19990 .endd
19991 looks for SRV records that refer to the normal smtp service. The option is
19992 expanded, so the service name can vary from message to message or address
19993 to address. This might be helpful if SRV records are being used for a
19994 submission service. If the expansion is forced to fail, the &%check_srv%&
19995 option is ignored, and the router proceeds to look for MX records in the
19996 normal way.
19997
19998 When the expansion succeeds, the router searches first for SRV records for
19999 the given service (it assumes TCP protocol). A single SRV record with a
20000 host name that consists of just a single dot indicates &"no such service for
20001 this domain"&; if this is encountered, the router declines. If other kinds of
20002 SRV record are found, they are used to construct a host list for delivery
20003 according to the rules of RFC 2782. MX records are not sought in this case.
20004
20005 When no SRV records are found, MX records (and address records) are sought in
20006 the traditional way. In other words, SRV records take precedence over MX
20007 records, just as MX records take precedence over address records. Note that
20008 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20009 defined it. It is apparently believed that MX records are sufficient for email
20010 and that SRV records should not be used for this purpose. However, SRV records
20011 have an additional &"weight"& feature which some people might find useful when
20012 trying to split an SMTP load between hosts of different power.
20013
20014 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20015 when there is a DNS lookup error.
20016
20017
20018
20019
20020 .option fail_defer_domains dnslookup "domain list&!!" unset
20021 .cindex "MX record" "not found"
20022 DNS lookups for domains matching &%fail_defer_domains%&
20023 which find no matching record will cause the router to defer
20024 rather than the default behaviour of decline.
20025 This maybe be useful for queueing messages for a newly created
20026 domain while the DNS configuration is not ready.
20027 However, it will result in any message with mistyped domains
20028 also being queued.
20029
20030
20031 .option ipv4_only "string&!!" unset
20032 .cindex IPv6 disabling
20033 .cindex DNS "IPv6 disabling"
20034 The string is expanded, and if the result is anything but a forced failure,
20035 or an empty string, or one of the strings “0” or “no” or “false”
20036 (checked without regard to the case of the letters),
20037 only A records are used.
20038
20039 .option ipv4_prefer "string&!!" unset
20040 .cindex IPv4 preference
20041 .cindex DNS "IPv4 preference"
20042 The string is expanded, and if the result is anything but a forced failure,
20043 or an empty string, or one of the strings “0” or “no” or “false”
20044 (checked without regard to the case of the letters),
20045 A records are sorted before AAAA records (inverting the default).
20046
20047 .option mx_domains dnslookup "domain list&!!" unset
20048 .cindex "MX record" "required to exist"
20049 .cindex "SRV record" "required to exist"
20050 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20051 record in order to be recognized. (The name of this option could be improved.)
20052 For example, if all the mail hosts in &'fict.example'& are known to have MX
20053 records, except for those in &'discworld.fict.example'&, you could use this
20054 setting:
20055 .code
20056 mx_domains = ! *.discworld.fict.example : *.fict.example
20057 .endd
20058 This specifies that messages addressed to a domain that matches the list but
20059 has no MX record should be bounced immediately instead of being routed using
20060 the address record.
20061
20062
20063 .option mx_fail_domains dnslookup "domain list&!!" unset
20064 If the DNS lookup for MX records for one of the domains in this list causes a
20065 DNS lookup error, Exim behaves as if no MX records were found. See section
20066 &<<SECTprowitdnsloo>>& for more discussion.
20067
20068
20069
20070
20071 .option qualify_single dnslookup boolean true
20072 .cindex "DNS" "resolver options"
20073 .cindex "DNS" "qualifying single-component names"
20074 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20075 lookups. Typically, but not standardly, this causes the resolver to qualify
20076 single-component names with the default domain. For example, on a machine
20077 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20078 &'thesaurus.ref.example'& inside the resolver. For details of what your
20079 resolver actually does, consult your man pages for &'resolver'& and
20080 &'resolv.conf'&.
20081
20082
20083
20084 .option rewrite_headers dnslookup boolean true
20085 .cindex "rewriting" "header lines"
20086 .cindex "header lines" "rewriting"
20087 If the domain name in the address that is being processed is not fully
20088 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20089 an address is specified as &'dormouse@teaparty'&, the domain might be
20090 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20091 occur as a result of setting the &%widen_domains%& option. If
20092 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20093 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20094 header lines of the message are rewritten with the full domain name.
20095
20096 This option should be turned off only when it is known that no message is
20097 ever going to be sent outside an environment where the abbreviation makes
20098 sense.
20099
20100 When an MX record is looked up in the DNS and matches a wildcard record, name
20101 servers normally return a record containing the name that has been looked up,
20102 making it impossible to detect whether a wildcard was present or not. However,
20103 some name servers have recently been seen to return the wildcard entry. If the
20104 name returned by a DNS lookup begins with an asterisk, it is not used for
20105 header rewriting.
20106
20107
20108 .option same_domain_copy_routing dnslookup boolean false
20109 .cindex "address" "copying routing"
20110 Addresses with the same domain are normally routed by the &(dnslookup)& router
20111 to the same list of hosts. However, this cannot be presumed, because the router
20112 options and preconditions may refer to the local part of the address. By
20113 default, therefore, Exim routes each address in a message independently. DNS
20114 servers run caches, so repeated DNS lookups are not normally expensive, and in
20115 any case, personal messages rarely have more than a few recipients.
20116
20117 If you are running mailing lists with large numbers of subscribers at the same
20118 domain, and you are using a &(dnslookup)& router which is independent of the
20119 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20120 lookups for identical domains in one message. In this case, when &(dnslookup)&
20121 routes an address to a remote transport, any other unrouted addresses in the
20122 message that have the same domain are automatically given the same routing
20123 without processing them independently,
20124 provided the following conditions are met:
20125
20126 .ilist
20127 No router that processed the address specified &%headers_add%& or
20128 &%headers_remove%&.
20129 .next
20130 The router did not change the address in any way, for example, by &"widening"&
20131 the domain.
20132 .endlist
20133
20134
20135
20136
20137 .option search_parents dnslookup boolean false
20138 .cindex "DNS" "resolver options"
20139 When this option is true, the resolver option RES_DNSRCH is set for DNS
20140 lookups. This is different from the &%qualify_single%& option in that it
20141 applies to domains containing dots. Typically, but not standardly, it causes
20142 the resolver to search for the name in the current domain and in parent
20143 domains. For example, on a machine in the &'fict.example'& domain, if looking
20144 up &'teaparty.wonderland'& failed, the resolver would try
20145 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20146 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20147
20148 Setting this option true can cause problems in domains that have a wildcard MX
20149 record, because any domain that does not have its own MX record matches the
20150 local wildcard.
20151
20152
20153
20154 .option srv_fail_domains dnslookup "domain list&!!" unset
20155 If the DNS lookup for SRV records for one of the domains in this list causes a
20156 DNS lookup error, Exim behaves as if no SRV records were found. See section
20157 &<<SECTprowitdnsloo>>& for more discussion.
20158
20159
20160
20161
20162 .option widen_domains dnslookup "string list" unset
20163 .cindex "domain" "partial; widening"
20164 If a DNS lookup fails and this option is set, each of its strings in turn is
20165 added onto the end of the domain, and the lookup is tried again. For example,
20166 if
20167 .code
20168 widen_domains = fict.example:ref.example
20169 .endd
20170 is set and a lookup of &'klingon.dictionary'& fails,
20171 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20172 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20173 and &%search_parents%& options can cause some widening to be undertaken inside
20174 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20175 when verifying, unless &%rewrite_headers%& is false (not the default).
20176
20177
20178 .section "Effect of qualify_single and search_parents" "SECID119"
20179 When a domain from an envelope recipient is changed by the resolver as a result
20180 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20181 corresponding address in the message's header lines unless &%rewrite_headers%&
20182 is set false. Exim then re-routes the address, using the full domain.
20183
20184 These two options affect only the DNS lookup that takes place inside the router
20185 for the domain of the address that is being routed. They do not affect lookups
20186 such as that implied by
20187 .code
20188 domains = @mx_any
20189 .endd
20190 that may happen while processing a router precondition before the router is
20191 entered. No widening ever takes place for these lookups.
20192 .ecindex IIDdnsrou1
20193 .ecindex IIDdnsrou2
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203 . ////////////////////////////////////////////////////////////////////////////
20204 . ////////////////////////////////////////////////////////////////////////////
20205
20206 .chapter "The ipliteral router" "CHID5"
20207 .cindex "&(ipliteral)& router"
20208 .cindex "domain literal" "routing"
20209 .cindex "routers" "&(ipliteral)&"
20210 This router has no private options. Unless it is being used purely for
20211 verification (see &%verify_only%&) a transport is required to be defined by the
20212 generic &%transport%& option. The router accepts the address if its domain part
20213 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20214 router handles the address
20215 .code
20216 root@[192.168.1.1]
20217 .endd
20218 by setting up delivery to the host with that IP address. IPv4 domain literals
20219 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20220 are similar, but the address is preceded by &`ipv6:`&. For example:
20221 .code
20222 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20223 .endd
20224 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20225 grounds that sooner or later somebody will try it.
20226
20227 .oindex "&%self%&" "in &(ipliteral)& router"
20228 If the IP address matches something in &%ignore_target_hosts%&, the router
20229 declines. If an IP literal turns out to refer to the local host, the generic
20230 &%self%& option determines what happens.
20231
20232 The RFCs require support for domain literals; however, their use is
20233 controversial in today's Internet. If you want to use this router, you must
20234 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20235 Exim will not recognize the domain literal syntax in addresses.
20236
20237
20238
20239 . ////////////////////////////////////////////////////////////////////////////
20240 . ////////////////////////////////////////////////////////////////////////////
20241
20242 .chapter "The iplookup router" "CHID6"
20243 .cindex "&(iplookup)& router"
20244 .cindex "routers" "&(iplookup)&"
20245 The &(iplookup)& router was written to fulfil a specific requirement in
20246 Cambridge University (which in fact no longer exists). For this reason, it is
20247 not included in the binary of Exim by default. If you want to include it, you
20248 must set
20249 .code
20250 ROUTER_IPLOOKUP=yes
20251 .endd
20252 in your &_Local/Makefile_& configuration file.
20253
20254 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20255 connection to one or more specific hosts. The host can then return the same or
20256 a different address &-- in effect rewriting the recipient address in the
20257 message's envelope. The new address is then passed on to subsequent routers. If
20258 this process fails, the address can be passed on to other routers, or delivery
20259 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20260 must not be specified for it.
20261
20262 .cindex "options" "&(iplookup)& router"
20263 .option hosts iplookup string unset
20264 This option must be supplied. Its value is a colon-separated list of host
20265 names. The hosts are looked up using &[gethostbyname()]&
20266 (or &[getipnodebyname()]& when available)
20267 and are tried in order until one responds to the query. If none respond, what
20268 happens is controlled by &%optional%&.
20269
20270
20271 .option optional iplookup boolean false
20272 If &%optional%& is true, if no response is obtained from any host, the address
20273 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20274 delivery to the address is deferred.
20275
20276
20277 .option port iplookup integer 0
20278 .cindex "port" "&(iplookup)& router"
20279 This option must be supplied. It specifies the port number for the TCP or UDP
20280 call.
20281
20282
20283 .option protocol iplookup string udp
20284 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20285 protocols is to be used.
20286
20287
20288 .option query iplookup string&!! "see below"
20289 This defines the content of the query that is sent to the remote hosts. The
20290 default value is:
20291 .code
20292 $local_part@$domain $local_part@$domain
20293 .endd
20294 The repetition serves as a way of checking that a response is to the correct
20295 query in the default case (see &%response_pattern%& below).
20296
20297
20298 .option reroute iplookup string&!! unset
20299 If this option is not set, the rerouted address is precisely the byte string
20300 returned by the remote host, up to the first white space, if any. If set, the
20301 string is expanded to form the rerouted address. It can include parts matched
20302 in the response by &%response_pattern%& by means of numeric variables such as
20303 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20304 whether or not a pattern is in use. In all cases, the rerouted address must end
20305 up in the form &'local_part@domain'&.
20306
20307
20308 .option response_pattern iplookup string unset
20309 This option can be set to a regular expression that is applied to the string
20310 returned from the remote host. If the pattern does not match the response, the
20311 router declines. If &%response_pattern%& is not set, no checking of the
20312 response is done, unless the query was defaulted, in which case there is a
20313 check that the text returned after the first white space is the original
20314 address. This checks that the answer that has been received is in response to
20315 the correct question. For example, if the response is just a new domain, the
20316 following could be used:
20317 .code
20318 response_pattern = ^([^@]+)$
20319 reroute = $local_part@$1
20320 .endd
20321
20322 .option timeout iplookup time 5s
20323 This specifies the amount of time to wait for a response from the remote
20324 machine. The same timeout is used for the &[connect()]& function for a TCP
20325 call. It does not apply to UDP.
20326
20327
20328
20329
20330 . ////////////////////////////////////////////////////////////////////////////
20331 . ////////////////////////////////////////////////////////////////////////////
20332
20333 .chapter "The manualroute router" "CHID7"
20334 .scindex IIDmanrou1 "&(manualroute)& router"
20335 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20336 .cindex "domain" "manually routing"
20337 The &(manualroute)& router is so-called because it provides a way of manually
20338 routing an address according to its domain. It is mainly used when you want to
20339 route addresses to remote hosts according to your own rules, bypassing the
20340 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20341 route to local transports, a facility that may be useful if you want to save
20342 messages for dial-in hosts in local files.
20343
20344 The &(manualroute)& router compares a list of domain patterns with the domain
20345 it is trying to route. If there is no match, the router declines. Each pattern
20346 has associated with it a list of hosts and some other optional data, which may
20347 include a transport. The combination of a pattern and its data is called a
20348 &"routing rule"&. For patterns that do not have an associated transport, the
20349 generic &%transport%& option must specify a transport, unless the router is
20350 being used purely for verification (see &%verify_only%&).
20351
20352 .vindex "&$host$&"
20353 In the case of verification, matching the domain pattern is sufficient for the
20354 router to accept the address. When actually routing an address for delivery,
20355 an address that matches a domain pattern is queued for the associated
20356 transport. If the transport is not a local one, a host list must be associated
20357 with the pattern; IP addresses are looked up for the hosts, and these are
20358 passed to the transport along with the mail address. For local transports, a
20359 host list is optional. If it is present, it is passed in &$host$& as a single
20360 text string.
20361
20362 The list of routing rules can be provided as an inline string in
20363 &%route_list%&, or the data can be obtained by looking up the domain in a file
20364 or database by setting &%route_data%&. Only one of these settings may appear in
20365 any one instance of &(manualroute)&. The format of routing rules is described
20366 below, following the list of private options.
20367
20368
20369 .section "Private options for manualroute" "SECTprioptman"
20370
20371 .cindex "options" "&(manualroute)& router"
20372 The private options for the &(manualroute)& router are as follows:
20373
20374 .option host_all_ignored manualroute string defer
20375 See &%host_find_failed%&.
20376
20377 .option host_find_failed manualroute string freeze
20378 This option controls what happens when &(manualroute)& tries to find an IP
20379 address for a host, and the host does not exist. The option can be set to one
20380 of the following values:
20381 .code
20382 decline
20383 defer
20384 fail
20385 freeze
20386 ignore
20387 pass
20388 .endd
20389 The default (&"freeze"&) assumes that this state is a serious configuration
20390 error. The difference between &"pass"& and &"decline"& is that the former
20391 forces the address to be passed to the next router (or the router defined by
20392 &%pass_router%&),
20393 .oindex "&%more%&"
20394 overriding &%no_more%&, whereas the latter passes the address to the next
20395 router only if &%more%& is true.
20396
20397 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20398 cannot be found. If all the hosts in the list are ignored, the behaviour is
20399 controlled by the &%host_all_ignored%& option. This takes the same values
20400 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20401
20402 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20403 state; if a host lookup gets a temporary error, delivery is deferred unless the
20404 generic &%pass_on_timeout%& option is set.
20405
20406
20407 .option hosts_randomize manualroute boolean false
20408 .cindex "randomized host list"
20409 .cindex "host" "list of; randomized"
20410 If this option is set, the order of the items in a host list in a routing rule
20411 is randomized each time the list is used, unless an option in the routing rule
20412 overrides (see below). Randomizing the order of a host list can be used to do
20413 crude load sharing. However, if more than one mail address is routed by the
20414 same router to the same host list, the host lists are considered to be the same
20415 (even though they may be randomized into different orders) for the purpose of
20416 deciding whether to batch the deliveries into a single SMTP transaction.
20417
20418 When &%hosts_randomize%& is true, a host list may be split
20419 into groups whose order is separately randomized. This makes it possible to
20420 set up MX-like behaviour. The boundaries between groups are indicated by an
20421 item that is just &`+`& in the host list. For example:
20422 .code
20423 route_list = * host1:host2:host3:+:host4:host5
20424 .endd
20425 The order of the first three hosts and the order of the last two hosts is
20426 randomized for each use, but the first three always end up before the last two.
20427 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20428 randomized host list is passed to an &(smtp)& transport that also has
20429 &%hosts_randomize set%&, the list is not re-randomized.
20430
20431
20432 .option route_data manualroute string&!! unset
20433 If this option is set, it must expand to yield the data part of a routing rule.
20434 Typically, the expansion string includes a lookup based on the domain. For
20435 example:
20436 .code
20437 route_data = ${lookup{$domain}dbm{/etc/routes}}
20438 .endd
20439 If the expansion is forced to fail, or the result is an empty string, the
20440 router declines. Other kinds of expansion failure cause delivery to be
20441 deferred.
20442
20443
20444 .option route_list manualroute "string list" unset
20445 This string is a list of routing rules, in the form defined below. Note that,
20446 unlike most string lists, the items are separated by semicolons. This is so
20447 that they may contain colon-separated host lists.
20448
20449
20450 .option same_domain_copy_routing manualroute boolean false
20451 .cindex "address" "copying routing"
20452 Addresses with the same domain are normally routed by the &(manualroute)&
20453 router to the same list of hosts. However, this cannot be presumed, because the
20454 router options and preconditions may refer to the local part of the address. By
20455 default, therefore, Exim routes each address in a message independently. DNS
20456 servers run caches, so repeated DNS lookups are not normally expensive, and in
20457 any case, personal messages rarely have more than a few recipients.
20458
20459 If you are running mailing lists with large numbers of subscribers at the same
20460 domain, and you are using a &(manualroute)& router which is independent of the
20461 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20462 lookups for identical domains in one message. In this case, when
20463 &(manualroute)& routes an address to a remote transport, any other unrouted
20464 addresses in the message that have the same domain are automatically given the
20465 same routing without processing them independently. However, this is only done
20466 if &%headers_add%& and &%headers_remove%& are unset.
20467
20468
20469
20470
20471 .section "Routing rules in route_list" "SECID120"
20472 The value of &%route_list%& is a string consisting of a sequence of routing
20473 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20474 entered as two semicolons. Alternatively, the list separator can be changed as
20475 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20476 Empty rules are ignored. The format of each rule is
20477 .display
20478 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20479 .endd
20480 The following example contains two rules, each with a simple domain pattern and
20481 no options:
20482 .code
20483 route_list = \
20484   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20485   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20486 .endd
20487 The three parts of a rule are separated by white space. The pattern and the
20488 list of hosts can be enclosed in quotes if necessary, and if they are, the
20489 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20490 single domain pattern, which is the only mandatory item in the rule. The
20491 pattern is in the same format as one item in a domain list (see section
20492 &<<SECTdomainlist>>&),
20493 except that it may not be the name of an interpolated file.
20494 That is, it may be wildcarded, or a regular expression, or a file or database
20495 lookup (with semicolons doubled, because of the use of semicolon as a separator
20496 in a &%route_list%&).
20497
20498 The rules in &%route_list%& are searched in order until one of the patterns
20499 matches the domain that is being routed. The list of hosts and then options are
20500 then used as described below. If there is no match, the router declines. When
20501 &%route_list%& is set, &%route_data%& must not be set.
20502
20503
20504
20505 .section "Routing rules in route_data" "SECID121"
20506 The use of &%route_list%& is convenient when there are only a small number of
20507 routing rules. For larger numbers, it is easier to use a file or database to
20508 hold the routing information, and use the &%route_data%& option instead.
20509 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20510 Most commonly, &%route_data%& is set as a string that contains an
20511 expansion lookup. For example, suppose we place two routing rules in a file
20512 like this:
20513 .code
20514 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20515 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20516 .endd
20517 This data can be accessed by setting
20518 .code
20519 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20520 .endd
20521 Failure of the lookup results in an empty string, causing the router to
20522 decline. However, you do not have to use a lookup in &%route_data%&. The only
20523 requirement is that the result of expanding the string is a list of hosts,
20524 possibly followed by options, separated by white space. The list of hosts must
20525 be enclosed in quotes if it contains white space.
20526
20527
20528
20529
20530 .section "Format of the list of hosts" "SECID122"
20531 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20532 always separately expanded before use. If the expansion fails, the router
20533 declines. The result of the expansion must be a colon-separated list of names
20534 and/or IP addresses, optionally also including ports.
20535 If the list is written with spaces, it must be protected with quotes.
20536 The format of each item
20537 in the list is described in the next section. The list separator can be changed
20538 as described in section &<<SECTlistsepchange>>&.
20539
20540 If the list of hosts was obtained from a &%route_list%& item, the following
20541 variables are set during its expansion:
20542
20543 .ilist
20544 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20545 If the domain was matched against a regular expression, the numeric variables
20546 &$1$&, &$2$&, etc. may be set. For example:
20547 .code
20548 route_list = ^domain(\d+)   host-$1.text.example
20549 .endd
20550 .next
20551 &$0$& is always set to the entire domain.
20552 .next
20553 &$1$& is also set when partial matching is done in a file lookup.
20554
20555 .next
20556 .vindex "&$value$&"
20557 If the pattern that matched the domain was a lookup item, the data that was
20558 looked up is available in the expansion variable &$value$&. For example:
20559 .code
20560 route_list = lsearch;;/some/file.routes  $value
20561 .endd
20562 .endlist
20563
20564 Note the doubling of the semicolon in the pattern that is necessary because
20565 semicolon is the default route list separator.
20566
20567
20568
20569 .section "Format of one host item" "SECTformatonehostitem"
20570 Each item in the list of hosts can be either a host name or an IP address,
20571 optionally with an attached port number, or it can be a single "+"
20572 (see &%hosts_randomize%&).
20573 When no port is given, an IP address
20574 is not enclosed in brackets. When a port is specified, it overrides the port
20575 specification on the transport. The port is separated from the name or address
20576 by a colon. This leads to some complications:
20577
20578 .ilist
20579 Because colon is the default separator for the list of hosts, either
20580 the colon that specifies a port must be doubled, or the list separator must
20581 be changed. The following two examples have the same effect:
20582 .code
20583 route_list = * "host1.tld::1225 : host2.tld::1226"
20584 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20585 .endd
20586 .next
20587 When IPv6 addresses are involved, it gets worse, because they contain
20588 colons of their own. To make this case easier, it is permitted to
20589 enclose an IP address (either v4 or v6) in square brackets if a port
20590 number follows. For example:
20591 .code
20592 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20593 .endd
20594 .endlist
20595
20596 .section "How the list of hosts is used" "SECThostshowused"
20597 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20598 the hosts is tried, in the order specified, when carrying out the SMTP
20599 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20600 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20601 transport.
20602
20603 Hosts may be listed by name or by IP address. An unadorned name in the list of
20604 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20605 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20606 records in the DNS. For example:
20607 .code
20608 route_list = *  x.y.z:p.q.r/MX:e.f.g
20609 .endd
20610 If this feature is used with a port specifier, the port must come last. For
20611 example:
20612 .code
20613 route_list = *  dom1.tld/mx::1225
20614 .endd
20615 If the &%hosts_randomize%& option is set, the order of the items in the list is
20616 randomized before any lookups are done. Exim then scans the list; for any name
20617 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20618 be an interface on the local host and the item is not the first in the list,
20619 Exim discards it and any subsequent items. If it is the first item, what
20620 happens is controlled by the
20621 .oindex "&%self%&" "in &(manualroute)& router"
20622 &%self%& option of the router.
20623
20624 A name on the list that is followed by &`/MX`& is replaced with the list of
20625 hosts obtained by looking up MX records for the name. This is always a DNS
20626 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20627 below) are not relevant here. The order of these hosts is determined by the
20628 preference values in the MX records, according to the usual rules. Because
20629 randomizing happens before the MX lookup, it does not affect the order that is
20630 defined by MX preferences.
20631
20632 If the local host is present in the sublist obtained from MX records, but is
20633 not the most preferred host in that list, it and any equally or less
20634 preferred hosts are removed before the sublist is inserted into the main list.
20635
20636 If the local host is the most preferred host in the MX list, what happens
20637 depends on where in the original list of hosts the &`/MX`& item appears. If it
20638 is not the first item (that is, there are previous hosts in the main list),
20639 Exim discards this name and any subsequent items in the main list.
20640
20641 If the MX item is first in the list of hosts, and the local host is the
20642 most preferred host, what happens is controlled by the &%self%& option of the
20643 router.
20644
20645 DNS failures when lookup up the MX records are treated in the same way as DNS
20646 failures when looking up IP addresses: &%pass_on_timeout%& and
20647 &%host_find_failed%& are used when relevant.
20648
20649 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20650 whether obtained from an MX lookup or not.
20651
20652
20653
20654 .section "How the options are used" "SECThowoptused"
20655 The options are a sequence of words, space-separated.
20656 One of the words can be the name of a transport; this overrides the
20657 &%transport%& option on the router for this particular routing rule only. The
20658 other words (if present) control randomization of the list of hosts on a
20659 per-rule basis, and how the IP addresses of the hosts are to be found when
20660 routing to a remote transport. These options are as follows:
20661
20662 .ilist
20663 &%randomize%&: randomize the order of the hosts in this list, overriding the
20664 setting of &%hosts_randomize%& for this routing rule only.
20665 .next
20666 &%no_randomize%&: do not randomize the order of the hosts in this list,
20667 overriding the setting of &%hosts_randomize%& for this routing rule only.
20668 .next
20669 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20670 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20671 also look in &_/etc/hosts_& or other sources of information.
20672 .next
20673 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20674 no address records are found. If there is a temporary DNS error (such as a
20675 timeout), delivery is deferred.
20676 .next
20677 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20678 .next
20679 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20680 .endlist
20681
20682 For example:
20683 .code
20684 route_list = domain1  host1:host2:host3  randomize bydns;\
20685              domain2  host4:host5
20686 .endd
20687 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20688 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20689 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20690 or &[gethostbyname()]&, and the result of the lookup is the result of that
20691 call.
20692
20693 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20694 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20695 instead of TRY_AGAIN. That is why the default action is to try a DNS
20696 lookup first. Only if that gives a definite &"no such host"& is the local
20697 function called.
20698
20699 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20700 inadvertent constraint that a transport name as an option had to be the last
20701 option specified.
20702
20703
20704
20705 If no IP address for a host can be found, what happens is controlled by the
20706 &%host_find_failed%& option.
20707
20708 .vindex "&$host$&"
20709 When an address is routed to a local transport, IP addresses are not looked up.
20710 The host list is passed to the transport in the &$host$& variable.
20711
20712
20713
20714 .section "Manualroute examples" "SECID123"
20715 In some of the examples that follow, the presence of the &%remote_smtp%&
20716 transport, as defined in the default configuration file, is assumed:
20717
20718 .ilist
20719 .cindex "smart host" "example router"
20720 The &(manualroute)& router can be used to forward all external mail to a
20721 &'smart host'&. If you have set up, in the main part of the configuration, a
20722 named domain list that contains your local domains, for example:
20723 .code
20724 domainlist local_domains = my.domain.example
20725 .endd
20726 You can arrange for all other domains to be routed to a smart host by making
20727 your first router something like this:
20728 .code
20729 smart_route:
20730   driver = manualroute
20731   domains = !+local_domains
20732   transport = remote_smtp
20733   route_list = * smarthost.ref.example
20734 .endd
20735 This causes all non-local addresses to be sent to the single host
20736 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20737 they are tried in order
20738 (but you can use &%hosts_randomize%& to vary the order each time).
20739 Another way of configuring the same thing is this:
20740 .code
20741 smart_route:
20742   driver = manualroute
20743   transport = remote_smtp
20744   route_list = !+local_domains  smarthost.ref.example
20745 .endd
20746 There is no difference in behaviour between these two routers as they stand.
20747 However, they behave differently if &%no_more%& is added to them. In the first
20748 example, the router is skipped if the domain does not match the &%domains%&
20749 precondition; the following router is always tried. If the router runs, it
20750 always matches the domain and so can never decline. Therefore, &%no_more%&
20751 would have no effect. In the second case, the router is never skipped; it
20752 always runs. However, if it doesn't match the domain, it declines. In this case
20753 &%no_more%& would prevent subsequent routers from running.
20754
20755 .next
20756 .cindex "mail hub example"
20757 A &'mail hub'& is a host which receives mail for a number of domains via MX
20758 records in the DNS and delivers it via its own private routing mechanism. Often
20759 the final destinations are behind a firewall, with the mail hub being the one
20760 machine that can connect to machines both inside and outside the firewall. The
20761 &(manualroute)& router is usually used on a mail hub to route incoming messages
20762 to the correct hosts. For a small number of domains, the routing can be inline,
20763 using the &%route_list%& option, but for a larger number a file or database
20764 lookup is easier to manage.
20765
20766 If the domain names are in fact the names of the machines to which the mail is
20767 to be sent by the mail hub, the configuration can be quite simple. For
20768 example:
20769 .code
20770 hub_route:
20771   driver = manualroute
20772   transport = remote_smtp
20773   route_list = *.rhodes.tvs.example  $domain
20774 .endd
20775 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20776 whose names are the same as the mail domains. A similar approach can be taken
20777 if the host name can be obtained from the domain name by a string manipulation
20778 that the expansion facilities can handle. Otherwise, a lookup based on the
20779 domain can be used to find the host:
20780 .code
20781 through_firewall:
20782   driver = manualroute
20783   transport = remote_smtp
20784   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20785 .endd
20786 The result of the lookup must be the name or IP address of the host (or
20787 hosts) to which the address is to be routed. If the lookup fails, the route
20788 data is empty, causing the router to decline. The address then passes to the
20789 next router.
20790
20791 .next
20792 .cindex "batched SMTP output example"
20793 .cindex "SMTP" "batched outgoing; example"
20794 You can use &(manualroute)& to deliver messages to pipes or files in batched
20795 SMTP format for onward transportation by some other means. This is one way of
20796 storing mail for a dial-up host when it is not connected. The route list entry
20797 can be as simple as a single domain name in a configuration like this:
20798 .code
20799 save_in_file:
20800   driver = manualroute
20801   transport = batchsmtp_appendfile
20802   route_list = saved.domain.example
20803 .endd
20804 though often a pattern is used to pick up more than one domain. If there are
20805 several domains or groups of domains with different transport requirements,
20806 different transports can be listed in the routing information:
20807 .code
20808 save_in_file:
20809   driver = manualroute
20810   route_list = \
20811     *.saved.domain1.example  $domain  batch_appendfile; \
20812     *.saved.domain2.example  \
20813       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20814       batch_pipe
20815 .endd
20816 .vindex "&$domain$&"
20817 .vindex "&$host$&"
20818 The first of these just passes the domain in the &$host$& variable, which
20819 doesn't achieve much (since it is also in &$domain$&), but the second does a
20820 file lookup to find a value to pass, causing the router to decline to handle
20821 the address if the lookup fails.
20822
20823 .next
20824 .cindex "UUCP" "example of router for"
20825 Routing mail directly to UUCP software is a specific case of the use of
20826 &(manualroute)& in a gateway to another mail environment. This is an example of
20827 one way it can be done:
20828 .code
20829 # Transport
20830 uucp:
20831   driver = pipe
20832   user = nobody
20833   command = /usr/local/bin/uux -r - \
20834     ${substr_-5:$host}!rmail ${local_part}
20835   return_fail_output = true
20836
20837 # Router
20838 uucphost:
20839   transport = uucp
20840   driver = manualroute
20841   route_data = \
20842     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20843 .endd
20844 The file &_/usr/local/exim/uucphosts_& contains entries like
20845 .code
20846 darksite.ethereal.example:           darksite.UUCP
20847 .endd
20848 It can be set up more simply without adding and removing &".UUCP"& but this way
20849 makes clear the distinction between the domain name
20850 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20851 .endlist
20852 .ecindex IIDmanrou1
20853 .ecindex IIDmanrou2
20854
20855
20856
20857
20858
20859
20860
20861
20862 . ////////////////////////////////////////////////////////////////////////////
20863 . ////////////////////////////////////////////////////////////////////////////
20864
20865 .chapter "The queryprogram router" "CHAPdriverlast"
20866 .scindex IIDquerou1 "&(queryprogram)& router"
20867 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20868 .cindex "routing" "by external program"
20869 The &(queryprogram)& router routes an address by running an external command
20870 and acting on its output. This is an expensive way to route, and is intended
20871 mainly for use in lightly-loaded systems, or for performing experiments.
20872 However, if it is possible to use the precondition options (&%domains%&,
20873 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20874 be used in special cases, even on a busy host. There are the following private
20875 options:
20876 .cindex "options" "&(queryprogram)& router"
20877
20878 .option command queryprogram string&!! unset
20879 This option must be set. It specifies the command that is to be run. The
20880 command is split up into a command name and arguments, and then each is
20881 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20882 &<<CHAPpipetransport>>&).
20883
20884
20885 .option command_group queryprogram string unset
20886 .cindex "gid (group id)" "in &(queryprogram)& router"
20887 This option specifies a gid to be set when running the command while routing an
20888 address for deliver. It must be set if &%command_user%& specifies a numerical
20889 uid. If it begins with a digit, it is interpreted as the numerical value of the
20890 gid. Otherwise it is looked up using &[getgrnam()]&.
20891
20892
20893 .option command_user queryprogram string unset
20894 .cindex "uid (user id)" "for &(queryprogram)&"
20895 This option must be set. It specifies the uid which is set when running the
20896 command while routing an address for delivery. If the value begins with a digit,
20897 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20898 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20899 not set, a value for the gid also.
20900
20901 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20902 root, which it does during a normal delivery in a conventional configuration.
20903 However, when an address is being verified during message reception, Exim is
20904 usually running as the Exim user, not as root. If the &(queryprogram)& router
20905 is called from a non-root process, Exim cannot change uid or gid before running
20906 the command. In this circumstance the command runs under the current uid and
20907 gid.
20908
20909
20910 .option current_directory queryprogram string /
20911 This option specifies an absolute path which is made the current directory
20912 before running the command.
20913
20914
20915 .option timeout queryprogram time 1h
20916 If the command does not complete within the timeout period, its process group
20917 is killed and the message is frozen. A value of zero time specifies no
20918 timeout.
20919
20920
20921 The standard output of the command is connected to a pipe, which is read when
20922 the command terminates. It should consist of a single line of output,
20923 containing up to five fields, separated by white space. The maximum length of
20924 the line is 1023 characters. Longer lines are silently truncated. The first
20925 field is one of the following words (case-insensitive):
20926
20927 .ilist
20928 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20929 below).
20930 .next
20931 &'Decline'&: the router declines; pass the address to the next router, unless
20932 &%no_more%& is set.
20933 .next
20934 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20935 subsequent text on the line is an error message. If the router is run as part
20936 of address verification during an incoming SMTP message, the message is
20937 included in the SMTP response.
20938 .next
20939 &'Defer'&: routing could not be completed at this time; try again later. Any
20940 subsequent text on the line is an error message which is logged. It is not
20941 included in any SMTP response.
20942 .next
20943 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20944 .next
20945 &'Pass'&: pass the address to the next router (or the router specified by
20946 &%pass_router%&), overriding &%no_more%&.
20947 .next
20948 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20949 new addresses, which are routed independently, starting with the first router,
20950 or the router specified by &%redirect_router%&, if set.
20951 .endlist
20952
20953 When the first word is &'accept'&, the remainder of the line consists of a
20954 number of keyed data values, as follows (split into two lines here, to fit on
20955 the page):
20956 .code
20957 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20958 LOOKUP=byname|bydns DATA=<text>
20959 .endd
20960 The data items can be given in any order, and all are optional. If no transport
20961 is included, the transport specified by the generic &%transport%& option is
20962 used. The list of hosts and the lookup type are needed only if the transport is
20963 an &(smtp)& transport that does not itself supply a list of hosts.
20964
20965 The format of the list of hosts is the same as for the &(manualroute)& router.
20966 As well as host names and IP addresses with optional port numbers, as described
20967 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20968 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20969 (see section &<<SECThostshowused>>&).
20970
20971 If the lookup type is not specified, Exim behaves as follows when trying to
20972 find an IP address for each host: First, a DNS lookup is done. If this yields
20973 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20974 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20975 result of the lookup is the result of that call.
20976
20977 .vindex "&$address_data$&"
20978 If the DATA field is set, its value is placed in the &$address_data$&
20979 variable. For example, this return line
20980 .code
20981 accept hosts=x1.y.example:x2.y.example data="rule1"
20982 .endd
20983 routes the address to the default transport, passing a list of two hosts. When
20984 the transport runs, the string &"rule1"& is in &$address_data$&.
20985 .ecindex IIDquerou1
20986 .ecindex IIDquerou2
20987
20988
20989
20990
20991 . ////////////////////////////////////////////////////////////////////////////
20992 . ////////////////////////////////////////////////////////////////////////////
20993
20994 .chapter "The redirect router" "CHAPredirect"
20995 .scindex IIDredrou1 "&(redirect)& router"
20996 .scindex IIDredrou2 "routers" "&(redirect)&"
20997 .cindex "alias file" "in a &(redirect)& router"
20998 .cindex "address redirection" "&(redirect)& router"
20999 The &(redirect)& router handles several kinds of address redirection. Its most
21000 common uses are for resolving local part aliases from a central alias file
21001 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21002 files, but it has many other potential uses. The incoming address can be
21003 redirected in several different ways:
21004
21005 .ilist
21006 It can be replaced by one or more new addresses which are themselves routed
21007 independently.
21008 .next
21009 It can be routed to be delivered to a given file or directory.
21010 .next
21011 It can be routed to be delivered to a specified pipe command.
21012 .next
21013 It can cause an automatic reply to be generated.
21014 .next
21015 It can be forced to fail, optionally with a custom error message.
21016 .next
21017 It can be temporarily deferred, optionally with a custom message.
21018 .next
21019 It can be discarded.
21020 .endlist
21021
21022 The generic &%transport%& option must not be set for &(redirect)& routers.
21023 However, there are some private options which define transports for delivery to
21024 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21025 &%pipe_transport%& and &%reply_transport%& descriptions below.
21026
21027 If success DSNs have been requested
21028 .cindex "DSN" "success"
21029 .cindex "Delivery Status Notification" "success"
21030 redirection triggers one and the DSN options are not passed any further.
21031
21032
21033
21034 .section "Redirection data" "SECID124"
21035 The router operates by interpreting a text string which it obtains either by
21036 expanding the contents of the &%data%& option, or by reading the entire
21037 contents of a file whose name is given in the &%file%& option. These two
21038 options are mutually exclusive. The first is commonly used for handling system
21039 aliases, in a configuration like this:
21040 .code
21041 system_aliases:
21042   driver = redirect
21043   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21044 .endd
21045 If the lookup fails, the expanded string in this example is empty. When the
21046 expansion of &%data%& results in an empty string, the router declines. A forced
21047 expansion failure also causes the router to decline; other expansion failures
21048 cause delivery to be deferred.
21049
21050 A configuration using &%file%& is commonly used for handling users'
21051 &_.forward_& files, like this:
21052 .code
21053 userforward:
21054   driver = redirect
21055   check_local_user
21056   file = $home/.forward
21057   no_verify
21058 .endd
21059 If the file does not exist, or causes no action to be taken (for example, it is
21060 empty or consists only of comments), the router declines. &*Warning*&: This
21061 is not the case when the file contains syntactically valid items that happen to
21062 yield empty addresses, for example, items containing only RFC 2822 address
21063 comments.
21064
21065 .cindex "tainted data" "in filenames"
21066 .cindex redirect "tainted data"
21067 Tainted data may not be used for a filename.
21068
21069 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21070 directly for redirection,
21071 as they are provided by a potential attacker.
21072 In the examples above, &$local_part$& is used for looking up data held locally
21073 on the system, and not used directly (the second example derives &$home$& via
21074 the passsword file or database, using &$local_part$&).
21075
21076
21077
21078 .section "Forward files and address verification" "SECID125"
21079 .cindex "address redirection" "while verifying"
21080 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21081 &_.forward_& files, as in the example above. There are two reasons for this:
21082
21083 .ilist
21084 When Exim is receiving an incoming SMTP message from a remote host, it is
21085 running under the Exim uid, not as root. Exim is unable to change uid to read
21086 the file as the user, and it may not be able to read it as the Exim user. So in
21087 practice the router may not be able to operate.
21088 .next
21089 However, even when the router can operate, the existence of a &_.forward_& file
21090 is unimportant when verifying an address. What should be checked is whether the
21091 local part is a valid user name or not. Cutting out the redirection processing
21092 saves some resources.
21093 .endlist
21094
21095
21096
21097
21098
21099
21100 .section "Interpreting redirection data" "SECID126"
21101 .cindex "Sieve filter" "specifying in redirection data"
21102 .cindex "filter" "specifying in redirection data"
21103 The contents of the data string, whether obtained from &%data%& or &%file%&,
21104 can be interpreted in two different ways:
21105
21106 .ilist
21107 If the &%allow_filter%& option is set true, and the data begins with the text
21108 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21109 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21110 respectively. Details of the syntax and semantics of filter files are described
21111 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21112 document is intended for use by end users.
21113 .next
21114 Otherwise, the data must be a comma-separated list of redirection items, as
21115 described in the next section.
21116 .endlist
21117
21118 When a message is redirected to a file (a &"mail folder"&), the filename given
21119 in a non-filter redirection list must always be an absolute path. A filter may
21120 generate a relative path &-- how this is handled depends on the transport's
21121 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21122 for the &(appendfile)& transport.
21123
21124
21125
21126 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21127 .cindex "address redirection" "non-filter list items"
21128 When the redirection data is not an Exim or Sieve filter, for example, if it
21129 comes from a conventional alias or forward file, it consists of a list of
21130 addresses, filenames, pipe commands, or certain special items (see section
21131 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21132 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21133 depending on their default values. The items in the list are separated by
21134 commas or newlines.
21135 If a comma is required in an item, the entire item must be enclosed in double
21136 quotes.
21137
21138 Lines starting with a # character are comments, and are ignored, and # may
21139 also appear following a comma, in which case everything between the # and the
21140 next newline character is ignored.
21141
21142 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21143 double quotes are retained because some forms of mail address require their use
21144 (but never to enclose the entire address). In the following description,
21145 &"item"& refers to what remains after any surrounding double quotes have been
21146 removed.
21147
21148 .vindex "&$local_part$&"
21149 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21150 and the expansion contains a reference to &$local_part$&, you should make use
21151 of the &%quote_local_part%& expansion operator, in case the local part contains
21152 special characters. For example, to redirect all mail for the domain
21153 &'obsolete.example'&, retaining the existing local part, you could use this
21154 setting:
21155 .code
21156 data = ${quote_local_part:$local_part}@newdomain.example
21157 .endd
21158
21159
21160 .section "Redirecting to a local mailbox" "SECTredlocmai"
21161 .cindex "routing" "loops in"
21162 .cindex "loop" "while routing, avoidance of"
21163 .cindex "address redirection" "to local mailbox"
21164 A redirection item may safely be the same as the address currently under
21165 consideration. This does not cause a routing loop, because a router is
21166 automatically skipped if any ancestor of the address that is being processed
21167 is the same as the current address and was processed by the current router.
21168 Such an address is therefore passed to the following routers, so it is handled
21169 as if there were no redirection. When making this loop-avoidance test, the
21170 complete local part, including any prefix or suffix, is used.
21171
21172 .cindex "address redirection" "local part without domain"
21173 Specifying the same local part without a domain is a common usage in personal
21174 filter files when the user wants to have messages delivered to the local
21175 mailbox and also forwarded elsewhere. For example, the user whose login is
21176 &'cleo'& might have a &_.forward_& file containing this:
21177 .code
21178 cleo, cleopatra@egypt.example
21179 .endd
21180 .cindex "backslash in alias file"
21181 .cindex "alias file" "backslash in"
21182 For compatibility with other MTAs, such unqualified local parts may be
21183 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21184 it does make a difference if more than one domain is being handled
21185 synonymously.
21186
21187 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21188 2822 address that does not include a domain, the item is qualified using the
21189 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21190 addresses are qualified using the value in &%qualify_recipient%&, but you can
21191 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21192
21193 Care must be taken if there are alias names for local users.
21194 Consider an MTA handling a single local domain where the system alias file
21195 contains:
21196 .code
21197 Sam.Reman: spqr
21198 .endd
21199 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21200 messages in the local mailbox, and also forward copies elsewhere. He creates
21201 this forward file:
21202 .code
21203 Sam.Reman, spqr@reme.elsewhere.example
21204 .endd
21205 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21206 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21207 second time round, because it has previously routed it,
21208 and the following routers presumably cannot handle the alias. The forward file
21209 should really contain
21210 .code
21211 spqr, spqr@reme.elsewhere.example
21212 .endd
21213 but because this is such a common error, the &%check_ancestor%& option (see
21214 below) exists to provide a way to get round it. This is normally set on a
21215 &(redirect)& router that is handling users' &_.forward_& files.
21216
21217
21218
21219 .section "Special items in redirection lists" "SECTspecitredli"
21220 In addition to addresses, the following types of item may appear in redirection
21221 lists (that is, in non-filter redirection data):
21222
21223 .ilist
21224 .cindex "pipe" "in redirection list"
21225 .cindex "address redirection" "to pipe"
21226 An item is treated as a pipe command if it begins with &"|"& and does not parse
21227 as a valid RFC 2822 address that includes a domain. A transport for running the
21228 command must be specified by the &%pipe_transport%& option.
21229 Normally, either the router or the transport specifies a user and a group under
21230 which to run the delivery. The default is to use the Exim user and group.
21231
21232 Single or double quotes can be used for enclosing the individual arguments of
21233 the pipe command; no interpretation of escapes is done for single quotes. If
21234 the command contains a comma character, it is necessary to put the whole item
21235 in double quotes, for example:
21236 .code
21237 "|/some/command ready,steady,go"
21238 .endd
21239 since items in redirection lists are terminated by commas. Do not, however,
21240 quote just the command. An item such as
21241 .code
21242 |"/some/command ready,steady,go"
21243 .endd
21244 is interpreted as a pipe with a rather strange command name, and no arguments.
21245
21246 Note that the above example assumes that the text comes from a lookup source
21247 of some sort, so that the quotes are part of the data.  If composing a
21248 redirect router with a &%data%& option directly specifying this command, the
21249 quotes will be used by the configuration parser to define the extent of one
21250 string, but will not be passed down into the redirect router itself.  There
21251 are two main approaches to get around this: escape quotes to be part of the
21252 data itself, or avoid using this mechanism and instead create a custom
21253 transport with the &%command%& option set and reference that transport from
21254 an &%accept%& router.
21255
21256 .next
21257 .cindex "file" "in redirection list"
21258 .cindex "address redirection" "to file"
21259 An item is interpreted as a path name if it begins with &"/"& and does not
21260 parse as a valid RFC 2822 address that includes a domain. For example,
21261 .code
21262 /home/world/minbari
21263 .endd
21264 is treated as a filename, but
21265 .code
21266 /s=molari/o=babylon/@x400gate.way
21267 .endd
21268 is treated as an address. For a filename, a transport must be specified using
21269 the &%file_transport%& option. However, if the generated path name ends with a
21270 forward slash character, it is interpreted as a directory name rather than a
21271 filename, and &%directory_transport%& is used instead.
21272
21273 Normally, either the router or the transport specifies a user and a group under
21274 which to run the delivery. The default is to use the Exim user and group.
21275
21276 .cindex "&_/dev/null_&"
21277 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21278 bypassed at a high level, and the log entry shows &"**bypassed**"&
21279 instead of a transport name. In this case the user and group are not used.
21280
21281 .next
21282 .cindex "included address list"
21283 .cindex "address redirection" "included external list"
21284 If an item is of the form
21285 .code
21286 :include:<path name>
21287 .endd
21288 a list of further items is taken from the given file and included at that
21289 point. &*Note*&: Such a file can not be a filter file; it is just an
21290 out-of-line addition to the list. The items in the included list are separated
21291 by commas or newlines and are not subject to expansion. If this is the first
21292 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21293 the alias name. This example is incorrect:
21294 .code
21295 list1    :include:/opt/lists/list1
21296 .endd
21297 It must be given as
21298 .code
21299 list1:   :include:/opt/lists/list1
21300 .endd
21301 .cindex "tainted data" "in filenames"
21302 .cindex redirect "tainted data"
21303 Tainted data may not be used for a filename.
21304 .next
21305 .cindex "address redirection" "to black hole"
21306 .cindex "delivery" "discard"
21307 .cindex "delivery" "blackhole"
21308 .cindex "black hole"
21309 .cindex "abandoning mail"
21310 Sometimes you want to throw away mail to a particular local part.  Making the
21311 &%data%& option expand to an empty string does not work, because that causes
21312 the router to decline. Instead, the alias item
21313 .code
21314 :blackhole:
21315 .endd
21316 can be used. It does what its name implies. No delivery is
21317 done, and no error message is generated. This has the same effect as specifying
21318 &_/dev/null_& as a destination, but it can be independently disabled.
21319
21320 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21321 delivery is done for the original local part, even if other redirection items
21322 are present. If you are generating a multi-item list (for example, by reading a
21323 database) and need the ability to provide a no-op item, you must use
21324 &_/dev/null_&.
21325
21326 .next
21327 .cindex "delivery" "forcing failure"
21328 .cindex "delivery" "forcing deferral"
21329 .cindex "failing delivery" "forcing"
21330 .cindex "deferred delivery, forcing"
21331 .cindex "customizing" "failure message"
21332 An attempt to deliver a particular address can be deferred or forced to fail by
21333 redirection items of the form
21334 .code
21335 :defer:
21336 :fail:
21337 .endd
21338 respectively. When a redirection list contains such an item, it applies
21339 to the entire redirection; any other items in the list are ignored. Any
21340 text following &':fail:'& or &':defer:'& is placed in the error text
21341 associated with the failure. For example, an alias file might contain:
21342 .code
21343 X.Employee:  :fail: Gone away, no forwarding address
21344 .endd
21345 In the case of an address that is being verified from an ACL or as the subject
21346 of a
21347 .cindex "VRFY" "error text, display of"
21348 VRFY command, the text is included in the SMTP error response by
21349 default.
21350 .cindex "EXPN" "error text, display of"
21351 The text is not included in the response to an EXPN command. In non-SMTP cases
21352 the text is included in the error message that Exim generates.
21353
21354 .cindex "SMTP" "error codes"
21355 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21356 &':fail:'&. However, if the message starts with three digits followed by a
21357 space, optionally followed by an extended code of the form &'n.n.n'&, also
21358 followed by a space, and the very first digit is the same as the default error
21359 code, the code from the message is used instead. If the very first digit is
21360 incorrect, a panic error is logged, and the default code is used. You can
21361 suppress the use of the supplied code in a redirect router by setting the
21362 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21363 ignored.
21364
21365 .vindex "&$acl_verify_message$&"
21366 In an ACL, an explicitly provided message overrides the default, but the
21367 default message is available in the variable &$acl_verify_message$& and can
21368 therefore be included in a custom message if this is desired.
21369
21370 Normally the error text is the rest of the redirection list &-- a comma does
21371 not terminate it &-- but a newline does act as a terminator. Newlines are not
21372 normally present in alias expansions. In &(lsearch)& lookups they are removed
21373 as part of the continuation process, but they may exist in other kinds of
21374 lookup and in &':include:'& files.
21375
21376 During routing for message delivery (as opposed to verification), a redirection
21377 containing &':fail:'& causes an immediate failure of the incoming address,
21378 whereas &':defer:'& causes the message to remain in the queue so that a
21379 subsequent delivery attempt can happen at a later time. If an address is
21380 deferred for too long, it will ultimately fail, because the normal retry
21381 rules still apply.
21382
21383 .next
21384 .cindex "alias file" "exception to default"
21385 Sometimes it is useful to use a single-key search type with a default (see
21386 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21387 for exceptions to the default. These can be handled by aliasing them to
21388 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21389 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21390 results in an empty redirection list has the same effect.
21391 .endlist
21392
21393
21394 .section "Duplicate addresses" "SECTdupaddr"
21395 .cindex "duplicate addresses"
21396 .cindex "address duplicate, discarding"
21397 .cindex "pipe" "duplicated"
21398 Exim removes duplicate addresses from the list to which it is delivering, so as
21399 to deliver just one copy to each address. This does not apply to deliveries
21400 routed to pipes by different immediate parent addresses, but an indirect
21401 aliasing scheme of the type
21402 .code
21403 pipe:       |/some/command $local_part
21404 localpart1: pipe
21405 localpart2: pipe
21406 .endd
21407 does not work with a message that is addressed to both local parts, because
21408 when the second is aliased to the intermediate local part &"pipe"& it gets
21409 discarded as being the same as a previously handled address. However, a scheme
21410 such as
21411 .code
21412 localpart1: |/some/command $local_part
21413 localpart2: |/some/command $local_part
21414 .endd
21415 does result in two different pipe deliveries, because the immediate parents of
21416 the pipes are distinct.
21417
21418
21419
21420 .section "Repeated redirection expansion" "SECID128"
21421 .cindex "repeated redirection expansion"
21422 .cindex "address redirection" "repeated for each delivery attempt"
21423 When a message cannot be delivered to all of its recipients immediately,
21424 leading to two or more delivery attempts, redirection expansion is carried out
21425 afresh each time for those addresses whose children were not all previously
21426 delivered. If redirection is being used as a mailing list, this can lead to new
21427 members of the list receiving copies of old messages. The &%one_time%& option
21428 can be used to avoid this.
21429
21430
21431 .section "Errors in redirection lists" "SECID129"
21432 .cindex "address redirection" "errors"
21433 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21434 error is skipped, and an entry is written to the main log. This may be useful
21435 for mailing lists that are automatically managed. Otherwise, if an error is
21436 detected while generating the list of new addresses, the original address is
21437 deferred. See also &%syntax_errors_to%&.
21438
21439
21440
21441 .section "Private options for the redirect router" "SECID130"
21442
21443 .cindex "options" "&(redirect)& router"
21444 The private options for the &(redirect)& router are as follows:
21445
21446
21447 .option allow_defer redirect boolean false
21448 Setting this option allows the use of &':defer:'& in non-filter redirection
21449 data, or the &%defer%& command in an Exim filter file.
21450
21451
21452 .option allow_fail redirect boolean false
21453 .cindex "failing delivery" "from filter"
21454 If this option is true, the &':fail:'& item can be used in a redirection list,
21455 and the &%fail%& command may be used in an Exim filter file.
21456
21457
21458 .option allow_filter redirect boolean false
21459 .cindex "filter" "enabling use of"
21460 .cindex "Sieve filter" "enabling use of"
21461 Setting this option allows Exim to interpret redirection data that starts with
21462 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21463 are some features of Exim filter files that some administrators may wish to
21464 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21465
21466 It is also possible to lock out Exim filters or Sieve filters while allowing
21467 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21468
21469
21470 The filter is run using the uid and gid set by the generic &%user%& and
21471 &%group%& options. These take their defaults from the password data if
21472 &%check_local_user%& is set, so in the normal case of users' personal filter
21473 files, the filter is run as the relevant user. When &%allow_filter%& is set
21474 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21475
21476
21477
21478 .option allow_freeze redirect boolean false
21479 .cindex "freezing messages" "allowing in filter"
21480 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21481 This command is more normally encountered in system filters, and is disabled by
21482 default for redirection filters because it isn't something you usually want to
21483 let ordinary users do.
21484
21485
21486
21487 .option check_ancestor redirect boolean false
21488 This option is concerned with handling generated addresses that are the same
21489 as some address in the list of redirection ancestors of the current address.
21490 Although it is turned off by default in the code, it is set in the default
21491 configuration file for handling users' &_.forward_& files. It is recommended
21492 for this use of the &(redirect)& router.
21493
21494 When &%check_ancestor%& is set, if a generated address (including the domain)
21495 is the same as any ancestor of the current address, it is replaced by a copy of
21496 the current address. This helps in the case where local part A is aliased to B,
21497 and B has a &_.forward_& file pointing back to A. For example, within a single
21498 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21499 &_&~jb/.forward_& contains:
21500 .code
21501 \Joe.Bloggs, <other item(s)>
21502 .endd
21503 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21504 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21505 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21506 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21507 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21508 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21509 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21510 original address. See also the &%repeat_use%& option below.
21511
21512
21513 .option check_group redirect boolean "see below"
21514 When the &%file%& option is used, the group owner of the file is checked only
21515 when this option is set. The permitted groups are those listed in the
21516 &%owngroups%& option, together with the user's default group if
21517 &%check_local_user%& is set. If the file has the wrong group, routing is
21518 deferred. The default setting for this option is true if &%check_local_user%&
21519 is set and the &%modemask%& option permits the group write bit, or if the
21520 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21521
21522
21523
21524 .option check_owner redirect boolean "see below"
21525 When the &%file%& option is used, the owner of the file is checked only when
21526 this option is set. If &%check_local_user%& is set, the local user is
21527 permitted; otherwise the owner must be one of those listed in the &%owners%&
21528 option. The default value for this option is true if &%check_local_user%& or
21529 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21530
21531
21532 .option data redirect string&!! unset
21533 This option is mutually exclusive with &%file%&. One or other of them must be
21534 set, but not both. The contents of &%data%& are expanded, and then used as the
21535 list of forwarding items, or as a set of filtering instructions. If the
21536 expansion is forced to fail, or the result is an empty string or a string that
21537 has no effect (consists entirely of comments), the router declines.
21538
21539 When filtering instructions are used, the string must begin with &"#Exim
21540 filter"&, and all comments in the string, including this initial one, must be
21541 terminated with newline characters. For example:
21542 .code
21543 data = #Exim filter\n\
21544        if $h_to: contains Exim then save $home/mail/exim endif
21545 .endd
21546 If you are reading the data from a database where newlines cannot be included,
21547 you can use the &${sg}$& expansion item to turn the escape string of your
21548 choice into a newline.
21549
21550
21551 .option directory_transport redirect string&!! unset
21552 A &(redirect)& router sets up a direct delivery to a directory when a path name
21553 ending with a slash is specified as a new &"address"&. The transport used is
21554 specified by this option, which, after expansion, must be the name of a
21555 configured transport. This should normally be an &(appendfile)& transport.
21556
21557
21558 .option file redirect string&!! unset
21559 This option specifies the name of a file that contains the redirection data. It
21560 is mutually exclusive with the &%data%& option. The string is expanded before
21561 use; if the expansion is forced to fail, the router declines. Other expansion
21562 failures cause delivery to be deferred. The result of a successful expansion
21563 must be an absolute path. The entire file is read and used as the redirection
21564 data. If the data is an empty string or a string that has no effect (consists
21565 entirely of comments), the router declines.
21566
21567 .cindex "NFS" "checking for file existence"
21568 If the attempt to open the file fails with a &"does not exist"& error, Exim
21569 runs a check on the containing directory,
21570 unless &%ignore_enotdir%& is true (see below).
21571 If the directory does not appear to exist, delivery is deferred. This can
21572 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21573 is a mount problem. If the containing directory does exist, but the file does
21574 not, the router declines.
21575
21576
21577 .option file_transport redirect string&!! unset
21578 .vindex "&$address_file$&"
21579 A &(redirect)& router sets up a direct delivery to a file when a path name not
21580 ending in a slash is specified as a new &"address"&. The transport used is
21581 specified by this option, which, after expansion, must be the name of a
21582 configured transport. This should normally be an &(appendfile)& transport. When
21583 it is running, the filename is in &$address_file$&.
21584
21585
21586 .option filter_prepend_home redirect boolean true
21587 When this option is true, if a &(save)& command in an Exim filter specifies a
21588 relative path, and &$home$& is defined, it is automatically prepended to the
21589 relative path. If this option is set false, this action does not happen. The
21590 relative path is then passed to the transport unmodified.
21591
21592
21593 .option forbid_blackhole redirect boolean false
21594 .cindex "restricting access to features"
21595 .cindex "filter" "locking out certain features"
21596 If this option is true, the &':blackhole:'& item may not appear in a
21597 redirection list.
21598
21599
21600 .option forbid_exim_filter redirect boolean false
21601 .cindex "restricting access to features"
21602 .cindex "filter" "locking out certain features"
21603 If this option is set true, only Sieve filters are permitted when
21604 &%allow_filter%& is true.
21605
21606
21607
21608
21609 .option forbid_file redirect boolean false
21610 .cindex "restricting access to features"
21611 .cindex "delivery" "to file; forbidding"
21612 .cindex "filter" "locking out certain features"
21613 .cindex "Sieve filter" "forbidding delivery to a file"
21614 .cindex "Sieve filter" "&""keep""& facility; disabling"
21615 If this option is true, this router may not generate a new address that
21616 specifies delivery to a local file or directory, either from a filter or from a
21617 conventional forward file. This option is forced to be true if &%one_time%& is
21618 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21619 locks out the Sieve's &"keep"& facility.
21620
21621
21622 .option forbid_filter_dlfunc redirect boolean false
21623 .cindex "restricting access to features"
21624 .cindex "filter" "locking out certain features"
21625 If this option is true, string expansions in Exim filters are not allowed to
21626 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21627 functions.
21628
21629 .option forbid_filter_existstest redirect boolean false
21630 .cindex "restricting access to features"
21631 .cindex "filter" "locking out certain features"
21632 .cindex "expansion" "statting a file"
21633 If this option is true, string expansions in Exim filters are not allowed to
21634 make use of the &%exists%& condition or the &%stat%& expansion item.
21635
21636 .option forbid_filter_logwrite redirect boolean false
21637 .cindex "restricting access to features"
21638 .cindex "filter" "locking out certain features"
21639 If this option is true, use of the logging facility in Exim filters is not
21640 permitted. Logging is in any case available only if the filter is being run
21641 under some unprivileged uid (which is normally the case for ordinary users'
21642 &_.forward_& files).
21643
21644
21645 .option forbid_filter_lookup redirect boolean false
21646 .cindex "restricting access to features"
21647 .cindex "filter" "locking out certain features"
21648 If this option is true, string expansions in Exim filter files are not allowed
21649 to make use of &%lookup%& items.
21650
21651
21652 .option forbid_filter_perl redirect boolean false
21653 .cindex "restricting access to features"
21654 .cindex "filter" "locking out certain features"
21655 This option has an effect only if Exim is built with embedded Perl support. If
21656 it is true, string expansions in Exim filter files are not allowed to make use
21657 of the embedded Perl support.
21658
21659
21660 .option forbid_filter_readfile redirect boolean false
21661 .cindex "restricting access to features"
21662 .cindex "filter" "locking out certain features"
21663 If this option is true, string expansions in Exim filter files are not allowed
21664 to make use of &%readfile%& items.
21665
21666
21667 .option forbid_filter_readsocket redirect boolean false
21668 .cindex "restricting access to features"
21669 .cindex "filter" "locking out certain features"
21670 If this option is true, string expansions in Exim filter files are not allowed
21671 to make use of &%readsocket%& items.
21672
21673
21674 .option forbid_filter_reply redirect boolean false
21675 .cindex "restricting access to features"
21676 .cindex "filter" "locking out certain features"
21677 If this option is true, this router may not generate an automatic reply
21678 message. Automatic replies can be generated only from Exim or Sieve filter
21679 files, not from traditional forward files. This option is forced to be true if
21680 &%one_time%& is set.
21681
21682
21683 .option forbid_filter_run redirect boolean false
21684 .cindex "restricting access to features"
21685 .cindex "filter" "locking out certain features"
21686 If this option is true, string expansions in Exim filter files are not allowed
21687 to make use of &%run%& items.
21688
21689
21690 .option forbid_include redirect boolean false
21691 .cindex "restricting access to features"
21692 .cindex "filter" "locking out certain features"
21693 If this option is true, items of the form
21694 .code
21695 :include:<path name>
21696 .endd
21697 are not permitted in non-filter redirection lists.
21698
21699
21700 .option forbid_pipe redirect boolean false
21701 .cindex "restricting access to features"
21702 .cindex "filter" "locking out certain features"
21703 .cindex "delivery" "to pipe; forbidding"
21704 If this option is true, this router may not generate a new address which
21705 specifies delivery to a pipe, either from an Exim filter or from a conventional
21706 forward file. This option is forced to be true if &%one_time%& is set.
21707
21708
21709 .option forbid_sieve_filter redirect boolean false
21710 .cindex "restricting access to features"
21711 .cindex "filter" "locking out certain features"
21712 If this option is set true, only Exim filters are permitted when
21713 &%allow_filter%& is true.
21714
21715
21716 .cindex "SMTP" "error codes"
21717 .option forbid_smtp_code redirect boolean false
21718 If this option is set true, any SMTP error codes that are present at the start
21719 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21720 the default codes (451 and 550, respectively) are always used.
21721
21722
21723
21724
21725 .option hide_child_in_errmsg redirect boolean false
21726 .cindex "bounce message" "redirection details; suppressing"
21727 If this option is true, it prevents Exim from quoting a child address if it
21728 generates a bounce or delay message for it. Instead it says &"an address
21729 generated from <&'the top level address'&>"&. Of course, this applies only to
21730 bounces generated locally. If a message is forwarded to another host, &'its'&
21731 bounce may well quote the generated address.
21732
21733
21734 .option ignore_eacces redirect boolean false
21735 .cindex "EACCES"
21736 If this option is set and an attempt to open a redirection file yields the
21737 EACCES error (permission denied), the &(redirect)& router behaves as if the
21738 file did not exist.
21739
21740
21741 .option ignore_enotdir redirect boolean false
21742 .cindex "ENOTDIR"
21743 If this option is set and an attempt to open a redirection file yields the
21744 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21745 router behaves as if the file did not exist.
21746
21747 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21748 router that has the &%file%& option set discovers that the file does not exist
21749 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21750 against unmounted NFS directories. If the parent can not be statted, delivery
21751 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21752 is set, because that option tells Exim to ignore &"something on the path is not
21753 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21754 that some operating systems give ENOENT where others give ENOTDIR.
21755
21756
21757
21758 .option include_directory redirect string unset
21759 If this option is set, the path names of any &':include:'& items in a
21760 redirection list must start with this directory.
21761
21762
21763 .option modemask redirect "octal integer" 022
21764 This specifies mode bits which must not be set for a file specified by the
21765 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21766
21767
21768 .option one_time redirect boolean false
21769 .cindex "one-time aliasing/forwarding expansion"
21770 .cindex "alias file" "one-time expansion"
21771 .cindex "forward file" "one-time expansion"
21772 .cindex "mailing lists" "one-time expansion"
21773 .cindex "address redirection" "one-time expansion"
21774 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21775 files each time it tries to deliver a message causes a problem when one or more
21776 of the generated addresses fails be delivered at the first attempt. The problem
21777 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21778 but of what happens when the redirection list changes during the time that the
21779 message is on Exim's queue. This is particularly true in the case of mailing
21780 lists, where new subscribers might receive copies of messages that were posted
21781 before they subscribed.
21782
21783 If &%one_time%& is set and any addresses generated by the router fail to
21784 deliver at the first attempt, the failing addresses are added to the message as
21785 &"top level"& addresses, and the parent address that generated them is marked
21786 &"delivered"&. Thus, redirection does not happen again at the next delivery
21787 attempt.
21788
21789 &*Warning 1*&: Any header line addition or removal that is specified by this
21790 router would be lost if delivery did not succeed at the first attempt. For this
21791 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21792 permitted when &%one_time%& is set.
21793
21794 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21795 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21796 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21797
21798 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21799 &%one_time%&.
21800
21801 The original top-level address is remembered with each of the generated
21802 addresses, and is output in any log messages. However, any intermediate parent
21803 addresses are not recorded. This makes a difference to the log only if
21804 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21805 typically be used for mailing lists, where there is normally just one level of
21806 expansion.
21807
21808
21809 .option owners redirect "string list" unset
21810 .cindex "ownership" "alias file"
21811 .cindex "ownership" "forward file"
21812 .cindex "alias file" "ownership"
21813 .cindex "forward file" "ownership"
21814 This specifies a list of permitted owners for the file specified by &%file%&.
21815 This list is in addition to the local user when &%check_local_user%& is set.
21816 See &%check_owner%& above.
21817
21818
21819 .option owngroups redirect "string list" unset
21820 This specifies a list of permitted groups for the file specified by &%file%&.
21821 The list is in addition to the local user's primary group when
21822 &%check_local_user%& is set. See &%check_group%& above.
21823
21824
21825 .option pipe_transport redirect string&!! unset
21826 .vindex "&$address_pipe$&"
21827 A &(redirect)& router sets up a direct delivery to a pipe when a string
21828 starting with a vertical bar character is specified as a new &"address"&. The
21829 transport used is specified by this option, which, after expansion, must be the
21830 name of a configured transport. This should normally be a &(pipe)& transport.
21831 When the transport is run, the pipe command is in &$address_pipe$&.
21832
21833
21834 .option qualify_domain redirect string&!! unset
21835 .vindex "&$qualify_recipient$&"
21836 If this option is set, and an unqualified address (one without a domain) is
21837 generated, and that address would normally be qualified by the global setting
21838 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21839 expanding this string. If the expansion fails, the router declines. If you want
21840 to revert to the default, you can have the expansion generate
21841 &$qualify_recipient$&.
21842
21843 This option applies to all unqualified addresses generated by Exim filters,
21844 but for traditional &_.forward_& files, it applies only to addresses that are
21845 not preceded by a backslash. Sieve filters cannot generate unqualified
21846 addresses.
21847
21848 .option qualify_preserve_domain redirect boolean false
21849 .cindex "domain" "in redirection; preserving"
21850 .cindex "preserving domain in redirection"
21851 .cindex "address redirection" "domain; preserving"
21852 If this option is set, the router's local &%qualify_domain%& option must not be
21853 set (a configuration error occurs if it is). If an unqualified address (one
21854 without a domain) is generated, it is qualified with the domain of the parent
21855 address (the immediately preceding ancestor) instead of the global
21856 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21857 this applies whether or not the address is preceded by a backslash.
21858
21859
21860 .option repeat_use redirect boolean true
21861 If this option is set false, the router is skipped for a child address that has
21862 any ancestor that was routed by this router. This test happens before any of
21863 the other preconditions are tested. Exim's default anti-looping rules skip
21864 only when the ancestor is the same as the current address. See also
21865 &%check_ancestor%& above and the generic &%redirect_router%& option.
21866
21867
21868 .option reply_transport redirect string&!! unset
21869 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21870 &%vacation%& command is used in a filter file. The transport used is specified
21871 by this option, which, after expansion, must be the name of a configured
21872 transport. This should normally be an &(autoreply)& transport. Other transports
21873 are unlikely to do anything sensible or useful.
21874
21875
21876 .option rewrite redirect boolean true
21877 .cindex "address redirection" "disabling rewriting"
21878 If this option is set false, addresses generated by the router are not
21879 subject to address rewriting. Otherwise, they are treated like new addresses
21880 and are rewritten according to the global rewriting rules.
21881
21882
21883 .option sieve_subaddress redirect string&!! unset
21884 The value of this option is passed to a Sieve filter to specify the
21885 :subaddress part of an address.
21886
21887 .option sieve_useraddress redirect string&!! unset
21888 The value of this option is passed to a Sieve filter to specify the :user part
21889 of an address. However, if it is unset, the entire original local part
21890 (including any prefix or suffix) is used for :user.
21891
21892
21893 .option sieve_vacation_directory redirect string&!! unset
21894 .cindex "Sieve filter" "vacation directory"
21895 To enable the &"vacation"& extension for Sieve filters, you must set
21896 &%sieve_vacation_directory%& to the directory where vacation databases are held
21897 (do not put anything else in that directory), and ensure that the
21898 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21899 needs their own directory; Exim will create it if necessary.
21900
21901
21902
21903 .option skip_syntax_errors redirect boolean false
21904 .cindex "forward file" "broken"
21905 .cindex "address redirection" "broken files"
21906 .cindex "alias file" "broken"
21907 .cindex "broken alias or forward files"
21908 .cindex "ignoring faulty addresses"
21909 .cindex "skipping faulty addresses"
21910 .cindex "error" "skipping bad syntax"
21911 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21912 non-filter redirection data are skipped, and each failing address is logged. If
21913 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21914 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21915 are expanded and placed at the head of the error message generated by
21916 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21917 be the same address as the generic &%errors_to%& option. The
21918 &%skip_syntax_errors%& option is often used when handling mailing lists.
21919
21920 If all the addresses in a redirection list are skipped because of syntax
21921 errors, the router declines to handle the original address, and it is passed to
21922 the following routers.
21923
21924 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21925 error in the filter causes filtering to be abandoned without any action being
21926 taken. The incident is logged, and the router declines to handle the address,
21927 so it is passed to the following routers.
21928
21929 .cindex "Sieve filter" "syntax errors in"
21930 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21931 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21932 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21933
21934 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21935 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21936 option, used with an address that does not get redirected, can be used to
21937 notify users of these errors, by means of a router like this:
21938 .code
21939 userforward:
21940   driver = redirect
21941   allow_filter
21942   check_local_user
21943   file = $home/.forward
21944   file_transport = address_file
21945   pipe_transport = address_pipe
21946   reply_transport = address_reply
21947   no_verify
21948   skip_syntax_errors
21949   syntax_errors_to = real-$local_part@$domain
21950   syntax_errors_text = \
21951    This is an automatically generated message. An error has\n\
21952    been found in your .forward file. Details of the error are\n\
21953    reported below. While this error persists, you will receive\n\
21954    a copy of this message for every message that is addressed\n\
21955    to you. If your .forward file is a filter file, or if it is\n\
21956    a non-filter file containing no valid forwarding addresses,\n\
21957    a copy of each incoming message will be put in your normal\n\
21958    mailbox. If a non-filter file contains at least one valid\n\
21959    forwarding address, forwarding to the valid addresses will\n\
21960    happen, and those will be the only deliveries that occur.
21961 .endd
21962 You also need a router to ensure that local addresses that are prefixed by
21963 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21964 put this immediately before the &(userforward)& router:
21965 .code
21966 real_localuser:
21967   driver = accept
21968   check_local_user
21969   local_part_prefix = real-
21970   transport = local_delivery
21971 .endd
21972 For security, it would probably be a good idea to restrict the use of this
21973 router to locally-generated messages, using a condition such as this:
21974 .code
21975   condition = ${if match {$sender_host_address}\
21976                          {\N^(|127\.0\.0\.1)$\N}}
21977 .endd
21978
21979
21980 .option syntax_errors_text redirect string&!! unset
21981 See &%skip_syntax_errors%& above.
21982
21983
21984 .option syntax_errors_to redirect string unset
21985 See &%skip_syntax_errors%& above.
21986 .ecindex IIDredrou1
21987 .ecindex IIDredrou2
21988
21989
21990
21991
21992
21993
21994 . ////////////////////////////////////////////////////////////////////////////
21995 . ////////////////////////////////////////////////////////////////////////////
21996
21997 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21998          "Environment for local transports"
21999 .scindex IIDenvlotra1 "local transports" "environment for"
22000 .scindex IIDenvlotra2 "environment" "local transports"
22001 .scindex IIDenvlotra3 "transport" "local; environment for"
22002 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22003 transport can be thought of as similar to a pipe.) Exim always runs transports
22004 in subprocesses, under specified uids and gids. Typical deliveries to local
22005 mailboxes run under the uid and gid of the local user.
22006
22007 Exim also sets a specific current directory while running the transport; for
22008 some transports a home directory setting is also relevant. The &(pipe)&
22009 transport is the only one that sets up environment variables; see section
22010 &<<SECTpipeenv>>& for details.
22011
22012 The values used for the uid, gid, and the directories may come from several
22013 different places. In many cases, the router that handles the address associates
22014 settings with that address as a result of its &%check_local_user%&, &%group%&,
22015 or &%user%& options. However, values may also be given in the transport's own
22016 configuration, and these override anything that comes from the router.
22017
22018
22019
22020 .section "Concurrent deliveries" "SECID131"
22021 .cindex "concurrent deliveries"
22022 .cindex "simultaneous deliveries"
22023 If two different messages for the same local recipient arrive more or less
22024 simultaneously, the two delivery processes are likely to run concurrently. When
22025 the &(appendfile)& transport is used to write to a file, Exim applies locking
22026 rules to stop concurrent processes from writing to the same file at the same
22027 time.
22028
22029 However, when you use a &(pipe)& transport, it is up to you to arrange any
22030 locking that is needed. Here is a silly example:
22031 .code
22032 my_transport:
22033   driver = pipe
22034   command = /bin/sh -c 'cat >>/some/file'
22035 .endd
22036 This is supposed to write the message at the end of the file. However, if two
22037 messages arrive at the same time, the file will be scrambled. You can use the
22038 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22039 file using the same algorithm that Exim itself uses.
22040
22041
22042
22043
22044 .section "Uids and gids" "SECTenvuidgid"
22045 .cindex "local transports" "uid and gid"
22046 .cindex "transport" "local; uid and gid"
22047 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22048 overrides any group that the router set in the address, even if &%user%& is not
22049 set for the transport. This makes it possible, for example, to run local mail
22050 delivery under the uid of the recipient (set by the router), but in a special
22051 group (set by the transport). For example:
22052 .code
22053 # Routers ...
22054 # User/group are set by check_local_user in this router
22055 local_users:
22056   driver = accept
22057   check_local_user
22058   transport = group_delivery
22059
22060 # Transports ...
22061 # This transport overrides the group
22062 group_delivery:
22063   driver = appendfile
22064   file = /var/spool/mail/$local_part_data
22065   group = mail
22066 .endd
22067 If &%user%& is set for a transport, its value overrides what is set in the
22068 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22069 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22070 set.
22071
22072 .oindex "&%initgroups%&"
22073 When the uid is taken from the transport's configuration, the &[initgroups()]&
22074 function is called for the groups associated with that uid if the
22075 &%initgroups%& option is set for the transport. When the uid is not specified
22076 by the transport, but is associated with the address by a router, the option
22077 for calling &[initgroups()]& is taken from the router configuration.
22078
22079 .cindex "&(pipe)& transport" "uid for"
22080 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22081 is set and &%user%& is not set, the uid of the process that called Exim to
22082 receive the message is used, and if &%group%& is not set, the corresponding
22083 original gid is also used.
22084
22085 This is the detailed preference order for obtaining a gid; the first of the
22086 following that is set is used:
22087
22088 .ilist
22089 A &%group%& setting of the transport;
22090 .next
22091 A &%group%& setting of the router;
22092 .next
22093 A gid associated with a user setting of the router, either as a result of
22094 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22095 .next
22096 The group associated with a non-numeric &%user%& setting of the transport;
22097 .next
22098 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22099 the uid is the creator's uid;
22100 .next
22101 The Exim gid if the Exim uid is being used as a default.
22102 .endlist
22103
22104 If, for example, the user is specified numerically on the router and there are
22105 no group settings, no gid is available. In this situation, an error occurs.
22106 This is different for the uid, for which there always is an ultimate default.
22107 The first of the following that is set is used:
22108
22109 .ilist
22110 A &%user%& setting of the transport;
22111 .next
22112 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22113 .next
22114 A &%user%& setting of the router;
22115 .next
22116 A &%check_local_user%& setting of the router;
22117 .next
22118 The Exim uid.
22119 .endlist
22120
22121 Of course, an error will still occur if the uid that is chosen is on the
22122 &%never_users%& list.
22123
22124
22125
22126
22127
22128 .section "Current and home directories" "SECID132"
22129 .cindex "current directory for local transport"
22130 .cindex "home directory" "for local transport"
22131 .cindex "transport" "local; home directory for"
22132 .cindex "transport" "local; current directory for"
22133 Routers may set current and home directories for local transports by means of
22134 the &%transport_current_directory%& and &%transport_home_directory%& options.
22135 However, if the transport's &%current_directory%& or &%home_directory%& options
22136 are set, they override the router's values. In detail, the home directory
22137 for a local transport is taken from the first of these values that is set:
22138
22139 .ilist
22140 The &%home_directory%& option on the transport;
22141 .next
22142 The &%transport_home_directory%& option on the router;
22143 .next
22144 The password data if &%check_local_user%& is set on the router;
22145 .next
22146 The &%router_home_directory%& option on the router.
22147 .endlist
22148
22149 The current directory is taken from the first of these values that is set:
22150
22151 .ilist
22152 The &%current_directory%& option on the transport;
22153 .next
22154 The &%transport_current_directory%& option on the router.
22155 .endlist
22156
22157
22158 If neither the router nor the transport sets a current directory, Exim uses the
22159 value of the home directory, if it is set. Otherwise it sets the current
22160 directory to &_/_& before running a local transport.
22161
22162
22163
22164 .section "Expansion variables derived from the address" "SECID133"
22165 .vindex "&$domain$&"
22166 .vindex "&$local_part$&"
22167 .vindex "&$original_domain$&"
22168 Normally a local delivery is handling a single address, and in that case the
22169 variables such as &$domain$& and &$local_part$& are set during local
22170 deliveries. However, in some circumstances more than one address may be handled
22171 at once (for example, while writing batch SMTP for onward transmission by some
22172 other means). In this case, the variables associated with the local part are
22173 never set, &$domain$& is set only if all the addresses have the same domain,
22174 and &$original_domain$& is never set.
22175 .ecindex IIDenvlotra1
22176 .ecindex IIDenvlotra2
22177 .ecindex IIDenvlotra3
22178
22179
22180
22181
22182
22183
22184
22185 . ////////////////////////////////////////////////////////////////////////////
22186 . ////////////////////////////////////////////////////////////////////////////
22187
22188 .chapter "Generic options for transports" "CHAPtransportgeneric"
22189 .scindex IIDgenoptra1 "generic options" "transport"
22190 .scindex IIDgenoptra2 "options" "generic; for transports"
22191 .scindex IIDgenoptra3 "transport" "generic options for"
22192 The following generic options apply to all transports:
22193
22194
22195 .option body_only transports boolean false
22196 .cindex "transport" "body only"
22197 .cindex "message" "transporting body only"
22198 .cindex "body of message" "transporting"
22199 If this option is set, the message's headers are not transported. It is
22200 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22201 or &(pipe)& transports, the settings of &%message_prefix%& and
22202 &%message_suffix%& should be checked, because this option does not
22203 automatically suppress them.
22204
22205
22206 .option current_directory transports string&!! unset
22207 .cindex "transport" "current directory for"
22208 This specifies the current directory that is to be set while running the
22209 transport, overriding any value that may have been set by the router.
22210 If the expansion fails for any reason, including forced failure, an error is
22211 logged, and delivery is deferred.
22212
22213
22214 .option disable_logging transports boolean false
22215 If this option is set true, nothing is logged for any
22216 deliveries by the transport or for any
22217 transport errors. You should not set this option unless you really, really know
22218 what you are doing.
22219
22220
22221 .option debug_print transports string&!! unset
22222 .cindex "testing" "variables in drivers"
22223 If this option is set and debugging is enabled (see the &%-d%& command line
22224 option), the string is expanded and included in the debugging output when the
22225 transport is run.
22226 If expansion of the string fails, the error message is written to the debugging
22227 output, and Exim carries on processing.
22228 This facility is provided to help with checking out the values of variables and
22229 so on when debugging driver configurations. For example, if a &%headers_add%&
22230 option is not working properly, &%debug_print%& could be used to output the
22231 variables it references. A newline is added to the text if it does not end with
22232 one.
22233 The variables &$transport_name$& and &$router_name$& contain the name of the
22234 transport and the router that called it.
22235
22236 .option delivery_date_add transports boolean false
22237 .cindex "&'Delivery-date:'& header line"
22238 If this option is true, a &'Delivery-date:'& header is added to the message.
22239 This gives the actual time the delivery was made. As this is not a standard
22240 header, Exim has a configuration option (&%delivery_date_remove%&) which
22241 requests its removal from incoming messages, so that delivered messages can
22242 safely be resent to other recipients.
22243
22244
22245 .option driver transports string unset
22246 This specifies which of the available transport drivers is to be used.
22247 There is no default, and this option must be set for every transport.
22248
22249
22250 .option envelope_to_add transports boolean false
22251 .cindex "&'Envelope-to:'& header line"
22252 If this option is true, an &'Envelope-to:'& header is added to the message.
22253 This gives the original address(es) in the incoming envelope that caused this
22254 delivery to happen. More than one address may be present if the transport is
22255 configured to handle several addresses at once, or if more than one original
22256 address was redirected to the same final address. As this is not a standard
22257 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22258 its removal from incoming messages, so that delivered messages can safely be
22259 resent to other recipients.
22260
22261
22262 .option event_action transports string&!! unset
22263 .cindex events
22264 This option declares a string to be expanded for Exim's events mechanism.
22265 For details see chapter &<<CHAPevents>>&.
22266
22267
22268 .option group transports string&!! "Exim group"
22269 .cindex "transport" "group; specifying"
22270 This option specifies a gid for running the transport process, overriding any
22271 value that the router supplies, and also overriding any value associated with
22272 &%user%& (see below).
22273
22274
22275 .option headers_add transports list&!! unset
22276 .cindex "header lines" "adding in transport"
22277 .cindex "transport" "header lines; adding"
22278 This option specifies a list of text headers,
22279 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22280 which are (separately) expanded and added to the header
22281 portion of a message as it is transported, as described in section
22282 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22283 routers. If the result of the expansion is an empty string, or if the expansion
22284 is forced to fail, no action is taken. Other expansion failures are treated as
22285 errors and cause the delivery to be deferred.
22286
22287 Unlike most options, &%headers_add%& can be specified multiple times
22288 for a transport; all listed headers are added.
22289
22290
22291 .option headers_only transports boolean false
22292 .cindex "transport" "header lines only"
22293 .cindex "message" "transporting headers only"
22294 .cindex "header lines" "transporting"
22295 If this option is set, the message's body is not transported. It is mutually
22296 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22297 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22298 checked, since this option does not automatically suppress them.
22299
22300
22301 .option headers_remove transports list&!! unset
22302 .cindex "header lines" "removing"
22303 .cindex "transport" "header lines; removing"
22304 This option specifies a list of text headers,
22305 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22306 to be removed from the message.
22307 However, the option has no effect when an address is just being verified.
22308 Each list item is separately expanded.
22309 If the result of the expansion is an empty string, or if the expansion
22310 is forced to fail, no action is taken. Other expansion failures are treated as
22311 errors and cause the delivery to be deferred.
22312 If an item ends in *, it will match any header with the given prefix.
22313
22314 Matching headers are omitted from the message as it is transported, as described
22315 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22316 routers.
22317
22318 Unlike most options, &%headers_remove%& can be specified multiple times
22319 for a transport; all listed headers are removed.
22320
22321 &*Warning*&: Because of the separate expansion of the list items,
22322 items that contain a list separator must have it doubled.
22323 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22324
22325
22326
22327 .option headers_rewrite transports string unset
22328 .cindex "transport" "header lines; rewriting"
22329 .cindex "rewriting" "at transport time"
22330 This option allows addresses in header lines to be rewritten at transport time,
22331 that is, as the message is being copied to its destination. The contents of the
22332 option are a colon-separated list of rewriting rules. Each rule is in exactly
22333 the same form as one of the general rewriting rules that are applied when a
22334 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22335 example,
22336 .code
22337 headers_rewrite = a@b c@d f : \
22338                   x@y w@z
22339 .endd
22340 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22341 &'w@z'& in all address-bearing header lines. The rules are applied to the
22342 header lines just before they are written out at transport time, so they affect
22343 only those copies of the message that pass through the transport. However, only
22344 the message's original header lines, and any that were added by a system
22345 filter, are rewritten. If a router or transport adds header lines, they are not
22346 affected by this option. These rewriting rules are &'not'& applied to the
22347 envelope. You can change the return path using &%return_path%&, but you cannot
22348 change envelope recipients at this time.
22349
22350
22351 .option home_directory transports string&!! unset
22352 .cindex "transport" "home directory for"
22353 .vindex "&$home$&"
22354 This option specifies a home directory setting for a local transport,
22355 overriding any value that may be set by the router. The home directory is
22356 placed in &$home$& while expanding the transport's private options. It is also
22357 used as the current directory if no current directory is set by the
22358 &%current_directory%& option on the transport or the
22359 &%transport_current_directory%& option on the router. If the expansion fails
22360 for any reason, including forced failure, an error is logged, and delivery is
22361 deferred.
22362
22363
22364 .option initgroups transports boolean false
22365 .cindex "additional groups"
22366 .cindex "groups" "additional"
22367 .cindex "transport" "group; additional"
22368 If this option is true and the uid for the delivery process is provided by the
22369 transport, the &[initgroups()]& function is called when running the transport
22370 to ensure that any additional groups associated with the uid are set up.
22371
22372
22373 .option max_parallel transports integer&!! unset
22374 .cindex limit "transport parallelism"
22375 .cindex transport "parallel processes"
22376 .cindex transport "concurrency limit"
22377 .cindex "delivery" "parallelism for transport"
22378 If this option is set and expands to an integer greater than zero
22379 it limits the number of concurrent runs of the transport.
22380 The control does not apply to shadow transports.
22381
22382 .cindex "hints database" "transport concurrency control"
22383 Exim implements this control by means of a hints database in which a record is
22384 incremented whenever a transport process is being created. The record
22385 is decremented and possibly removed when the process terminates.
22386 Obviously there is scope for
22387 records to get left lying around if there is a system or program crash. To
22388 guard against this, Exim ignores any records that are more than six hours old.
22389
22390 If you use this option, you should also arrange to delete the
22391 relevant hints database whenever your system reboots. The names of the files
22392 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22393 may be one or two files, depending on the type of DBM in use. The same files
22394 are used for ETRN and smtp transport serialization.
22395
22396
22397 .option message_size_limit transports string&!! 0
22398 .cindex "limit" "message size per transport"
22399 .cindex "size" "of message, limit"
22400 .cindex "transport" "message size; limiting"
22401 This option controls the size of messages passed through the transport. It is
22402 expanded before use; the result of the expansion must be a sequence of decimal
22403 digits, optionally followed by K or M. If the expansion fails for any reason,
22404 including forced failure, or if the result is not of the required form,
22405 delivery is deferred. If the value is greater than zero and the size of a
22406 message exceeds this limit, the address is failed. If there is any chance that
22407 the resulting bounce message could be routed to the same transport, you should
22408 ensure that &%return_size_limit%& is less than the transport's
22409 &%message_size_limit%&, as otherwise the bounce message will fail to get
22410 delivered.
22411
22412
22413
22414 .option rcpt_include_affixes transports boolean false
22415 .cindex "prefix" "for local part, including in envelope"
22416 .cindex "suffix for local part" "including in envelope"
22417 .cindex "local part" "prefix"
22418 .cindex "local part" "suffix"
22419 When this option is false (the default), and an address that has had any
22420 affixes (prefixes or suffixes) removed from the local part is delivered by any
22421 form of SMTP or LMTP, the affixes are not included. For example, if a router
22422 that contains
22423 .code
22424 local_part_prefix = *-
22425 .endd
22426 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22427 is delivered with
22428 .code
22429 RCPT TO:<xyz@some.domain>
22430 .endd
22431 This is also the case when an ACL-time callout is being used to verify a
22432 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22433 whole local part is included in the RCPT command. This option applies to BSMTP
22434 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22435 &(lmtp)& and &(smtp)& transports.
22436
22437
22438 .option retry_use_local_part transports boolean "see below"
22439 .cindex "hints database" "retry keys"
22440 When a delivery suffers a temporary failure, a retry record is created
22441 in Exim's hints database. For remote deliveries, the key for the retry record
22442 is based on the name and/or IP address of the failing remote host. For local
22443 deliveries, the key is normally the entire address, including both the local
22444 part and the domain. This is suitable for most common cases of local delivery
22445 temporary failure &-- for example, exceeding a mailbox quota should delay only
22446 deliveries to that mailbox, not to the whole domain.
22447
22448 However, in some special cases you may want to treat a temporary local delivery
22449 as a failure associated with the domain, and not with a particular local part.
22450 (For example, if you are storing all mail for some domain in files.) You can do
22451 this by setting &%retry_use_local_part%& false.
22452
22453 For all the local transports, its default value is true. For remote transports,
22454 the default value is false for tidiness, but changing the value has no effect
22455 on a remote transport in the current implementation.
22456
22457
22458 .option return_path transports string&!! unset
22459 .cindex "envelope sender"
22460 .cindex "envelope from"
22461 .cindex "transport" "return path; changing"
22462 .cindex "return path" "changing in transport"
22463 If this option is set, the string is expanded at transport time and replaces
22464 the existing return path (envelope sender) value in the copy of the message
22465 that is being delivered. An empty return path is permitted. This feature is
22466 designed for remote deliveries, where the value of this option is used in the
22467 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22468 only effect is to change the address that is placed in the &'Return-path:'&
22469 header line, if one is added to the message (see the next option).
22470
22471 &*Note:*& A changed return path is not logged unless you add
22472 &%return_path_on_delivery%& to the log selector.
22473
22474 .vindex "&$return_path$&"
22475 The expansion can refer to the existing value via &$return_path$&. This is
22476 either the message's envelope sender, or an address set by the
22477 &%errors_to%& option on a router. If the expansion is forced to fail, no
22478 replacement occurs; if it fails for another reason, delivery is deferred. This
22479 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22480 section &<<SECTverp>>&.
22481
22482 &*Note*&: If a delivery error is detected locally, including the case when a
22483 remote server rejects a message at SMTP time, the bounce message is not sent to
22484 the value of this option. It is sent to the previously set errors address.
22485 This defaults to the incoming sender address, but can be changed by setting
22486 &%errors_to%& in a router.
22487
22488
22489
22490 .option return_path_add transports boolean false
22491 .cindex "&'Return-path:'& header line"
22492 If this option is true, a &'Return-path:'& header is added to the message.
22493 Although the return path is normally available in the prefix line of BSD
22494 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22495 have easy access to it.
22496
22497 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22498 the delivery SMTP server makes the final delivery"&. This implies that this
22499 header should not be present in incoming messages. Exim has a configuration
22500 option, &%return_path_remove%&, which requests removal of this header from
22501 incoming messages, so that delivered messages can safely be resent to other
22502 recipients.
22503
22504
22505 .option shadow_condition transports string&!! unset
22506 See &%shadow_transport%& below.
22507
22508
22509 .option shadow_transport transports string unset
22510 .cindex "shadow transport"
22511 .cindex "transport" "shadow"
22512 A local transport may set the &%shadow_transport%& option to the name of
22513 another local transport. Shadow remote transports are not supported.
22514
22515 Whenever a delivery to the main transport succeeds, and either
22516 &%shadow_condition%& is unset, or its expansion does not result in the empty
22517 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22518 passed to the shadow transport, with the same delivery address or addresses. If
22519 expansion fails, no action is taken except that non-forced expansion failures
22520 cause a log line to be written.
22521
22522 The result of the shadow transport is discarded and does not affect the
22523 subsequent processing of the message. Only a single level of shadowing is
22524 provided; the &%shadow_transport%& option is ignored on any transport when it
22525 is running as a shadow. Options concerned with output from pipes are also
22526 ignored. The log line for the successful delivery has an item added on the end,
22527 of the form
22528 .code
22529 ST=<shadow transport name>
22530 .endd
22531 If the shadow transport did not succeed, the error message is put in
22532 parentheses afterwards. Shadow transports can be used for a number of different
22533 purposes, including keeping more detailed log information than Exim normally
22534 provides, and implementing automatic acknowledgment policies based on message
22535 headers that some sites insist on.
22536
22537
22538 .option transport_filter transports string&!! unset
22539 .cindex "transport" "filter"
22540 .cindex "filter" "transport filter"
22541 This option sets up a filtering (in the Unix shell sense) process for messages
22542 at transport time. It should not be confused with mail filtering as set up by
22543 individual users or via a system filter.
22544 If unset, or expanding to an empty string, no filtering is done.
22545
22546 When the message is about to be written out, the command specified by
22547 &%transport_filter%& is started up in a separate, parallel process, and
22548 the entire message, including the header lines, is passed to it on its standard
22549 input (this in fact is done from a third process, to avoid deadlock). The
22550 command must be specified as an absolute path.
22551
22552 The lines of the message that are written to the transport filter are
22553 terminated by newline (&"\n"&). The message is passed to the filter before any
22554 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22555 lines beginning with a dot, and also before any processing implied by the
22556 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22557 &(pipe)& transports.
22558
22559 The standard error for the filter process is set to the same destination as its
22560 standard output; this is read and written to the message's ultimate
22561 destination. The process that writes the message to the filter, the
22562 filter itself, and the original process that reads the result and delivers it
22563 are all run in parallel, like a shell pipeline.
22564
22565 The filter can perform any transformations it likes, but of course should take
22566 care not to break RFC 2822 syntax. Exim does not check the result, except to
22567 test for a final newline when SMTP is in use. All messages transmitted over
22568 SMTP must end with a newline, so Exim supplies one if it is missing.
22569
22570 .cindex "content scanning" "per user"
22571 A transport filter can be used to provide content-scanning on a per-user basis
22572 at delivery time if the only required effect of the scan is to modify the
22573 message. For example, a content scan could insert a new header line containing
22574 a spam score. This could be interpreted by a filter in the user's MUA. It is
22575 not possible to discard a message at this stage.
22576
22577 .cindex "SIZE" "ESMTP extension"
22578 A problem might arise if the filter increases the size of a message that is
22579 being sent down an SMTP connection. If the receiving SMTP server has indicated
22580 support for the SIZE parameter, Exim will have sent the size of the message
22581 at the start of the SMTP session. If what is actually sent is substantially
22582 more, the server might reject the message. This can be worked round by setting
22583 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22584 additions to the message, or to disable the use of SIZE altogether.
22585
22586 .vindex "&$pipe_addresses$&"
22587 The value of the &%transport_filter%& option is the command string for starting
22588 the filter, which is run directly from Exim, not under a shell. The string is
22589 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22590 Exim breaks it up into arguments and then expands each argument separately (see
22591 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22592 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22593 of arguments, one for each address that applies to this delivery. (This isn't
22594 an ideal name for this feature here, but as it was already implemented for the
22595 &(pipe)& transport, it seemed sensible not to change it.)
22596
22597 .vindex "&$host$&"
22598 .vindex "&$host_address$&"
22599 The expansion variables &$host$& and &$host_address$& are available when the
22600 transport is a remote one. They contain the name and IP address of the host to
22601 which the message is being sent. For example:
22602 .code
22603 transport_filter = /some/directory/transport-filter.pl \
22604   $host $host_address $sender_address $pipe_addresses
22605 .endd
22606
22607 Two problems arise if you want to use more complicated expansion items to
22608 generate transport filter commands, both of which due to the fact that the
22609 command is split up &'before'& expansion.
22610 .ilist
22611 If an expansion item contains white space, you must quote it, so that it is all
22612 part of the same command item. If the entire option setting is one such
22613 expansion item, you have to take care what kind of quoting you use. For
22614 example:
22615 .code
22616 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22617 .endd
22618 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22619 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22620 stripped by Exim when it read the option's value. When the value is used, if
22621 the single quotes were missing, the line would be split into two items,
22622 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22623 Exim tried to expand the first one.
22624 .next
22625 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22626 expansion cannot generate multiple arguments, or a command name followed by
22627 arguments. Consider this example:
22628 .code
22629 transport_filter = ${lookup{$host}lsearch{/a/file}\
22630                     {$value}{/bin/cat}}
22631 .endd
22632 The result of the lookup is interpreted as the name of the command, even
22633 if it contains white space. The simplest way round this is to use a shell:
22634 .code
22635 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22636                                {$value}{/bin/cat}}
22637 .endd
22638 .endlist
22639
22640 The filter process is run under the same uid and gid as the normal delivery.
22641 For remote deliveries this is the Exim uid/gid by default. The command should
22642 normally yield a zero return code. Transport filters are not supposed to fail.
22643 A non-zero code is taken to mean that the transport filter encountered some
22644 serious problem. Delivery of the message is deferred; the message remains on
22645 the queue and is tried again later. It is not possible to cause a message to be
22646 bounced from a transport filter.
22647
22648 If a transport filter is set on an autoreply transport, the original message is
22649 passed through the filter as it is being copied into the newly generated
22650 message, which happens if the &%return_message%& option is set.
22651
22652
22653 .option transport_filter_timeout transports time 5m
22654 .cindex "transport" "filter, timeout"
22655 When Exim is reading the output of a transport filter, it applies a timeout
22656 that can be set by this option. Exceeding the timeout is normally treated as a
22657 temporary delivery failure. However, if a transport filter is used with a
22658 &(pipe)& transport, a timeout in the transport filter is treated in the same
22659 way as a timeout in the pipe command itself. By default, a timeout is a hard
22660 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22661 becomes a temporary error.
22662
22663
22664 .option user transports string&!! "Exim user"
22665 .cindex "uid (user id)" "local delivery"
22666 .cindex "transport" "user, specifying"
22667 This option specifies the user under whose uid the delivery process is to be
22668 run, overriding any uid that may have been set by the router. If the user is
22669 given as a name, the uid is looked up from the password data, and the
22670 associated group is taken as the value of the gid to be used if the &%group%&
22671 option is not set.
22672
22673 For deliveries that use local transports, a user and group are normally
22674 specified explicitly or implicitly (for example, as a result of
22675 &%check_local_user%&) by the router or transport.
22676
22677 .cindex "hints database" "access by remote transport"
22678 For remote transports, you should leave this option unset unless you really are
22679 sure you know what you are doing. When a remote transport is running, it needs
22680 to be able to access Exim's hints databases, because each host may have its own
22681 retry data.
22682 .ecindex IIDgenoptra1
22683 .ecindex IIDgenoptra2
22684 .ecindex IIDgenoptra3
22685
22686
22687
22688
22689
22690
22691 . ////////////////////////////////////////////////////////////////////////////
22692 . ////////////////////////////////////////////////////////////////////////////
22693
22694 .chapter "Address batching in local transports" "CHAPbatching" &&&
22695          "Address batching"
22696 .cindex "transport" "local; address batching in"
22697 The only remote transport (&(smtp)&) is normally configured to handle more than
22698 one address at a time, so that when several addresses are routed to the same
22699 remote host, just one copy of the message is sent. Local transports, however,
22700 normally handle one address at a time. That is, a separate instance of the
22701 transport is run for each address that is routed to the transport. A separate
22702 copy of the message is delivered each time.
22703
22704 .cindex "batched local delivery"
22705 .oindex "&%batch_max%&"
22706 .oindex "&%batch_id%&"
22707 In special cases, it may be desirable to handle several addresses at once in a
22708 local transport, for example:
22709
22710 .ilist
22711 In an &(appendfile)& transport, when storing messages in files for later
22712 delivery by some other means, a single copy of the message with multiple
22713 recipients saves space.
22714 .next
22715 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22716 a single copy saves time, and is the normal way LMTP is expected to work.
22717 .next
22718 In a &(pipe)& transport, when passing the message
22719 to a scanner program or
22720 to some other delivery mechanism such as UUCP, multiple recipients may be
22721 acceptable.
22722 .endlist
22723
22724 These three local transports all have the same options for controlling multiple
22725 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22726 repeating the information for each transport, these options are described here.
22727
22728 The &%batch_max%& option specifies the maximum number of addresses that can be
22729 delivered together in a single run of the transport. Its default value is one
22730 (no batching). When more than one address is routed to a transport that has a
22731 &%batch_max%& value greater than one, the addresses are delivered in a batch
22732 (that is, in a single run of the transport with multiple recipients), subject
22733 to certain conditions:
22734
22735 .ilist
22736 .vindex "&$local_part$&"
22737 If any of the transport's options contain a reference to &$local_part$&, no
22738 batching is possible.
22739 .next
22740 .vindex "&$domain$&"
22741 If any of the transport's options contain a reference to &$domain$&, only
22742 addresses with the same domain are batched.
22743 .next
22744 .cindex "customizing" "batching condition"
22745 If &%batch_id%& is set, it is expanded for each address, and only those
22746 addresses with the same expanded value are batched. This allows you to specify
22747 customized batching conditions. Failure of the expansion for any reason,
22748 including forced failure, disables batching, but it does not stop the delivery
22749 from taking place.
22750 .next
22751 Batched addresses must also have the same errors address (where to send
22752 delivery errors), the same header additions and removals, the same user and
22753 group for the transport, and if a host list is present, the first host must
22754 be the same.
22755 .endlist
22756
22757 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22758 both when the file or pipe command is specified in the transport, and when it
22759 is specified by a &(redirect)& router, but all the batched addresses must of
22760 course be routed to the same file or pipe command. These two transports have an
22761 option called &%use_bsmtp%&, which causes them to deliver the message in
22762 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22763 &%check_string%& and &%escape_string%& options are forced to the values
22764 .code
22765 check_string = "."
22766 escape_string = ".."
22767 .endd
22768 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22769 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22770 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22771
22772 .cindex "&'Envelope-to:'& header line"
22773 If the generic &%envelope_to_add%& option is set for a batching transport, the
22774 &'Envelope-to:'& header that is added to the message contains all the addresses
22775 that are being processed together. If you are using a batching &(appendfile)&
22776 transport without &%use_bsmtp%&, the only way to preserve the recipient
22777 addresses is to set the &%envelope_to_add%& option.
22778
22779 .cindex "&(pipe)& transport" "with multiple addresses"
22780 .vindex "&$pipe_addresses$&"
22781 If you are using a &(pipe)& transport without BSMTP, and setting the
22782 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22783 the command. This is not a true variable; it is a bit of magic that causes each
22784 of the recipient addresses to be inserted into the command as a separate
22785 argument. This provides a way of accessing all the addresses that are being
22786 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22787 are specified by a &(redirect)& router.
22788
22789
22790
22791
22792 . ////////////////////////////////////////////////////////////////////////////
22793 . ////////////////////////////////////////////////////////////////////////////
22794
22795 .chapter "The appendfile transport" "CHAPappendfile"
22796 .scindex IIDapptra1 "&(appendfile)& transport"
22797 .scindex IIDapptra2 "transports" "&(appendfile)&"
22798 .cindex "directory creation"
22799 .cindex "creating directories"
22800 The &(appendfile)& transport delivers a message by appending it to an existing
22801 file, or by creating an entirely new file in a specified directory. Single
22802 files to which messages are appended can be in the traditional Unix mailbox
22803 format, or optionally in the MBX format supported by the Pine MUA and
22804 University of Washington IMAP daemon, &'inter alia'&. When each message is
22805 being delivered as a separate file, &"maildir"& format can optionally be used
22806 to give added protection against failures that happen part-way through the
22807 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22808 supported. For all file formats, Exim attempts to create as many levels of
22809 directory as necessary, provided that &%create_directory%& is set.
22810
22811 The code for the optional formats is not included in the Exim binary by
22812 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22813 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22814 included.
22815
22816 .cindex "quota" "system"
22817 Exim recognizes system quota errors, and generates an appropriate message. Exim
22818 also supports its own quota control within the transport, for use when the
22819 system facility is unavailable or cannot be used for some reason.
22820
22821 If there is an error while appending to a file (for example, quota exceeded or
22822 partition filled), Exim attempts to reset the file's length and last
22823 modification time back to what they were before. If there is an error while
22824 creating an entirely new file, the new file is removed.
22825
22826 Before appending to a file, a number of security checks are made, and the
22827 file is locked. A detailed description is given below, after the list of
22828 private options.
22829
22830 The &(appendfile)& transport is most commonly used for local deliveries to
22831 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22832 putting messages into files for remote delivery by some means other than Exim.
22833 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22834 option).
22835
22836
22837
22838 .section "The file and directory options" "SECTfildiropt"
22839 The &%file%& option specifies a single file, to which the message is appended;
22840 the &%directory%& option specifies a directory, in which a new file containing
22841 the message is created. Only one of these two options can be set, and for
22842 normal deliveries to mailboxes, one of them &'must'& be set.
22843
22844 .vindex "&$address_file$&"
22845 .vindex "&$local_part$&"
22846 However, &(appendfile)& is also used for delivering messages to files or
22847 directories whose names (or parts of names) are obtained from alias,
22848 forwarding, or filtering operations (for example, a &%save%& command in a
22849 user's Exim filter). When such a transport is running, &$local_part$& contains
22850 the local part that was aliased or forwarded, and &$address_file$& contains the
22851 name (or partial name) of the file or directory generated by the redirection
22852 operation. There are two cases:
22853
22854 .ilist
22855 If neither &%file%& nor &%directory%& is set, the redirection operation
22856 must specify an absolute path (one that begins with &`/`&). This is the most
22857 common case when users with local accounts use filtering to sort mail into
22858 different folders. See for example, the &(address_file)& transport in the
22859 default configuration. If the path ends with a slash, it is assumed to be the
22860 name of a directory. A delivery to a directory can also be forced by setting
22861 &%maildir_format%& or &%mailstore_format%&.
22862 .next
22863 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22864 used to determine the file or directory name for the delivery. Normally, the
22865 contents of &$address_file$& are used in some way in the string expansion.
22866 .endlist
22867 .cindex "tainted data" "in filenames"
22868 .cindex appendfile "tainted data"
22869 Tainted data may not be used for a file or directory name.
22870 This means that, for instance, &$local_part$& cannot be used directly
22871 as a component of a path.  It can however be used as the key for a lookup
22872 which returns a path (or component).
22873
22874
22875 .cindex "Sieve filter" "configuring &(appendfile)&"
22876 .cindex "Sieve filter" "relative mailbox path handling"
22877 As an example of the second case, consider an environment where users do not
22878 have home directories. They may be permitted to use Exim filter commands of the
22879 form:
22880 .code
22881 save folder23
22882 .endd
22883 or Sieve filter commands of the form:
22884 .code
22885 require "fileinto";
22886 fileinto "folder23";
22887 .endd
22888 In this situation, the expansion of &%file%& or &%directory%& in the transport
22889 must transform the relative path into an appropriate absolute filename. In the
22890 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22891 is used as a result of a &"keep"& action in the filter. This example shows one
22892 way of handling this requirement:
22893 .code
22894 file = ${if eq{$address_file}{inbox} \
22895             {/var/mail/$local_part_data} \
22896             {${if eq{${substr_0_1:$address_file}}{/} \
22897                   {$address_file} \
22898                   {$home/mail/$address_file} \
22899             }} \
22900        }
22901 .endd
22902 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22903 location, absolute paths are used without change, and other folders are in the
22904 &_mail_& directory within the home directory.
22905
22906 &*Note 1*&: While processing an Exim filter, a relative path such as
22907 &_folder23_& is turned into an absolute path if a home directory is known to
22908 the router. In particular, this is the case if &%check_local_user%& is set. If
22909 you want to prevent this happening at routing time, you can set
22910 &%router_home_directory%& empty. This forces the router to pass the relative
22911 path to the transport.
22912
22913 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22914 the &%file%& or &%directory%& option is still used if it is set.
22915
22916
22917
22918
22919 .section "Private options for appendfile" "SECID134"
22920 .cindex "options" "&(appendfile)& transport"
22921
22922
22923
22924 .option allow_fifo appendfile boolean false
22925 .cindex "fifo (named pipe)"
22926 .cindex "named pipe (fifo)"
22927 .cindex "pipe" "named (fifo)"
22928 Setting this option permits delivery to named pipes (FIFOs) as well as to
22929 regular files. If no process is reading the named pipe at delivery time, the
22930 delivery is deferred.
22931
22932
22933 .option allow_symlink appendfile boolean false
22934 .cindex "symbolic link" "to mailbox"
22935 .cindex "mailbox" "symbolic link"
22936 By default, &(appendfile)& will not deliver if the path name for the file is
22937 that of a symbolic link. Setting this option relaxes that constraint, but there
22938 are security issues involved in the use of symbolic links. Be sure you know
22939 what you are doing if you set this. Details of exactly what this option affects
22940 are included in the discussion which follows this list of options.
22941
22942
22943 .option batch_id appendfile string&!! unset
22944 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22945 However, batching is automatically disabled for &(appendfile)& deliveries that
22946 happen as a result of forwarding or aliasing or other redirection directly to a
22947 file.
22948
22949
22950 .option batch_max appendfile integer 1
22951 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22952
22953
22954 .option check_group appendfile boolean false
22955 When this option is set, the group owner of the file defined by the &%file%&
22956 option is checked to see that it is the same as the group under which the
22957 delivery process is running. The default setting is false because the default
22958 file mode is 0600, which means that the group is irrelevant.
22959
22960
22961 .option check_owner appendfile boolean true
22962 When this option is set, the owner of the file defined by the &%file%& option
22963 is checked to ensure that it is the same as the user under which the delivery
22964 process is running.
22965
22966
22967 .option check_string appendfile string "see below"
22968 .cindex "&""From""& line"
22969 As &(appendfile)& writes the message, the start of each line is tested for
22970 matching &%check_string%&, and if it does, the initial matching characters are
22971 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22972 a literal string, not a regular expression, and the case of any letters it
22973 contains is significant.
22974
22975 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22976 are forced to &"."& and &".."& respectively, and any settings in the
22977 configuration are ignored. Otherwise, they default to &"From&~"& and
22978 &">From&~"& when the &%file%& option is set, and unset when any of the
22979 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22980
22981 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22982 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22983 &"From&~"& indicates the start of a new message. All four options need changing
22984 if another format is used. For example, to deliver to mailboxes in MMDF format:
22985 .cindex "MMDF format mailbox"
22986 .cindex "mailbox" "MMDF format"
22987 .code
22988 check_string = "\1\1\1\1\n"
22989 escape_string = "\1\1\1\1 \n"
22990 message_prefix = "\1\1\1\1\n"
22991 message_suffix = "\1\1\1\1\n"
22992 .endd
22993 .option create_directory appendfile boolean true
22994 .cindex "directory creation"
22995 When this option is true, Exim attempts to create any missing superior
22996 directories for the file that it is about to write. A created directory's mode
22997 is given by the &%directory_mode%& option.
22998
22999 The group ownership of a newly created directory is highly dependent on the
23000 operating system (and possibly the file system) that is being used. For
23001 example, in Solaris, if the parent directory has the setgid bit set, its group
23002 is propagated to the child; if not, the currently set group is used. However,
23003 in FreeBSD, the parent's group is always used.
23004
23005
23006
23007 .option create_file appendfile string anywhere
23008 This option constrains the location of files and directories that are created
23009 by this transport. It applies to files defined by the &%file%& option and
23010 directories defined by the &%directory%& option. In the case of maildir
23011 delivery, it applies to the top level directory, not the maildir directories
23012 beneath.
23013
23014 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23015 &"belowhome"&. In the second and third cases, a home directory must have been
23016 set for the transport. This option is not useful when an explicit filename is
23017 given for normal mailbox deliveries. It is intended for the case when filenames
23018 are generated from users' &_.forward_& files. These are usually handled
23019 by an &(appendfile)& transport called &%address_file%&. See also
23020 &%file_must_exist%&.
23021
23022
23023 .option directory appendfile string&!! unset
23024 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23025 or &%directory%& must be set, unless the delivery is the direct result of a
23026 redirection (see section &<<SECTfildiropt>>&).
23027
23028 When &%directory%& is set, the string is expanded, and the message is delivered
23029 into a new file or files in or below the given directory, instead of being
23030 appended to a single mailbox file. A number of different formats are provided
23031 (see &%maildir_format%& and &%mailstore_format%&), and see section
23032 &<<SECTopdir>>& for further details of this form of delivery.
23033
23034
23035 .option directory_file appendfile string&!! "see below"
23036 .cindex "base62"
23037 .vindex "&$inode$&"
23038 When &%directory%& is set, but neither &%maildir_format%& nor
23039 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23040 whose name is obtained by expanding this string. The default value is:
23041 .code
23042 q${base62:$tod_epoch}-$inode
23043 .endd
23044 This generates a unique name from the current time, in base 62 form, and the
23045 inode of the file. The variable &$inode$& is available only when expanding this
23046 option.
23047
23048
23049 .option directory_mode appendfile "octal integer" 0700
23050 If &(appendfile)& creates any directories as a result of the
23051 &%create_directory%& option, their mode is specified by this option.
23052
23053
23054 .option escape_string appendfile string "see description"
23055 See &%check_string%& above.
23056
23057
23058 .option file appendfile string&!! unset
23059 This option is mutually exclusive with the &%directory%& option, but one of
23060 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23061 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23062 specifies a single file, to which the message is appended. One or more of
23063 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23064 &%file%&.
23065
23066 .cindex "NFS" "lock file"
23067 .cindex "locking files"
23068 .cindex "lock files"
23069 If you are using more than one host to deliver over NFS into the same
23070 mailboxes, you should always use lock files.
23071
23072 The string value is expanded for each delivery, and must yield an absolute
23073 path. The most common settings of this option are variations on one of these
23074 examples:
23075 .code
23076 file = /var/spool/mail/$local_part_data
23077 file = /home/$local_part_data/inbox
23078 file = $home/inbox
23079 .endd
23080 .cindex "&""sticky""& bit"
23081 In the first example, all deliveries are done into the same directory. If Exim
23082 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23083 create a file in the directory, so the &"sticky"& bit must be turned on for
23084 deliveries to be possible, or alternatively the &%group%& option can be used to
23085 run the delivery under a group id which has write access to the directory.
23086
23087
23088
23089 .option file_format appendfile string unset
23090 .cindex "file" "mailbox; checking existing format"
23091 This option requests the transport to check the format of an existing file
23092 before adding to it. The check consists of matching a specific string at the
23093 start of the file. The value of the option consists of an even number of
23094 colon-separated strings. The first of each pair is the test string, and the
23095 second is the name of a transport. If the transport associated with a matched
23096 string is not the current transport, control is passed over to the other
23097 transport. For example, suppose the standard &(local_delivery)& transport has
23098 this added to it:
23099 .code
23100 file_format = "From       : local_delivery :\
23101                \1\1\1\1\n : local_mmdf_delivery"
23102 .endd
23103 Mailboxes that begin with &"From"& are still handled by this transport, but if
23104 a mailbox begins with four binary ones followed by a newline, control is passed
23105 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23106 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23107 is assumed to match the current transport. If the start of a mailbox doesn't
23108 match any string, or if the transport named for a given string is not defined,
23109 delivery is deferred.
23110
23111
23112 .option file_must_exist appendfile boolean false
23113 If this option is true, the file specified by the &%file%& option must exist.
23114 A temporary error occurs if it does not, causing delivery to be deferred.
23115 If this option is false, the file is created if it does not exist.
23116
23117
23118 .option lock_fcntl_timeout appendfile time 0s
23119 .cindex "timeout" "mailbox locking"
23120 .cindex "mailbox" "locking, blocking and non-blocking"
23121 .cindex "locking files"
23122 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23123 when locking an open mailbox file. If the call fails, the delivery process
23124 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23125 Non-blocking calls are used so that the file is not kept open during the wait
23126 for the lock; the reason for this is to make it as safe as possible for
23127 deliveries over NFS in the case when processes might be accessing an NFS
23128 mailbox without using a lock file. This should not be done, but
23129 misunderstandings and hence misconfigurations are not unknown.
23130
23131 On a busy system, however, the performance of a non-blocking lock approach is
23132 not as good as using a blocking lock with a timeout. In this case, the waiting
23133 is done inside the system call, and Exim's delivery process acquires the lock
23134 and can proceed as soon as the previous lock holder releases it.
23135
23136 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23137 timeout, are used. There may still be some retrying: the maximum number of
23138 retries is
23139 .code
23140 (lock_retries * lock_interval) / lock_fcntl_timeout
23141 .endd
23142 rounded up to the next whole number. In other words, the total time during
23143 which &(appendfile)& is trying to get a lock is roughly the same, unless
23144 &%lock_fcntl_timeout%& is set very large.
23145
23146 You should consider setting this option if you are getting a lot of delayed
23147 local deliveries because of errors of the form
23148 .code
23149 failed to lock mailbox /some/file (fcntl)
23150 .endd
23151
23152 .option lock_flock_timeout appendfile time 0s
23153 This timeout applies to file locking when using &[flock()]& (see
23154 &%use_flock%&); the timeout operates in a similar manner to
23155 &%lock_fcntl_timeout%&.
23156
23157
23158 .option lock_interval appendfile time 3s
23159 This specifies the time to wait between attempts to lock the file. See below
23160 for details of locking.
23161
23162
23163 .option lock_retries appendfile integer 10
23164 This specifies the maximum number of attempts to lock the file. A value of zero
23165 is treated as 1. See below for details of locking.
23166
23167
23168 .option lockfile_mode appendfile "octal integer" 0600
23169 This specifies the mode of the created lock file, when a lock file is being
23170 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23171
23172
23173 .option lockfile_timeout appendfile time 30m
23174 .cindex "timeout" "mailbox locking"
23175 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23176 exists and is older than this value, it is assumed to have been left behind by
23177 accident, and Exim attempts to remove it.
23178
23179
23180 .option mailbox_filecount appendfile string&!! unset
23181 .cindex "mailbox" "specifying size of"
23182 .cindex "size" "of mailbox"
23183 If this option is set, it is expanded, and the result is taken as the current
23184 number of files in the mailbox. It must be a decimal number, optionally
23185 followed by K or M. This provides a way of obtaining this information from an
23186 external source that maintains the data.
23187
23188
23189 .option mailbox_size appendfile string&!! unset
23190 .cindex "mailbox" "specifying size of"
23191 .cindex "size" "of mailbox"
23192 If this option is set, it is expanded, and the result is taken as the current
23193 size the mailbox. It must be a decimal number, optionally followed by K or M.
23194 This provides a way of obtaining this information from an external source that
23195 maintains the data. This is likely to be helpful for maildir deliveries where
23196 it is computationally expensive to compute the size of a mailbox.
23197
23198
23199
23200 .option maildir_format appendfile boolean false
23201 .cindex "maildir format" "specifying"
23202 If this option is set with the &%directory%& option, the delivery is into a new
23203 file, in the &"maildir"& format that is used by other mail software. When the
23204 transport is activated directly from a &(redirect)& router (for example, the
23205 &(address_file)& transport in the default configuration), setting
23206 &%maildir_format%& causes the path received from the router to be treated as a
23207 directory, whether or not it ends with &`/`&. This option is available only if
23208 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23209 &<<SECTmaildirdelivery>>& below for further details.
23210
23211
23212 .option maildir_quota_directory_regex appendfile string "See below"
23213 .cindex "maildir format" "quota; directories included in"
23214 .cindex "quota" "maildir; directories included in"
23215 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23216 a regular expression for specifying directories, relative to the quota
23217 directory (see &%quota_directory%&), that should be included in the quota
23218 calculation. The default value is:
23219 .code
23220 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23221 .endd
23222 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23223 (directories whose names begin with a dot). If you want to exclude the
23224 &_Trash_&
23225 folder from the count (as some sites do), you need to change this setting to
23226 .code
23227 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23228 .endd
23229 This uses a negative lookahead in the regular expression to exclude the
23230 directory whose name is &_.Trash_&. When a directory is excluded from quota
23231 calculations, quota processing is bypassed for any messages that are delivered
23232 directly into that directory.
23233
23234
23235 .option maildir_retries appendfile integer 10
23236 This option specifies the number of times to retry when writing a file in
23237 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23238
23239
23240 .option maildir_tag appendfile string&!! unset
23241 This option applies only to deliveries in maildir format, and is described in
23242 section &<<SECTmaildirdelivery>>& below.
23243
23244
23245 .option maildir_use_size_file appendfile&!! boolean false
23246 .cindex "maildir format" "&_maildirsize_& file"
23247 The result of string expansion for this option must be a valid boolean value.
23248 If it is true, it enables support for &_maildirsize_& files. Exim
23249 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23250 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23251 value is zero. See &%maildir_quota_directory_regex%& above and section
23252 &<<SECTmaildirdelivery>>& below for further details.
23253
23254 .option maildirfolder_create_regex appendfile string unset
23255 .cindex "maildir format" "&_maildirfolder_& file"
23256 .cindex "&_maildirfolder_&, creating"
23257 The value of this option is a regular expression. If it is unset, it has no
23258 effect. Otherwise, before a maildir delivery takes place, the pattern is
23259 matched against the name of the maildir directory, that is, the directory
23260 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23261 delivery. If there is a match, Exim checks for the existence of a file called
23262 &_maildirfolder_& in the directory, and creates it if it does not exist.
23263 See section &<<SECTmaildirdelivery>>& for more details.
23264
23265
23266 .option mailstore_format appendfile boolean false
23267 .cindex "mailstore format" "specifying"
23268 If this option is set with the &%directory%& option, the delivery is into two
23269 new files in  &"mailstore"& format. The option is available only if
23270 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23271 below for further details.
23272
23273
23274 .option mailstore_prefix appendfile string&!! unset
23275 This option applies only to deliveries in mailstore format, and is described in
23276 section &<<SECTopdir>>& below.
23277
23278
23279 .option mailstore_suffix appendfile string&!! unset
23280 This option applies only to deliveries in mailstore format, and is described in
23281 section &<<SECTopdir>>& below.
23282
23283
23284 .option mbx_format appendfile boolean false
23285 .cindex "locking files"
23286 .cindex "file" "locking"
23287 .cindex "file" "MBX format"
23288 .cindex "MBX format, specifying"
23289 This option is available only if Exim has been compiled with SUPPORT_MBX
23290 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23291 the message is appended to the mailbox file in MBX format instead of
23292 traditional Unix format. This format is supported by Pine4 and its associated
23293 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23294
23295 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23296 automatically changed by the use of &%mbx_format%&. They should normally be set
23297 empty when using MBX format, so this option almost always appears in this
23298 combination:
23299 .code
23300 mbx_format = true
23301 message_prefix =
23302 message_suffix =
23303 .endd
23304 If none of the locking options are mentioned in the configuration,
23305 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23306 is possible to specify the other kinds of locking with &%mbx_format%&, but
23307 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23308 interworks with &'c-client'&, providing for shared access to the mailbox. It
23309 should not be used if any program that does not use this form of locking is
23310 going to access the mailbox, nor should it be used if the mailbox file is NFS
23311 mounted, because it works only when the mailbox is accessed from a single host.
23312
23313 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23314 the standard version of &'c-client'&, because as long as it has a mailbox open
23315 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23316 append messages to it.
23317
23318
23319 .option message_prefix appendfile string&!! "see below"
23320 .cindex "&""From""& line"
23321 The string specified here is expanded and output at the start of every message.
23322 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23323 in which case it is:
23324 .code
23325 message_prefix = "From ${if def:return_path{$return_path}\
23326   {MAILER-DAEMON}} $tod_bsdinbox\n"
23327 .endd
23328 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23329 &`\n`& to &`\r\n`& in &%message_prefix%&.
23330
23331 .option message_suffix appendfile string&!! "see below"
23332 The string specified here is expanded and output at the end of every message.
23333 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23334 in which case it is a single newline character. The suffix can be suppressed by
23335 setting
23336 .code
23337 message_suffix =
23338 .endd
23339 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23340 &`\n`& to &`\r\n`& in &%message_suffix%&.
23341
23342 .option mode appendfile "octal integer" 0600
23343 If the output file is created, it is given this mode. If it already exists and
23344 has wider permissions, they are reduced to this mode. If it has narrower
23345 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23346 if the delivery is the result of a &%save%& command in a filter file specifying
23347 a particular mode, the mode of the output file is always forced to take that
23348 value, and this option is ignored.
23349
23350
23351 .option mode_fail_narrower appendfile boolean true
23352 This option applies in the case when an existing mailbox file has a narrower
23353 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23354 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23355 continues with the delivery attempt, using the existing mode of the file.
23356
23357
23358 .option notify_comsat appendfile boolean false
23359 If this option is true, the &'comsat'& daemon is notified after every
23360 successful delivery to a user mailbox. This is the daemon that notifies logged
23361 on users about incoming mail.
23362
23363
23364 .option quota appendfile string&!! unset
23365 .cindex "quota" "imposed by Exim"
23366 This option imposes a limit on the size of the file to which Exim is appending,
23367 or to the total space used in the directory tree when the &%directory%& option
23368 is set. In the latter case, computation of the space used is expensive, because
23369 all the files in the directory (and any sub-directories) have to be
23370 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23371 &%maildir_use_size_file%& for ways to avoid this in environments where users
23372 have no shell access to their mailboxes).
23373
23374 As there is no interlock against two simultaneous deliveries into a
23375 multi-file mailbox, it is possible for the quota to be overrun in this case.
23376 For single-file mailboxes, of course, an interlock is a necessity.
23377
23378 A file's size is taken as its &'used'& value. Because of blocking effects, this
23379 may be a lot less than the actual amount of disk space allocated to the file.
23380 If the sizes of a number of files are being added up, the rounding effect can
23381 become quite noticeable, especially on systems that have large block sizes.
23382 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23383 the obvious value which users understand most easily.
23384
23385 The value of the option is expanded, and must then be a numerical value
23386 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23387 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23388 and further option modifiers. If Exim is running on a system with
23389 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23390 be handled.
23391
23392 The option modifier &%no_check%& can be used to force delivery even if the over
23393 quota condition is met. The quota gets updated as usual.
23394
23395 &*Note*&: A value of zero is interpreted as &"no quota"&.
23396
23397 The expansion happens while Exim is running as root, before it changes uid for
23398 the delivery. This means that files that are inaccessible to the end user can
23399 be used to hold quota values that are looked up in the expansion. When delivery
23400 fails because this quota is exceeded, the handling of the error is as for
23401 system quota failures.
23402
23403 By default, Exim's quota checking mimics system quotas, and restricts the
23404 mailbox to the specified maximum size, though the value is not accurate to the
23405 last byte, owing to separator lines and additional headers that may get added
23406 during message delivery. When a mailbox is nearly full, large messages may get
23407 refused even though small ones are accepted, because the size of the current
23408 message is added to the quota when the check is made. This behaviour can be
23409 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23410 for exceeding the quota does not include the current message. Thus, deliveries
23411 continue until the quota has been exceeded; thereafter, no further messages are
23412 delivered. See also &%quota_warn_threshold%&.
23413
23414
23415 .option quota_directory appendfile string&!! unset
23416 This option defines the directory to check for quota purposes when delivering
23417 into individual files. The default is the delivery directory, or, if a file
23418 called &_maildirfolder_& exists in a maildir directory, the parent of the
23419 delivery directory.
23420
23421
23422 .option quota_filecount appendfile string&!! 0
23423 This option applies when the &%directory%& option is set. It limits the total
23424 number of files in the directory (compare the inode limit in system quotas). It
23425 can only be used if &%quota%& is also set. The value is expanded; an expansion
23426 failure causes delivery to be deferred. A value of zero is interpreted as
23427 &"no quota"&.
23428
23429 The option modifier &%no_check%& can be used to force delivery even if the over
23430 quota condition is met. The quota gets updated as usual.
23431
23432 .option quota_is_inclusive appendfile boolean true
23433 See &%quota%& above.
23434
23435
23436 .option quota_size_regex appendfile string unset
23437 This option applies when one of the delivery modes that writes a separate file
23438 for each message is being used. When Exim wants to find the size of one of
23439 these files in order to test the quota, it first checks &%quota_size_regex%&.
23440 If this is set to a regular expression that matches the filename, and it
23441 captures one string, that string is interpreted as a representation of the
23442 file's size. The value of &%quota_size_regex%& is not expanded.
23443
23444 This feature is useful only when users have no shell access to their mailboxes
23445 &-- otherwise they could defeat the quota simply by renaming the files. This
23446 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23447 the file length to the filename. For example:
23448 .code
23449 maildir_tag = ,S=$message_size
23450 quota_size_regex = ,S=(\d+)
23451 .endd
23452 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23453 number of lines in the message.
23454
23455 The regular expression should not assume that the length is at the end of the
23456 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23457 sometimes add other information onto the ends of message filenames.
23458
23459 Section &<<SECID136>>& contains further information.
23460
23461 This option should not be used when other message-handling software
23462 may duplicate messages by making hardlinks to the files.  When that is done Exim
23463 will count the message size once for each filename, in contrast with the actual
23464 disk usage.  When the option is not set, calculating total usage requires
23465 a system-call per file to get the size; the number of links is then available also
23466 as is used to adjust the effective size.
23467
23468
23469 .option quota_warn_message appendfile string&!! "see below"
23470 See below for the use of this option. If it is not set when
23471 &%quota_warn_threshold%& is set, it defaults to
23472 .code
23473 quota_warn_message = "\
23474   To: $local_part@$domain\n\
23475   Subject: Your mailbox\n\n\
23476   This message is automatically created \
23477   by mail delivery software.\n\n\
23478   The size of your mailbox has exceeded \
23479   a warning threshold that is\n\
23480   set by the system administrator.\n"
23481 .endd
23482
23483
23484 .option quota_warn_threshold appendfile string&!! 0
23485 .cindex "quota" "warning threshold"
23486 .cindex "mailbox" "size warning"
23487 .cindex "size" "of mailbox"
23488 This option is expanded in the same way as &%quota%& (see above). If the
23489 resulting value is greater than zero, and delivery of the message causes the
23490 size of the file or total space in the directory tree to cross the given
23491 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23492 may be specified as a percentage of it by following the value with a percent
23493 sign. For example:
23494 .code
23495 quota = 10M
23496 quota_warn_threshold = 75%
23497 .endd
23498 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23499 percent sign is ignored.
23500
23501 The warning message itself is specified by the &%quota_warn_message%& option,
23502 and it must start with a &'To:'& header line containing the recipient(s) of the
23503 warning message. These do not necessarily have to include the recipient(s) of
23504 the original message. A &'Subject:'& line should also normally be supplied. You
23505 can include any other header lines that you want. If you do not include a
23506 &'From:'& line, the default is:
23507 .code
23508 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23509 .endd
23510 .oindex &%errors_reply_to%&
23511 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23512 option.
23513
23514 The &%quota%& option does not have to be set in order to use this option; they
23515 are independent of one another except when the threshold is specified as a
23516 percentage.
23517
23518
23519 .option use_bsmtp appendfile boolean false
23520 .cindex "envelope from"
23521 .cindex "envelope sender"
23522 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23523 format, with the envelope sender and recipient(s) included as SMTP commands. If
23524 you want to include a leading HELO command with such messages, you can do
23525 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23526 for details of batch SMTP.
23527
23528
23529 .option use_crlf appendfile boolean false
23530 .cindex "carriage return"
23531 .cindex "linefeed"
23532 This option causes lines to be terminated with the two-character CRLF sequence
23533 (carriage return, linefeed) instead of just a linefeed character. In the case
23534 of batched SMTP, the byte sequence written to the file is then an exact image
23535 of what would be sent down a real SMTP connection.
23536
23537 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23538 (which are used to supply the traditional &"From&~"& and blank line separators
23539 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23540 carriage return characters if these are needed. In cases where these options
23541 have non-empty defaults, the values end with a single linefeed, so they must be
23542 changed to end with &`\r\n`& if &%use_crlf%& is set.
23543
23544
23545 .option use_fcntl_lock appendfile boolean "see below"
23546 This option controls the use of the &[fcntl()]& function to lock a file for
23547 exclusive use when a message is being appended. It is set by default unless
23548 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23549 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23550 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23551
23552
23553 .option use_flock_lock appendfile boolean false
23554 This option is provided to support the use of &[flock()]& for file locking, for
23555 the few situations where it is needed. Most modern operating systems support
23556 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23557 each other. Exim uses &[fcntl()]& locking by default.
23558
23559 This option is required only if you are using an operating system where
23560 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23561 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23562 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23563
23564 .cindex "Solaris" "&[flock()]& support"
23565 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23566 have it (and some, I think, provide a not quite right version built on top of
23567 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23568 the ability to use it, and any attempt to do so will cause a configuration
23569 error.
23570
23571 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23572 is just being mapped onto &[fcntl()]& by the OS).
23573
23574
23575 .option use_lockfile appendfile boolean "see below"
23576 If this option is turned off, Exim does not attempt to create a lock file when
23577 appending to a mailbox file. In this situation, the only locking is by
23578 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23579 sure that every MUA that is ever going to look at your users' mailboxes uses
23580 &[fcntl()]& rather than a lock file, and even then only when you are not
23581 delivering over NFS from more than one host.
23582
23583 .cindex "NFS" "lock file"
23584 In order to append to an NFS file safely from more than one host, it is
23585 necessary to take out a lock &'before'& opening the file, and the lock file
23586 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23587 file corruption.
23588
23589 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23590 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23591 except when &%mbx_format%& is set.
23592
23593
23594 .option use_mbx_lock appendfile boolean "see below"
23595 This option is available only if Exim has been compiled with SUPPORT_MBX
23596 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23597 locking rules be used. It is set by default if &%mbx_format%& is set and none
23598 of the locking options are mentioned in the configuration. The locking rules
23599 are the same as are used by the &'c-client'& library that underlies Pine and
23600 the IMAP4 and POP daemons that come with it (see the discussion below). The
23601 rules allow for shared access to the mailbox. However, this kind of locking
23602 does not work when the mailbox is NFS mounted.
23603
23604 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23605 &%use_flock_lock%& to control what kind of locking is used in implementing the
23606 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23607 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23608
23609
23610
23611
23612 .section "Operational details for appending" "SECTopappend"
23613 .cindex "appending to a file"
23614 .cindex "file" "appending"
23615 Before appending to a file, the following preparations are made:
23616
23617 .ilist
23618 If the name of the file is &_/dev/null_&, no action is taken, and a success
23619 return is given.
23620
23621 .next
23622 .cindex "directory creation"
23623 If any directories on the file's path are missing, Exim creates them if the
23624 &%create_directory%& option is set. A created directory's mode is given by the
23625 &%directory_mode%& option.
23626
23627 .next
23628 If &%file_format%& is set, the format of an existing file is checked. If this
23629 indicates that a different transport should be used, control is passed to that
23630 transport.
23631
23632 .next
23633 .cindex "file" "locking"
23634 .cindex "locking files"
23635 .cindex "NFS" "lock file"
23636 If &%use_lockfile%& is set, a lock file is built in a way that will work
23637 reliably over NFS, as follows:
23638
23639 .olist
23640 Create a &"hitching post"& file whose name is that of the lock file with the
23641 current time, primary host name, and process id added, by opening for writing
23642 as a new file. If this fails with an access error, delivery is deferred.
23643 .next
23644 Close the hitching post file, and hard link it to the lock filename.
23645 .next
23646 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23647 Unlink the hitching post name.
23648 .next
23649 Otherwise, use &[stat()]& to get information about the hitching post file, and
23650 then unlink hitching post name. If the number of links is exactly two, creation
23651 of the lock file succeeded but something (for example, an NFS server crash and
23652 restart) caused this fact not to be communicated to the &[link()]& call.
23653 .next
23654 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23655 up to &%lock_retries%& times. However, since any program that writes to a
23656 mailbox should complete its task very quickly, it is reasonable to time out old
23657 lock files that are normally the result of user agent and system crashes. If an
23658 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23659 it before trying again.
23660 .endlist olist
23661
23662 .next
23663 A call is made to &[lstat()]& to discover whether the main file exists, and if
23664 so, what its characteristics are. If &[lstat()]& fails for any reason other
23665 than non-existence, delivery is deferred.
23666
23667 .next
23668 .cindex "symbolic link" "to mailbox"
23669 .cindex "mailbox" "symbolic link"
23670 If the file does exist and is a symbolic link, delivery is deferred, unless the
23671 &%allow_symlink%& option is set, in which case the ownership of the link is
23672 checked, and then &[stat()]& is called to find out about the real file, which
23673 is then subjected to the checks below. The check on the top-level link
23674 ownership prevents one user creating a link for another's mailbox in a sticky
23675 directory, though allowing symbolic links in this case is definitely not a good
23676 idea. If there is a chain of symbolic links, the intermediate ones are not
23677 checked.
23678
23679 .next
23680 If the file already exists but is not a regular file, or if the file's owner
23681 and group (if the group is being checked &-- see &%check_group%& above) are
23682 different from the user and group under which the delivery is running,
23683 delivery is deferred.
23684
23685 .next
23686 If the file's permissions are more generous than specified, they are reduced.
23687 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23688 is set false, in which case the delivery is tried using the existing
23689 permissions.
23690
23691 .next
23692 The file's inode number is saved, and the file is then opened for appending.
23693 If this fails because the file has vanished, &(appendfile)& behaves as if it
23694 hadn't existed (see below). For any other failures, delivery is deferred.
23695
23696 .next
23697 If the file is opened successfully, check that the inode number hasn't
23698 changed, that it is still a regular file, and that the owner and permissions
23699 have not changed. If anything is wrong, defer delivery and freeze the message.
23700
23701 .next
23702 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23703 option is set. Otherwise, check that the file is being created in a permitted
23704 directory if the &%create_file%& option is set (deferring on failure), and then
23705 open for writing as a new file, with the O_EXCL and O_CREAT options,
23706 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23707 set). In this case, which can happen if the link points to a non-existent file,
23708 the file is opened for writing using O_CREAT but not O_EXCL, because
23709 that prevents link following.
23710
23711 .next
23712 .cindex "loop" "while file testing"
23713 If opening fails because the file exists, obey the tests given above for
23714 existing files. However, to avoid looping in a situation where the file is
23715 being continuously created and destroyed, the exists/not-exists loop is broken
23716 after 10 repetitions, and the message is then frozen.
23717
23718 .next
23719 If opening fails with any other error, defer delivery.
23720
23721 .next
23722 .cindex "file" "locking"
23723 .cindex "locking files"
23724 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23725 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23726 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23727 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23728 file, and an exclusive lock on the file whose name is
23729 .code
23730 /tmp/.<device-number>.<inode-number>
23731 .endd
23732 using the device and inode numbers of the open mailbox file, in accordance with
23733 the MBX locking rules. This file is created with a mode that is specified by
23734 the &%lockfile_mode%& option.
23735
23736 If Exim fails to lock the file, there are two possible courses of action,
23737 depending on the value of the locking timeout. This is obtained from
23738 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23739
23740 If the timeout value is zero, the file is closed, Exim waits for
23741 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23742 to lock it again. This happens up to &%lock_retries%& times, after which the
23743 delivery is deferred.
23744
23745 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23746 &[flock()]& are used (with the given timeout), so there has already been some
23747 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23748 immediately. It retries up to
23749 .code
23750 (lock_retries * lock_interval) / <timeout>
23751 .endd
23752 times (rounded up).
23753 .endlist
23754
23755 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23756 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23757
23758
23759 .section "Operational details for delivery to a new file" "SECTopdir"
23760 .cindex "delivery" "to single file"
23761 .cindex "&""From""& line"
23762 When the &%directory%& option is set instead of &%file%&, each message is
23763 delivered into a newly-created file or set of files. When &(appendfile)& is
23764 activated directly from a &(redirect)& router, neither &%file%& nor
23765 &%directory%& is normally set, because the path for delivery is supplied by the
23766 router. (See for example, the &(address_file)& transport in the default
23767 configuration.) In this case, delivery is to a new file if either the path name
23768 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23769
23770 No locking is required while writing the message to a new file, so the various
23771 locking options of the transport are ignored. The &"From"& line that by default
23772 separates messages in a single file is not normally needed, nor is the escaping
23773 of message lines that start with &"From"&, and there is no need to ensure a
23774 newline at the end of each message. Consequently, the default values for
23775 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23776 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23777
23778 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23779 the files in the delivery directory by default. However, you can specify a
23780 different directory by setting &%quota_directory%&. Also, for maildir
23781 deliveries (see below) the &_maildirfolder_& convention is honoured.
23782
23783
23784 .cindex "maildir format"
23785 .cindex "mailstore format"
23786 There are three different ways in which delivery to individual files can be
23787 done, controlled by the settings of the &%maildir_format%& and
23788 &%mailstore_format%& options. Note that code to support maildir or mailstore
23789 formats is not included in the binary unless SUPPORT_MAILDIR or
23790 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23791
23792 .cindex "directory creation"
23793 In all three cases an attempt is made to create the directory and any necessary
23794 sub-directories if they do not exist, provided that the &%create_directory%&
23795 option is set (the default). The location of a created directory can be
23796 constrained by setting &%create_file%&. A created directory's mode is given by
23797 the &%directory_mode%& option. If creation fails, or if the
23798 &%create_directory%& option is not set when creation is required, delivery is
23799 deferred.
23800
23801
23802
23803 .section "Maildir delivery" "SECTmaildirdelivery"
23804 .cindex "maildir format" "description of"
23805 If the &%maildir_format%& option is true, Exim delivers each message by writing
23806 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23807 directory that is defined by the &%directory%& option (the &"delivery
23808 directory"&). If the delivery is successful, the file is renamed into the
23809 &_new_& subdirectory.
23810
23811 In the filename, <&'stime'&> is the current time of day in seconds, and
23812 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23813 Exim checks that the time-of-day clock has moved on by at least one microsecond
23814 before terminating the delivery process. This guarantees uniqueness for the
23815 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23816 opening it. If any response other than ENOENT (does not exist) is given,
23817 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23818
23819 Before Exim carries out a maildir delivery, it ensures that subdirectories
23820 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23821 do not exist, Exim tries to create them and any superior directories in their
23822 path, subject to the &%create_directory%& and &%create_file%& options. If the
23823 &%maildirfolder_create_regex%& option is set, and the regular expression it
23824 contains matches the delivery directory, Exim also ensures that a file called
23825 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23826 &_maildirfolder_& file cannot be created, delivery is deferred.
23827
23828 These features make it possible to use Exim to create all the necessary files
23829 and directories in a maildir mailbox, including subdirectories for maildir++
23830 folders. Consider this example:
23831 .code
23832 maildir_format = true
23833 directory = /var/mail/$local_part_data\
23834            ${if eq{$local_part_suffix}{}{}\
23835            {/.${substr_1:$local_part_suffix}}}
23836 maildirfolder_create_regex = /\.[^/]+$
23837 .endd
23838 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23839 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23840 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23841 not match this name, so Exim will not look for or create the file
23842 &_/var/mail/pimbo/maildirfolder_&, though it will create
23843 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23844
23845 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23846 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23847 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23848 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23849 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23850
23851 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23852 not inadvertently match the toplevel maildir directory, because a
23853 &_maildirfolder_& file at top level would completely break quota calculations.
23854
23855 .cindex "quota" "in maildir delivery"
23856 .cindex "maildir++"
23857 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23858 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23859 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23860 Exim assumes the directory is a maildir++ folder directory, which is one level
23861 down from the user's top level mailbox directory. This causes it to start at
23862 the parent directory instead of the current directory when calculating the
23863 amount of space used.
23864
23865 One problem with delivering into a multi-file mailbox is that it is
23866 computationally expensive to compute the size of the mailbox for quota
23867 checking. Various approaches have been taken to reduce the amount of work
23868 needed. The next two sections describe two of them. A third alternative is to
23869 use some external process for maintaining the size data, and use the expansion
23870 of the &%mailbox_size%& option as a way of importing it into Exim.
23871
23872
23873
23874
23875 .section "Using tags to record message sizes" "SECID135"
23876 If &%maildir_tag%& is set, the string is expanded for each delivery.
23877 When the maildir file is renamed into the &_new_& sub-directory, the
23878 tag is added to its name. However, if adding the tag takes the length of the
23879 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23880 the tag is dropped and the maildir file is created with no tag.
23881
23882
23883 .vindex "&$message_size$&"
23884 Tags can be used to encode the size of files in their names; see
23885 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23886 happens after the message has been written. The value of the &$message_size$&
23887 variable is set to the number of bytes actually written. If the expansion is
23888 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23889 be deferred. The expanded tag may contain any printing characters except &"/"&.
23890 Non-printing characters in the string are ignored; if the resulting string is
23891 empty, it is ignored. If it starts with an alphanumeric character, a leading
23892 colon is inserted; this default has not proven to be the path that popular
23893 maildir implementations have chosen (but changing it in Exim would break
23894 backwards compatibility).
23895
23896 For one common implementation, you might set:
23897 .code
23898 maildir_tag = ,S=${message_size}
23899 .endd
23900 but you should check the documentation of the other software to be sure.
23901
23902 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23903 as this allows Exim to extract the size from your tag, instead of having to
23904 &[stat()]& each message file.
23905
23906
23907 .section "Using a maildirsize file" "SECID136"
23908 .cindex "quota" "in maildir delivery"
23909 .cindex "maildir format" "&_maildirsize_& file"
23910 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23911 storing quota and message size information in a file called &_maildirsize_&
23912 within the toplevel maildir directory. If this file does not exist, Exim
23913 creates it, setting the quota from the &%quota%& option of the transport. If
23914 the maildir directory itself does not exist, it is created before any attempt
23915 to write a &_maildirsize_& file.
23916
23917 The &_maildirsize_& file is used to hold information about the sizes of
23918 messages in the maildir, thus speeding up quota calculations. The quota value
23919 in the file is just a cache; if the quota is changed in the transport, the new
23920 value overrides the cached value when the next message is delivered. The cache
23921 is maintained for the benefit of other programs that access the maildir and
23922 need to know the quota.
23923
23924 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23925 file is maintained (with a zero quota setting), but no quota is imposed.
23926
23927 A regular expression is available for controlling which directories in the
23928 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23929 See the description of the &%maildir_quota_directory_regex%& option above for
23930 details.
23931
23932
23933 .section "Mailstore delivery" "SECID137"
23934 .cindex "mailstore format" "description of"
23935 If the &%mailstore_format%& option is true, each message is written as two
23936 files in the given directory. A unique base name is constructed from the
23937 message id and the current delivery process, and the files that are written use
23938 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23939 contains the message's envelope, and the &_.msg_& file contains the message
23940 itself. The base name is placed in the variable &$mailstore_basename$&.
23941
23942 During delivery, the envelope is first written to a file with the suffix
23943 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23944 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23945 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23946 file before accessing either of them. An alternative approach is to wait for
23947 the absence of a &_.tmp_& file.
23948
23949 The envelope file starts with any text defined by the &%mailstore_prefix%&
23950 option, expanded and terminated by a newline if there isn't one. Then follows
23951 the sender address on one line, then all the recipient addresses, one per line.
23952 There can be more than one recipient only if the &%batch_max%& option is set
23953 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23954 appended to the file, followed by a newline if it does not end with one.
23955
23956 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23957 failure, it is ignored. Other expansion errors are treated as serious
23958 configuration errors, and delivery is deferred. The variable
23959 &$mailstore_basename$& is available for use during these expansions.
23960
23961
23962 .section "Non-special new file delivery" "SECID138"
23963 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23964 file is created directly in the named directory. For example, when delivering
23965 messages into files in batched SMTP format for later delivery to some host (see
23966 section &<<SECTbatchSMTP>>&), a setting such as
23967 .code
23968 directory = /var/bsmtp/$host
23969 .endd
23970 might be used. A message is written to a file with a temporary name, which is
23971 then renamed when the delivery is complete. The final name is obtained by
23972 expanding the contents of the &%directory_file%& option.
23973 .ecindex IIDapptra1
23974 .ecindex IIDapptra2
23975
23976
23977
23978
23979
23980
23981 . ////////////////////////////////////////////////////////////////////////////
23982 . ////////////////////////////////////////////////////////////////////////////
23983
23984 .chapter "The autoreply transport" "CHID8"
23985 .scindex IIDauttra1 "transports" "&(autoreply)&"
23986 .scindex IIDauttra2 "&(autoreply)& transport"
23987 The &(autoreply)& transport is not a true transport in that it does not cause
23988 the message to be transmitted. Instead, it generates a new mail message as an
23989 automatic reply to the incoming message. &'References:'& and
23990 &'Auto-Submitted:'& header lines are included. These are constructed according
23991 to the rules in RFCs 2822 and 3834, respectively.
23992
23993 If the router that passes the message to this transport does not have the
23994 &%unseen%& option set, the original message (for the current recipient) is not
23995 delivered anywhere. However, when the &%unseen%& option is set on the router
23996 that passes the message to this transport, routing of the address continues, so
23997 another router can set up a normal message delivery.
23998
23999
24000 The &(autoreply)& transport is usually run as the result of mail filtering, a
24001 &"vacation"& message being the standard example. However, it can also be run
24002 directly from a router like any other transport. To reduce the possibility of
24003 message cascades, messages created by the &(autoreply)& transport always have
24004 empty envelope sender addresses, like bounce messages.
24005
24006 The parameters of the message to be sent can be specified in the configuration
24007 by options described below. However, these are used only when the address
24008 passed to the transport does not contain its own reply information. When the
24009 transport is run as a consequence of a
24010 &%mail%&
24011 or &%vacation%& command in a filter file, the parameters of the message are
24012 supplied by the filter, and passed with the address. The transport's options
24013 that define the message are then ignored (so they are not usually set in this
24014 case). The message is specified entirely by the filter or by the transport; it
24015 is never built from a mixture of options. However, the &%file_optional%&,
24016 &%mode%&, and &%return_message%& options apply in all cases.
24017
24018 &(Autoreply)& is implemented as a local transport. When used as a result of a
24019 command in a user's filter file, &(autoreply)& normally runs under the uid and
24020 gid of the user, and with appropriate current and home directories (see chapter
24021 &<<CHAPenvironment>>&).
24022
24023 There is a subtle difference between routing a message to a &(pipe)& transport
24024 that generates some text to be returned to the sender, and routing it to an
24025 &(autoreply)& transport. This difference is noticeable only if more than one
24026 address from the same message is so handled. In the case of a pipe, the
24027 separate outputs from the different addresses are gathered up and returned to
24028 the sender in a single message, whereas if &(autoreply)& is used, a separate
24029 message is generated for each address that is passed to it.
24030
24031 Non-printing characters are not permitted in the header lines generated for the
24032 message that &(autoreply)& creates, with the exception of newlines that are
24033 immediately followed by white space. If any non-printing characters are found,
24034 the transport defers.
24035 Whether characters with the top bit set count as printing characters or not is
24036 controlled by the &%print_topbitchars%& global option.
24037
24038 If any of the generic options for manipulating headers (for example,
24039 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24040 of the original message that is included in the generated message when
24041 &%return_message%& is set. They do not apply to the generated message itself.
24042
24043 .vindex "&$sender_address$&"
24044 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24045 the message, indicating that there were no recipients, it does not treat this
24046 as an error. This means that autoreplies sent to &$sender_address$& when this
24047 is empty (because the incoming message is a bounce message) do not cause
24048 problems. They are just discarded.
24049
24050
24051
24052 .section "Private options for autoreply" "SECID139"
24053 .cindex "options" "&(autoreply)& transport"
24054
24055 .option bcc autoreply string&!! unset
24056 This specifies the addresses that are to receive &"blind carbon copies"& of the
24057 message when the message is specified by the transport.
24058
24059
24060 .option cc autoreply string&!! unset
24061 This specifies recipients of the message and the contents of the &'Cc:'& header
24062 when the message is specified by the transport.
24063
24064
24065 .option file autoreply string&!! unset
24066 The contents of the file are sent as the body of the message when the message
24067 is specified by the transport. If both &%file%& and &%text%& are set, the text
24068 string comes first.
24069
24070
24071 .option file_expand autoreply boolean false
24072 If this is set, the contents of the file named by the &%file%& option are
24073 subjected to string expansion as they are added to the message.
24074
24075
24076 .option file_optional autoreply boolean false
24077 If this option is true, no error is generated if the file named by the &%file%&
24078 option or passed with the address does not exist or cannot be read.
24079
24080
24081 .option from autoreply string&!! unset
24082 This specifies the contents of the &'From:'& header when the message is
24083 specified by the transport.
24084
24085
24086 .option headers autoreply string&!! unset
24087 This specifies additional RFC 2822 headers that are to be added to the message
24088 when the message is specified by the transport. Several can be given by using
24089 &"\n"& to separate them. There is no check on the format.
24090
24091
24092 .option log autoreply string&!! unset
24093 This option names a file in which a record of every message sent is logged when
24094 the message is specified by the transport.
24095
24096
24097 .option mode autoreply "octal integer" 0600
24098 If either the log file or the &"once"& file has to be created, this mode is
24099 used.
24100
24101
24102 .option never_mail autoreply "address list&!!" unset
24103 If any run of the transport creates a message with a recipient that matches any
24104 item in the list, that recipient is quietly discarded. If all recipients are
24105 discarded, no message is created. This applies both when the recipients are
24106 generated by a filter and when they are specified in the transport.
24107
24108
24109
24110 .option once autoreply string&!! unset
24111 This option names a file or DBM database in which a record of each &'To:'&
24112 recipient is kept when the message is specified by the transport. &*Note*&:
24113 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24114
24115 If &%once%& is unset, or is set to an empty string, the message is always sent.
24116 By default, if &%once%& is set to a non-empty filename, the message
24117 is not sent if a potential recipient is already listed in the database.
24118 However, if the &%once_repeat%& option specifies a time greater than zero, the
24119 message is sent if that much time has elapsed since a message was last sent to
24120 this recipient. A setting of zero time for &%once_repeat%& (the default)
24121 prevents a message from being sent a second time &-- in this case, zero means
24122 infinity.
24123
24124 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24125 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24126 greater than zero, it changes the way Exim implements the &%once%& option.
24127 Instead of using a DBM file to record every recipient it sends to, it uses a
24128 regular file, whose size will never get larger than the given value.
24129
24130 In the file, Exim keeps a linear list of recipient addresses and the times at
24131 which they were sent messages. If the file is full when a new address needs to
24132 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24133 means that a given recipient may receive multiple messages, but at
24134 unpredictable intervals that depend on the rate of turnover of addresses in the
24135 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24136
24137
24138 .option once_file_size autoreply integer 0
24139 See &%once%& above.
24140
24141
24142 .option once_repeat autoreply time&!! 0s
24143 See &%once%& above.
24144 After expansion, the value of this option must be a valid time value.
24145
24146
24147 .option reply_to autoreply string&!! unset
24148 This specifies the contents of the &'Reply-To:'& header when the message is
24149 specified by the transport.
24150
24151
24152 .option return_message autoreply boolean false
24153 If this is set, a copy of the original message is returned with the new
24154 message, subject to the maximum size set in the &%return_size_limit%& global
24155 configuration option.
24156
24157
24158 .option subject autoreply string&!! unset
24159 This specifies the contents of the &'Subject:'& header when the message is
24160 specified by the transport. It is tempting to quote the original subject in
24161 automatic responses. For example:
24162 .code
24163 subject = Re: $h_subject:
24164 .endd
24165 There is a danger in doing this, however. It may allow a third party to
24166 subscribe your users to an opt-in mailing list, provided that the list accepts
24167 bounce messages as subscription confirmations. Well-managed lists require a
24168 non-bounce message to confirm a subscription, so the danger is relatively
24169 small.
24170
24171
24172
24173 .option text autoreply string&!! unset
24174 This specifies a single string to be used as the body of the message when the
24175 message is specified by the transport. If both &%text%& and &%file%& are set,
24176 the text comes first.
24177
24178
24179 .option to autoreply string&!! unset
24180 This specifies recipients of the message and the contents of the &'To:'& header
24181 when the message is specified by the transport.
24182 .ecindex IIDauttra1
24183 .ecindex IIDauttra2
24184
24185
24186
24187
24188 . ////////////////////////////////////////////////////////////////////////////
24189 . ////////////////////////////////////////////////////////////////////////////
24190
24191 .chapter "The lmtp transport" "CHAPLMTP"
24192 .cindex "transports" "&(lmtp)&"
24193 .cindex "&(lmtp)& transport"
24194 .cindex "LMTP" "over a pipe"
24195 .cindex "LMTP" "over a socket"
24196 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24197 specified command
24198 or by interacting with a Unix domain socket.
24199 This transport is something of a cross between the &(pipe)& and &(smtp)&
24200 transports. Exim also has support for using LMTP over TCP/IP; this is
24201 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24202 to be of minority interest, the default build-time configure in &_src/EDITME_&
24203 has it commented out. You need to ensure that
24204 .code
24205 TRANSPORT_LMTP=yes
24206 .endd
24207 .cindex "options" "&(lmtp)& transport"
24208 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24209 included in the Exim binary. The private options of the &(lmtp)& transport are
24210 as follows:
24211
24212 .option batch_id lmtp string&!! unset
24213 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24214
24215
24216 .option batch_max lmtp integer 1
24217 This limits the number of addresses that can be handled in a single delivery.
24218 Most LMTP servers can handle several addresses at once, so it is normally a
24219 good idea to increase this value. See the description of local delivery
24220 batching in chapter &<<CHAPbatching>>&.
24221
24222
24223 .option command lmtp string&!! unset
24224 This option must be set if &%socket%& is not set. The string is a command which
24225 is run in a separate process. It is split up into a command name and list of
24226 arguments, each of which is separately expanded (so expansion cannot change the
24227 number of arguments). The command is run directly, not via a shell. The message
24228 is passed to the new process using the standard input and output to operate the
24229 LMTP protocol.
24230
24231 .option ignore_quota lmtp boolean false
24232 .cindex "LMTP" "ignoring quota errors"
24233 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24234 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24235 in its response to the LHLO command.
24236
24237 .option socket lmtp string&!! unset
24238 This option must be set if &%command%& is not set. The result of expansion must
24239 be the name of a Unix domain socket. The transport connects to the socket and
24240 delivers the message to it using the LMTP protocol.
24241
24242
24243 .option timeout lmtp time 5m
24244 The transport is aborted if the created process or Unix domain socket does not
24245 respond to LMTP commands or message input within this timeout. Delivery
24246 is deferred, and will be tried again later. Here is an example of a typical
24247 LMTP transport:
24248 .code
24249 lmtp:
24250   driver = lmtp
24251   command = /some/local/lmtp/delivery/program
24252   batch_max = 20
24253   user = exim
24254 .endd
24255 This delivers up to 20 addresses at a time, in a mixture of domains if
24256 necessary, running as the user &'exim'&.
24257
24258
24259
24260 . ////////////////////////////////////////////////////////////////////////////
24261 . ////////////////////////////////////////////////////////////////////////////
24262
24263 .chapter "The pipe transport" "CHAPpipetransport"
24264 .scindex IIDpiptra1 "transports" "&(pipe)&"
24265 .scindex IIDpiptra2 "&(pipe)& transport"
24266 The &(pipe)& transport is used to deliver messages via a pipe to a command
24267 running in another process. One example is the use of &(pipe)& as a
24268 pseudo-remote transport for passing messages to some other delivery mechanism
24269 (such as UUCP). Another is the use by individual users to automatically process
24270 their incoming messages. The &(pipe)& transport can be used in one of the
24271 following ways:
24272
24273 .ilist
24274 .vindex "&$local_part$&"
24275 A router routes one address to a transport in the normal way, and the
24276 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24277 contains the local part of the address (as usual), and the command that is run
24278 is specified by the &%command%& option on the transport.
24279 .next
24280 .vindex "&$pipe_addresses$&"
24281 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24282 transport can handle more than one address in a single run. In this case, when
24283 more than one address is routed to the transport, &$local_part$& is not set
24284 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24285 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24286 that are routed to the transport.
24287 .next
24288 .vindex "&$address_pipe$&"
24289 A router redirects an address directly to a pipe command (for example, from an
24290 alias or forward file). In this case, &$address_pipe$& contains the text of the
24291 pipe command, and the &%command%& option on the transport is ignored unless
24292 &%force_command%& is set. If only one address is being transported
24293 (&%batch_max%& is not greater than one, or only one address was redirected to
24294 this pipe command), &$local_part$& contains the local part that was redirected.
24295 .endlist
24296
24297
24298 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24299 deliver messages over pipes using the LMTP interactive protocol. This is
24300 implemented by the &(lmtp)& transport.
24301
24302 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24303 &_.forward_& file, the command runs under the uid and gid of that user. In
24304 other cases, the uid and gid have to be specified explicitly, either on the
24305 transport or on the router that handles the address. Current and &"home"&
24306 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24307 details of the local delivery environment and chapter &<<CHAPbatching>>&
24308 for a discussion of local delivery batching.
24309
24310 .cindex "tainted data" "in pipe command"
24311 .cindex pipe "tainted data"
24312 Tainted data may not be used for the command name.
24313
24314
24315 .section "Concurrent delivery" "SECID140"
24316 If two messages arrive at almost the same time, and both are routed to a pipe
24317 delivery, the two pipe transports may be run concurrently. You must ensure that
24318 any pipe commands you set up are robust against this happening. If the commands
24319 write to a file, the &%exim_lock%& utility might be of use.
24320 Alternatively the &%max_parallel%& option could be used with a value
24321 of "1" to enforce serialization.
24322
24323
24324
24325
24326 .section "Returned status and data" "SECID141"
24327 .cindex "&(pipe)& transport" "returned data"
24328 If the command exits with a non-zero return code, the delivery is deemed to
24329 have failed, unless either the &%ignore_status%& option is set (in which case
24330 the return code is treated as zero), or the return code is one of those listed
24331 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24332 later"&. In this case, delivery is deferred. Details of a permanent failure are
24333 logged, but are not included in the bounce message, which merely contains
24334 &"local delivery failed"&.
24335
24336 If the command exits on a signal and the &%freeze_signal%& option is set then
24337 the message will be frozen in the queue. If that option is not set, a bounce
24338 will be sent as normal.
24339
24340 If the return code is greater than 128 and the command being run is a shell
24341 script, it normally means that the script was terminated by a signal whose
24342 value is the return code minus 128. The &%freeze_signal%& option does not
24343 apply in this case.
24344
24345 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24346 return code is set to 127. This is the value that a shell returns if it is
24347 asked to run a non-existent command. The wording for the log line suggests that
24348 a non-existent command may be the problem.
24349
24350 The &%return_output%& option can affect the result of a pipe delivery. If it is
24351 set and the command produces any output on its standard output or standard
24352 error streams, the command is considered to have failed, even if it gave a zero
24353 return code or if &%ignore_status%& is set. The output from the command is
24354 included as part of the bounce message. The &%return_fail_output%& option is
24355 similar, except that output is returned only when the command exits with a
24356 failure return code, that is, a value other than zero or a code that matches
24357 &%temp_errors%&.
24358
24359
24360
24361 .section "How the command is run" "SECThowcommandrun"
24362 .cindex "&(pipe)& transport" "path for command"
24363 The command line is (by default) broken down into a command name and arguments
24364 by the &(pipe)& transport itself. The &%allow_commands%& and
24365 &%restrict_to_path%& options can be used to restrict the commands that may be
24366 run.
24367
24368 .cindex "quoting" "in pipe command"
24369 Unquoted arguments are delimited by white space. If an argument appears in
24370 double quotes, backslash is interpreted as an escape character in the usual
24371 way. If an argument appears in single quotes, no escaping is done.
24372
24373 String expansion is applied to the command line except when it comes from a
24374 traditional &_.forward_& file (commands from a filter file are expanded). The
24375 expansion is applied to each argument in turn rather than to the whole line.
24376 For this reason, any string expansion item that contains white space must be
24377 quoted so as to be contained within a single argument. A setting such as
24378 .code
24379 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24380 .endd
24381 will not work, because the expansion item gets split between several
24382 arguments. You have to write
24383 .code
24384 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24385 .endd
24386 to ensure that it is all in one argument. The expansion is done in this way,
24387 argument by argument, so that the number of arguments cannot be changed as a
24388 result of expansion, and quotes or backslashes in inserted variables do not
24389 interact with external quoting. However, this leads to problems if you want to
24390 generate multiple arguments (or the command name plus arguments) from a single
24391 expansion. In this situation, the simplest solution is to use a shell. For
24392 example:
24393 .code
24394 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24395 .endd
24396
24397 .cindex "transport" "filter"
24398 .cindex "filter" "transport filter"
24399 .vindex "&$pipe_addresses$&"
24400 Special handling takes place when an argument consists of precisely the text
24401 &`$pipe_addresses`& (no quotes).
24402 This is not a general expansion variable; the only
24403 place this string is recognized is when it appears as an argument for a pipe or
24404 transport filter command. It causes each address that is being handled to be
24405 inserted in the argument list at that point &'as a separate argument'&. This
24406 avoids any problems with spaces or shell metacharacters, and is of use when a
24407 &(pipe)& transport is handling groups of addresses in a batch.
24408
24409 If &%force_command%& is enabled on the transport, special handling takes place
24410 for an argument that consists of precisely the text &`$address_pipe`&.  It
24411 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24412 argument is inserted in the argument list at that point
24413 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24414 the only item in the argument; in fact, if it were then &%force_command%&
24415 should behave as a no-op.  Rather, it should be used to adjust the command
24416 run while preserving the argument vector separation.
24417
24418 After splitting up into arguments and expansion, the resulting command is run
24419 in a subprocess directly from the transport, &'not'& under a shell. The
24420 message that is being delivered is supplied on the standard input, and the
24421 standard output and standard error are both connected to a single pipe that is
24422 read by Exim. The &%max_output%& option controls how much output the command
24423 may produce, and the &%return_output%& and &%return_fail_output%& options
24424 control what is done with it.
24425
24426 Not running the command under a shell (by default) lessens the security risks
24427 in cases when a command from a user's filter file is built out of data that was
24428 taken from an incoming message. If a shell is required, it can of course be
24429 explicitly specified as the command to be run. However, there are circumstances
24430 where existing commands (for example, in &_.forward_& files) expect to be run
24431 under a shell and cannot easily be modified. To allow for these cases, there is
24432 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24433 works. Instead of breaking up the command line as just described, it expands it
24434 as a single string and passes the result to &_/bin/sh_&. The
24435 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24436 with &%use_shell%&, and the whole mechanism is inherently less secure.
24437
24438
24439
24440 .section "Environment variables" "SECTpipeenv"
24441 .cindex "&(pipe)& transport" "environment for command"
24442 .cindex "environment" "&(pipe)& transport"
24443 The environment variables listed below are set up when the command is invoked.
24444 This list is a compromise for maximum compatibility with other MTAs. Note that
24445 the &%environment%& option can be used to add additional variables to this
24446 environment. The environment for the &(pipe)& transport is not subject
24447 to the &%add_environment%& and &%keep_environment%& main config options.
24448 .display
24449 &`DOMAIN            `&   the domain of the address
24450 &`HOME              `&   the home directory, if set
24451 &`HOST              `&   the host name when called from a router (see below)
24452 &`LOCAL_PART        `&   see below
24453 &`LOCAL_PART_PREFIX `&   see below
24454 &`LOCAL_PART_SUFFIX `&   see below
24455 &`LOGNAME           `&   see below
24456 &`MESSAGE_ID        `&   Exim's local ID for the message
24457 &`PATH              `&   as specified by the &%path%& option below
24458 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24459 &`RECIPIENT         `&   the complete recipient address
24460 &`SENDER            `&   the sender of the message (empty if a bounce)
24461 &`SHELL             `&   &`/bin/sh`&
24462 &`TZ                `&   the value of the &%timezone%& option, if set
24463 &`USER              `&   see below
24464 .endd
24465 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24466 router, LOCAL_PART is set to the local part of the address. When it is
24467 called as a result of a forward or alias expansion, LOCAL_PART is set to
24468 the local part of the address that was expanded. In both cases, any affixes are
24469 removed from the local part, and made available in LOCAL_PART_PREFIX and
24470 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24471 same value as LOCAL_PART for compatibility with other MTAs.
24472
24473 .cindex "HOST"
24474 HOST is set only when a &(pipe)& transport is called from a router that
24475 associates hosts with an address, typically when using &(pipe)& as a
24476 pseudo-remote transport. HOST is set to the first host name specified by
24477 the router.
24478
24479 .cindex "HOME"
24480 If the transport's generic &%home_directory%& option is set, its value is used
24481 for the HOME environment variable. Otherwise, a home directory may be set
24482 by the router's &%transport_home_directory%& option, which defaults to the
24483 user's home directory if &%check_local_user%& is set.
24484
24485
24486 .section "Private options for pipe" "SECID142"
24487 .cindex "options" "&(pipe)& transport"
24488
24489
24490
24491 .option allow_commands pipe "string list&!!" unset
24492 .cindex "&(pipe)& transport" "permitted commands"
24493 The string is expanded, and is then interpreted as a colon-separated list of
24494 permitted commands. If &%restrict_to_path%& is not set, the only commands
24495 permitted are those in the &%allow_commands%& list. They need not be absolute
24496 paths; the &%path%& option is still used for relative paths. If
24497 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24498 in the &%allow_commands%& list, or a name without any slashes that is found on
24499 the path. In other words, if neither &%allow_commands%& nor
24500 &%restrict_to_path%& is set, there is no restriction on the command, but
24501 otherwise only commands that are permitted by one or the other are allowed. For
24502 example, if
24503 .code
24504 allow_commands = /usr/bin/vacation
24505 .endd
24506 and &%restrict_to_path%& is not set, the only permitted command is
24507 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24508 &%use_shell%& is set.
24509
24510
24511 .option batch_id pipe string&!! unset
24512 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24513
24514
24515 .option batch_max pipe integer 1
24516 This limits the number of addresses that can be handled in a single delivery.
24517 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24518
24519
24520 .option check_string pipe string unset
24521 As &(pipe)& writes the message, the start of each line is tested for matching
24522 &%check_string%&, and if it does, the initial matching characters are replaced
24523 by the contents of &%escape_string%&, provided both are set. The value of
24524 &%check_string%& is a literal string, not a regular expression, and the case of
24525 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24526 of &%check_string%& and &%escape_string%& are forced to values that implement
24527 the SMTP escaping protocol. Any settings made in the configuration file are
24528 ignored.
24529
24530
24531 .option command pipe string&!! unset
24532 This option need not be set when &(pipe)& is being used to deliver to pipes
24533 obtained directly from address redirections. In other cases, the option must be
24534 set, to provide a command to be run. It need not yield an absolute path (see
24535 the &%path%& option below). The command is split up into separate arguments by
24536 Exim, and each argument is separately expanded, as described in section
24537 &<<SECThowcommandrun>>& above.
24538
24539
24540 .option environment pipe string&!! unset
24541 .cindex "&(pipe)& transport" "environment for command"
24542 .cindex "environment" "&(pipe)& transport"
24543 This option is used to add additional variables to the environment in which the
24544 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24545 a string which is expanded, and then interpreted as a colon-separated list of
24546 environment settings of the form <&'name'&>=<&'value'&>.
24547
24548
24549 .option escape_string pipe string unset
24550 See &%check_string%& above.
24551
24552
24553 .option freeze_exec_fail pipe boolean false
24554 .cindex "exec failure"
24555 .cindex "failure of exec"
24556 .cindex "&(pipe)& transport" "failure of exec"
24557 Failure to exec the command in a pipe transport is by default treated like
24558 any other failure while running the command. However, if &%freeze_exec_fail%&
24559 is set, failure to exec is treated specially, and causes the message to be
24560 frozen, whatever the setting of &%ignore_status%&.
24561
24562
24563 .option freeze_signal pipe boolean false
24564 .cindex "signal exit"
24565 .cindex "&(pipe)& transport", "signal exit"
24566 Normally if the process run by a command in a pipe transport exits on a signal,
24567 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24568 frozen in Exim's queue instead.
24569
24570
24571 .option force_command pipe boolean false
24572 .cindex "force command"
24573 .cindex "&(pipe)& transport", "force command"
24574 Normally when a router redirects an address directly to a pipe command
24575 the &%command%& option on the transport is ignored.  If &%force_command%&
24576 is set, the &%command%& option will used. This is especially
24577 useful for forcing a wrapper or additional argument to be added to the
24578 command. For example:
24579 .code
24580 command = /usr/bin/remote_exec myhost -- $address_pipe
24581 force_command
24582 .endd
24583
24584 Note that &$address_pipe$& is handled specially in &%command%& when
24585 &%force_command%& is set, expanding out to the original argument vector as
24586 separate items, similarly to a Unix shell &`"$@"`& construct.
24587
24588
24589 .option ignore_status pipe boolean false
24590 If this option is true, the status returned by the subprocess that is set up to
24591 run the command is ignored, and Exim behaves as if zero had been returned.
24592 Otherwise, a non-zero status or termination by signal causes an error return
24593 from the transport unless the status value is one of those listed in
24594 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24595
24596 &*Note*&: This option does not apply to timeouts, which do not return a status.
24597 See the &%timeout_defer%& option for how timeouts are handled.
24598
24599
24600 .option log_defer_output pipe boolean false
24601 .cindex "&(pipe)& transport" "logging output"
24602 If this option is set, and the status returned by the command is
24603 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24604 and any output was produced on stdout or stderr, the first line of it is
24605 written to the main log.
24606
24607
24608 .option log_fail_output pipe boolean false
24609 If this option is set, and the command returns any output on stdout or
24610 stderr, and also ends with a return code that is neither zero nor one of
24611 the return codes listed in &%temp_errors%& (that is, the delivery
24612 failed), the first line of output is written to the main log. This
24613 option and &%log_output%& are mutually exclusive.  Only one of them may
24614 be set.
24615
24616
24617 .option log_output pipe boolean false
24618 If this option is set and the command returns any output on stdout or
24619 stderr, the first line of output is written to the main log, whatever
24620 the return code. This option and &%log_fail_output%& are mutually
24621 exclusive. Only one of them may be set.
24622
24623
24624 .option max_output pipe integer 20K
24625 This specifies the maximum amount of output that the command may produce on its
24626 standard output and standard error file combined. If the limit is exceeded, the
24627 process running the command is killed. This is intended as a safety measure to
24628 catch runaway processes. The limit is applied independently of the settings of
24629 the options that control what is done with such output (for example,
24630 &%return_output%&). Because of buffering effects, the amount of output may
24631 exceed the limit by a small amount before Exim notices.
24632
24633
24634 .option message_prefix pipe string&!! "see below"
24635 The string specified here is expanded and output at the start of every message.
24636 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24637 .code
24638 message_prefix = \
24639   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24640   ${tod_bsdinbox}\n
24641 .endd
24642 .cindex "Cyrus"
24643 .cindex "&%tmail%&"
24644 .cindex "&""From""& line"
24645 This is required by the commonly used &_/usr/bin/vacation_& program.
24646 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24647 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24648 setting
24649 .code
24650 message_prefix =
24651 .endd
24652 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24653 &`\n`& to &`\r\n`& in &%message_prefix%&.
24654
24655
24656 .option message_suffix pipe string&!! "see below"
24657 The string specified here is expanded and output at the end of every message.
24658 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24659 The suffix can be suppressed by setting
24660 .code
24661 message_suffix =
24662 .endd
24663 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24664 &`\n`& to &`\r\n`& in &%message_suffix%&.
24665
24666
24667 .option path pipe string&!! "/bin:/usr/bin"
24668 This option is expanded and
24669 specifies the string that is set up in the PATH environment
24670 variable of the subprocess.
24671 If the &%command%& option does not yield an absolute path name, the command is
24672 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24673 apply to a command specified as a transport filter.
24674
24675
24676 .option permit_coredump pipe boolean false
24677 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24678 a core-dump of a pipe command, enable this command.  This enables core-dumps
24679 during delivery and affects both the Exim binary and the pipe command run.
24680 It is recommended that this option remain off unless and until you have a need
24681 for it and that this only be enabled when needed, as the risk of excessive
24682 resource consumption can be quite high.  Note also that Exim is typically
24683 installed as a setuid binary and most operating systems will inhibit coredumps
24684 of these by default, so further OS-specific action may be required.
24685
24686
24687 .option pipe_as_creator pipe boolean false
24688 .cindex "uid (user id)" "local delivery"
24689 If the generic &%user%& option is not set and this option is true, the delivery
24690 process is run under the uid that was in force when Exim was originally called
24691 to accept the message. If the group id is not otherwise set (via the generic
24692 &%group%& option), the gid that was in force when Exim was originally called to
24693 accept the message is used.
24694
24695
24696 .option restrict_to_path pipe boolean false
24697 When this option is set, any command name not listed in &%allow_commands%& must
24698 contain no slashes. The command is searched for only in the directories listed
24699 in the &%path%& option. This option is intended for use in the case when a pipe
24700 command has been generated from a user's &_.forward_& file. This is usually
24701 handled by a &(pipe)& transport called &%address_pipe%&.
24702
24703
24704 .option return_fail_output pipe boolean false
24705 If this option is true, and the command produced any output and ended with a
24706 return code other than zero or one of the codes listed in &%temp_errors%& (that
24707 is, the delivery failed), the output is returned in the bounce message.
24708 However, if the message has a null sender (that is, it is itself a bounce
24709 message), output from the command is discarded. This option and
24710 &%return_output%& are mutually exclusive. Only one of them may be set.
24711
24712
24713
24714 .option return_output pipe boolean false
24715 If this option is true, and the command produced any output, the delivery is
24716 deemed to have failed whatever the return code from the command, and the output
24717 is returned in the bounce message. Otherwise, the output is just discarded.
24718 However, if the message has a null sender (that is, it is a bounce message),
24719 output from the command is always discarded, whatever the setting of this
24720 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24721 of them may be set.
24722
24723
24724
24725 .option temp_errors pipe "string list" "see below"
24726 .cindex "&(pipe)& transport" "temporary failure"
24727 This option contains either a colon-separated list of numbers, or a single
24728 asterisk. If &%ignore_status%& is false
24729 and &%return_output%& is not set,
24730 and the command exits with a non-zero return code, the failure is treated as
24731 temporary and the delivery is deferred if the return code matches one of the
24732 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24733 codes are treated as permanent errors. The default setting contains the codes
24734 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24735 compiled on a system that does not define these macros, it assumes values of 75
24736 and 73, respectively.
24737
24738
24739 .option timeout pipe time 1h
24740 If the command fails to complete within this time, it is killed. This normally
24741 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24742 specifies no timeout. In order to ensure that any subprocesses created by the
24743 command are also killed, Exim makes the initial process a process group leader,
24744 and kills the whole process group on a timeout. However, this can be defeated
24745 if one of the processes starts a new process group.
24746
24747 .option timeout_defer pipe boolean false
24748 A timeout in a &(pipe)& transport, either in the command that the transport
24749 runs, or in a transport filter that is associated with it, is by default
24750 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24751 is set true, both kinds of timeout become temporary errors, causing the
24752 delivery to be deferred.
24753
24754 .option umask pipe "octal integer" 022
24755 This specifies the umask setting for the subprocess that runs the command.
24756
24757
24758 .option use_bsmtp pipe boolean false
24759 .cindex "envelope sender"
24760 If this option is set true, the &(pipe)& transport writes messages in &"batch
24761 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24762 commands. If you want to include a leading HELO command with such messages,
24763 you can do so by setting the &%message_prefix%& option. See section
24764 &<<SECTbatchSMTP>>& for details of batch SMTP.
24765
24766 .option use_classresources pipe boolean false
24767 .cindex "class resources (BSD)"
24768 This option is available only when Exim is running on FreeBSD, NetBSD, or
24769 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24770 resource limits when a &(pipe)& transport is run to perform a delivery. The
24771 limits for the uid under which the pipe is to run are obtained from the login
24772 class database.
24773
24774
24775 .option use_crlf pipe boolean false
24776 .cindex "carriage return"
24777 .cindex "linefeed"
24778 This option causes lines to be terminated with the two-character CRLF sequence
24779 (carriage return, linefeed) instead of just a linefeed character. In the case
24780 of batched SMTP, the byte sequence written to the pipe is then an exact image
24781 of what would be sent down a real SMTP connection.
24782
24783 The contents of the &%message_prefix%& and &%message_suffix%& options are
24784 written verbatim, so must contain their own carriage return characters if these
24785 are needed. When &%use_bsmtp%& is not set, the default values for both
24786 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24787 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24788
24789
24790 .option use_shell pipe boolean false
24791 .vindex "&$pipe_addresses$&"
24792 If this option is set, it causes the command to be passed to &_/bin/sh_&
24793 instead of being run directly from the transport, as described in section
24794 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24795 where the command is expected to be run under a shell and cannot easily be
24796 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24797 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24798 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24799 its &%-c%& option.
24800
24801
24802
24803 .section "Using an external local delivery agent" "SECID143"
24804 .cindex "local delivery" "using an external agent"
24805 .cindex "&'procmail'&"
24806 .cindex "external local delivery"
24807 .cindex "delivery" "&'procmail'&"
24808 .cindex "delivery" "by external agent"
24809 The &(pipe)& transport can be used to pass all messages that require local
24810 delivery to a separate local delivery agent such as &%procmail%&. When doing
24811 this, care must be taken to ensure that the pipe is run under an appropriate
24812 uid and gid. In some configurations one wants this to be a uid that is trusted
24813 by the delivery agent to supply the correct sender of the message. It may be
24814 necessary to recompile or reconfigure the delivery agent so that it trusts an
24815 appropriate user. The following is an example transport and router
24816 configuration for &%procmail%&:
24817 .code
24818 # transport
24819 procmail_pipe:
24820   driver = pipe
24821   command = /usr/local/bin/procmail -d $local_part_data
24822   return_path_add
24823   delivery_date_add
24824   envelope_to_add
24825   check_string = "From "
24826   escape_string = ">From "
24827   umask = 077
24828   user = $local_part_data
24829   group = mail
24830
24831 # router
24832 procmail:
24833   driver = accept
24834   check_local_user
24835   transport = procmail_pipe
24836 .endd
24837 In this example, the pipe is run as the local user, but with the group set to
24838 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24839 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24840 user to supply a correct sender address. If you do not specify either a
24841 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24842 home directory is the user's home directory by default.
24843
24844 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24845 .code
24846 IFS=" "
24847 .endd
24848 as shown in some &%procmail%& documentation, because Exim does not by default
24849 use a shell to run pipe commands.
24850
24851 .cindex "Cyrus"
24852 The next example shows a transport and a router for a system where local
24853 deliveries are handled by the Cyrus IMAP server.
24854 .code
24855 # transport
24856 local_delivery_cyrus:
24857   driver = pipe
24858   command = /usr/cyrus/bin/deliver \
24859             -m ${substr_1:$local_part_suffix} -- $local_part
24860   user = cyrus
24861   group = mail
24862   return_output
24863   log_output
24864   message_prefix =
24865   message_suffix =
24866
24867 # router
24868 local_user_cyrus:
24869   driver = accept
24870   check_local_user
24871   local_part_suffix = .*
24872   transport = local_delivery_cyrus
24873 .endd
24874 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24875 &%return_output%& to cause any text written by Cyrus to be returned to the
24876 sender.
24877 .ecindex IIDpiptra1
24878 .ecindex IIDpiptra2
24879
24880
24881 . ////////////////////////////////////////////////////////////////////////////
24882 . ////////////////////////////////////////////////////////////////////////////
24883
24884 .chapter "The smtp transport" "CHAPsmtptrans"
24885 .scindex IIDsmttra1 "transports" "&(smtp)&"
24886 .scindex IIDsmttra2 "&(smtp)& transport"
24887 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24888 or LMTP protocol. The list of hosts to try can either be taken from the address
24889 that is being processed (having been set up by the router), or specified
24890 explicitly for the transport. Timeout and retry processing (see chapter
24891 &<<CHAPretry>>&) is applied to each IP address independently.
24892
24893
24894 .section "Multiple messages on a single connection" "SECID144"
24895 The sending of multiple messages over a single TCP/IP connection can arise in
24896 two ways:
24897
24898 .ilist
24899 If a message contains more than &%max_rcpt%& (see below) addresses that are
24900 routed to the same host, more than one copy of the message has to be sent to
24901 that host. In this situation, multiple copies may be sent in a single run of
24902 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24903 does when it has too many addresses to send in one message also depends on the
24904 value of the global &%remote_max_parallel%& option. Details are given in
24905 section &<<SECToutSMTPTCP>>&.)
24906 .next
24907 .cindex "hints database" "remembering routing"
24908 When a message has been successfully delivered over a TCP/IP connection, Exim
24909 looks in its hints database to see if there are any other messages awaiting a
24910 connection to the same host. If there are, a new delivery process is started
24911 for one of them, and the current TCP/IP connection is passed on to it. The new
24912 process may in turn send multiple copies and possibly create yet another
24913 process.
24914 .endlist
24915
24916
24917 For each copy sent over the same TCP/IP connection, a sequence counter is
24918 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24919 no further messages are sent over that connection.
24920
24921
24922
24923 .section "Use of the $host and $host_address variables" "SECID145"
24924 .vindex "&$host$&"
24925 .vindex "&$host_address$&"
24926 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24927 &$host_address$& are the name and IP address of the first host on the host list
24928 passed by the router. However, when the transport is about to connect to a
24929 specific host, and while it is connected to that host, &$host$& and
24930 &$host_address$& are set to the values for that host. These are the values
24931 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24932 &%serialize_hosts%&, and the various TLS options are expanded.
24933
24934
24935 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24936 .vindex &$tls_bits$&
24937 .vindex &$tls_cipher$&
24938 .vindex &$tls_peerdn$&
24939 .vindex &$tls_sni$&
24940 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24941 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24942 are the values that were set when the message was received.
24943 These are the values that are used for options that are expanded before any
24944 SMTP connections are made. Just before each connection is made, these four
24945 variables are emptied. If TLS is subsequently started, they are set to the
24946 appropriate values for the outgoing connection, and these are the values that
24947 are in force when any authenticators are run and when the
24948 &%authenticated_sender%& option is expanded.
24949
24950 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24951 and will be removed in a future release.
24952
24953
24954 .section "Private options for smtp" "SECID146"
24955 .cindex "options" "&(smtp)& transport"
24956 The private options of the &(smtp)& transport are as follows:
24957
24958
24959 .option address_retry_include_sender smtp boolean true
24960 .cindex "4&'xx'& responses" "retrying after"
24961 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24962 is the combination of sender and recipient that is delayed in subsequent queue
24963 runs until the retry time is reached. You can delay the recipient without
24964 reference to the sender (which is what earlier versions of Exim did), by
24965 setting &%address_retry_include_sender%& false. However, this can lead to
24966 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24967
24968 .option allow_localhost smtp boolean false
24969 .cindex "local host" "sending to"
24970 .cindex "fallback" "hosts specified on transport"
24971 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24972 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24973 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24974 the delivery anyway. This should be used only in special cases when the
24975 configuration ensures that no looping will result (for example, a differently
24976 configured Exim is listening on the port to which the message is sent).
24977
24978
24979 .option authenticated_sender smtp string&!! unset
24980 .cindex "Cyrus"
24981 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24982 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24983 overriding any existing authenticated sender value. If the string expansion is
24984 forced to fail, the option is ignored. Other expansion failures cause delivery
24985 to be deferred. If the result of expansion is an empty string, that is also
24986 ignored.
24987
24988 The expansion happens after the outgoing connection has been made and TLS
24989 started, if required. This means that the &$host$&, &$host_address$&,
24990 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24991 particular connection.
24992
24993 If the SMTP session is not authenticated, the expansion of
24994 &%authenticated_sender%& still happens (and can cause the delivery to be
24995 deferred if it fails), but no AUTH= item is added to MAIL commands
24996 unless &%authenticated_sender_force%& is true.
24997
24998 This option allows you to use the &(smtp)& transport in LMTP mode to
24999 deliver mail to Cyrus IMAP and provide the proper local part as the
25000 &"authenticated sender"&, via a setting such as:
25001 .code
25002 authenticated_sender = $local_part
25003 .endd
25004 This removes the need for IMAP subfolders to be assigned special ACLs to
25005 allow direct delivery to those subfolders.
25006
25007 Because of expected uses such as that just described for Cyrus (when no
25008 domain is involved), there is no checking on the syntax of the provided
25009 value.
25010
25011
25012 .option authenticated_sender_force smtp boolean false
25013 If this option is set true, the &%authenticated_sender%& option's value
25014 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25015 authenticated as a client.
25016
25017
25018 .option command_timeout smtp time 5m
25019 This sets a timeout for receiving a response to an SMTP command that has been
25020 sent out. It is also used when waiting for the initial banner line from the
25021 remote host. Its value must not be zero.
25022
25023
25024 .option connect_timeout smtp time 5m
25025 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25026 to a remote host. A setting of zero allows the system timeout (typically
25027 several minutes) to act. To have any effect, the value of this option must be
25028 less than the system timeout. However, it has been observed that on some
25029 systems there is no system timeout, which is why the default value for this
25030 option is 5 minutes, a value recommended by RFC 1123.
25031
25032
25033 .option connection_max_messages smtp integer 500
25034 .cindex "SMTP" "passed connection"
25035 .cindex "SMTP" "multiple deliveries"
25036 .cindex "multiple SMTP deliveries"
25037 This controls the maximum number of separate message deliveries that are sent
25038 over a single TCP/IP connection. If the value is zero, there is no limit.
25039 For testing purposes, this value can be overridden by the &%-oB%& command line
25040 option.
25041
25042
25043 .option dane_require_tls_ciphers smtp string&!! unset
25044 .cindex "TLS" "requiring specific ciphers for DANE"
25045 .cindex "cipher" "requiring specific"
25046 .cindex DANE "TLS ciphers"
25047 This option may be used to override &%tls_require_ciphers%& for connections
25048 where DANE has been determined to be in effect.
25049 If not set, then &%tls_require_ciphers%& will be used.
25050 Normal SMTP delivery is not able to make strong demands of TLS cipher
25051 configuration, because delivery will fall back to plaintext.  Once DANE has
25052 been determined to be in effect, there is no plaintext fallback and making the
25053 TLS cipherlist configuration stronger will increase security, rather than
25054 counter-intuitively decreasing it.
25055 If the option expands to be empty or is forced to fail, then it will
25056 be treated as unset and &%tls_require_ciphers%& will be used instead.
25057
25058
25059 .option data_timeout smtp time 5m
25060 This sets a timeout for the transmission of each block in the data portion of
25061 the message. As a result, the overall timeout for a message depends on the size
25062 of the message. Its value must not be zero. See also &%final_timeout%&.
25063
25064
25065 .option dkim_canon smtp string&!! unset
25066 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25067 .option dkim_domain smtp string list&!! unset
25068 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25069 .option dkim_hash smtp string&!! sha256
25070 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25071 .option dkim_identity smtp string&!! unset
25072 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25073 .option dkim_private_key smtp string&!! unset
25074 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25075 .option dkim_selector smtp string&!! unset
25076 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25077 .option dkim_strict smtp string&!! unset
25078 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25079 .option dkim_sign_headers smtp string&!! "per RFC"
25080 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25081 .option dkim_timestamps smtp string&!! unset
25082 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25083
25084
25085 .option delay_after_cutoff smtp boolean true
25086 .cindex "final cutoff" "retries, controlling"
25087 .cindex retry "final cutoff"
25088 This option controls what happens when all remote IP addresses for a given
25089 domain have been inaccessible for so long that they have passed their retry
25090 cutoff times.
25091
25092 In the default state, if the next retry time has not been reached for any of
25093 them, the address is bounced without trying any deliveries. In other words,
25094 Exim delays retrying an IP address after the final cutoff time until a new
25095 retry time is reached, and can therefore bounce an address without ever trying
25096 a delivery, when machines have been down for a long time. Some people are
25097 unhappy at this prospect, so...
25098
25099 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25100 addresses are past their final cutoff time, Exim tries to deliver to those
25101 IP addresses that have not been tried since the message arrived. If there are
25102 none, of if they all fail, the address is bounced. In other words, it does not
25103 delay when a new message arrives, but immediately tries those expired IP
25104 addresses that haven't been tried since the message arrived. If there is a
25105 continuous stream of messages for the dead hosts, unsetting
25106 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25107 to them.
25108
25109
25110 .option dns_qualify_single smtp boolean true
25111 If the &%hosts%& or &%fallback_hosts%& option is being used,
25112 and the &%gethostbyname%& option is false,
25113 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25114 in chapter &<<CHAPdnslookup>>& for more details.
25115
25116
25117 .option dns_search_parents smtp boolean false
25118 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25119 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25120 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25121 details.
25122
25123
25124 .option dnssec_request_domains smtp "domain list&!!" *
25125 .cindex "MX record" "security"
25126 .cindex "DNSSEC" "MX lookup"
25127 .cindex "security" "MX lookup"
25128 .cindex "DNS" "DNSSEC"
25129 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25130 the dnssec request bit set. Setting this transport option is only useful if the
25131 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25132 router option.
25133
25134
25135
25136 .option dnssec_require_domains smtp "domain list&!!" unset
25137 .cindex "MX record" "security"
25138 .cindex "DNSSEC" "MX lookup"
25139 .cindex "security" "MX lookup"
25140 .cindex "DNS" "DNSSEC"
25141 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25142 the dnssec request bit set.  Setting this transport option is only
25143 useful if the transport overrides or sets the host names. See the
25144 &%dnssec_require_domains%& router option.
25145
25146
25147
25148 .option dscp smtp string&!! unset
25149 .cindex "DCSP" "outbound"
25150 This option causes the DSCP value associated with a socket to be set to one
25151 of a number of fixed strings or to numeric value.
25152 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25153 Common values include &`throughput`&, &`mincost`&, and on newer systems
25154 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25155
25156 The outbound packets from Exim will be marked with this value in the header
25157 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25158 that these values will have any effect, not be stripped by networking
25159 equipment, or do much of anything without cooperation with your Network
25160 Engineer and those of all network operators between the source and destination.
25161
25162
25163 .option fallback_hosts smtp "string list" unset
25164 .cindex "fallback" "hosts specified on transport"
25165 String expansion is not applied to this option. The argument must be a
25166 colon-separated list of host names or IP addresses, optionally also including
25167 port numbers, though the separator can be changed, as described in section
25168 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25169 item in a &%route_list%& setting for the &(manualroute)& router, as described
25170 in section &<<SECTformatonehostitem>>&.
25171
25172 Fallback hosts can also be specified on routers, which associate them with the
25173 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25174 &%fallback_hosts%& specified on the transport is used only if the address does
25175 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25176 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25177 However, &%hosts_randomize%& does apply to fallback host lists.
25178
25179 If Exim is unable to deliver to any of the hosts for a particular address, and
25180 the errors are not permanent rejections, the address is put on a separate
25181 transport queue with its host list replaced by the fallback hosts, unless the
25182 address was routed via MX records and the current host was in the original MX
25183 list. In that situation, the fallback host list is not used.
25184
25185 Once normal deliveries are complete, the fallback queue is delivered by
25186 re-running the same transports with the new host lists. If several failing
25187 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25188 copy of the message is sent.
25189
25190 The resolution of the host names on the fallback list is controlled by the
25191 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25192 both to cases when the host list comes with the address and when it is taken
25193 from &%hosts%&. This option provides a &"use a smart host only if delivery
25194 fails"& facility.
25195
25196
25197 .option final_timeout smtp time 10m
25198 This is the timeout that applies while waiting for the response to the final
25199 line containing just &"."& that terminates a message. Its value must not be
25200 zero.
25201
25202 .option gethostbyname smtp boolean false
25203 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25204 being used, names are looked up using &[gethostbyname()]&
25205 (or &[getipnodebyname()]& when available)
25206 instead of using the DNS. Of course, that function may in fact use the DNS, but
25207 it may also consult other sources of information such as &_/etc/hosts_&.
25208
25209 .option gnutls_compat_mode smtp boolean unset
25210 This option controls whether GnuTLS is used in compatibility mode in an Exim
25211 server. This reduces security slightly, but improves interworking with older
25212 implementations of TLS.
25213
25214 .option helo_data smtp string&!! "see below"
25215 .cindex "HELO" "argument, setting"
25216 .cindex "EHLO" "argument, setting"
25217 .cindex "LHLO argument setting"
25218 The value of this option is expanded after a connection to a another host has
25219 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25220 command that starts the outgoing SMTP or LMTP session. The default value of the
25221 option is:
25222 .code
25223 $primary_hostname
25224 .endd
25225 During the expansion, the variables &$host$& and &$host_address$& are set to
25226 the identity of the remote host, and the variables &$sending_ip_address$& and
25227 &$sending_port$& are set to the local IP address and port number that are being
25228 used. These variables can be used to generate different values for different
25229 servers or different local IP addresses. For example, if you want the string
25230 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25231 interface address, you could use this:
25232 .code
25233 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25234   {$primary_hostname}}
25235 .endd
25236 The use of &%helo_data%& applies both to sending messages and when doing
25237 callouts.
25238
25239 .option hosts smtp "string list&!!" unset
25240 Hosts are associated with an address by a router such as &(dnslookup)&, which
25241 finds the hosts by looking up the address domain in the DNS, or by
25242 &(manualroute)&, which has lists of hosts in its configuration. However,
25243 email addresses can be passed to the &(smtp)& transport by any router, and not
25244 all of them can provide an associated list of hosts.
25245
25246 The &%hosts%& option specifies a list of hosts to be used if the address being
25247 processed does not have any hosts associated with it. The hosts specified by
25248 &%hosts%& are also used, whether or not the address has its own hosts, if
25249 &%hosts_override%& is set.
25250
25251 The string is first expanded, before being interpreted as a colon-separated
25252 list of host names or IP addresses, possibly including port numbers. The
25253 separator may be changed to something other than colon, as described in section
25254 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25255 item in a &%route_list%& setting for the &(manualroute)& router, as described
25256 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25257 of the &(manualroute)& router is not available here.
25258
25259 If the expansion fails, delivery is deferred. Unless the failure was caused by
25260 the inability to complete a lookup, the error is logged to the panic log as
25261 well as the main log. Host names are looked up either by searching directly for
25262 address records in the DNS or by calling &[gethostbyname()]& (or
25263 &[getipnodebyname()]& when available), depending on the setting of the
25264 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25265 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25266 address are used.
25267
25268 During delivery, the hosts are tried in order, subject to their retry status,
25269 unless &%hosts_randomize%& is set.
25270
25271
25272 .option hosts_avoid_esmtp smtp "host list&!!" unset
25273 .cindex "ESMTP, avoiding use of"
25274 .cindex "HELO" "forcing use of"
25275 .cindex "EHLO" "avoiding use of"
25276 .cindex "PIPELINING" "avoiding the use of"
25277 This option is for use with broken hosts that announce ESMTP facilities (for
25278 example, PIPELINING) and then fail to implement them properly. When a host
25279 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25280 start of the SMTP session. This means that it cannot use any of the ESMTP
25281 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25282
25283
25284 .option hosts_avoid_pipelining smtp "host list&!!" unset
25285 .cindex "PIPELINING" "avoiding the use of"
25286 .cindex "ESMTP extensions" PIPELINING
25287 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25288 that matches this list, even if the server host advertises PIPELINING support.
25289
25290 .option hosts_pipe_connect smtp "host list&!!" unset
25291 .cindex "pipelining" "early connection"
25292 .cindex "pipelining" PIPE_CONNECT
25293 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25294 this option controls which to hosts the facility watched for
25295 and recorded, and used for subsequent connections.
25296
25297 The retry hints database is used for the record,
25298 and records are subject to the &%retry_data_expire%& option.
25299 When used, the pipelining saves on roundtrip times.
25300 It also turns SMTP into a client-first protocol
25301 so combines well with TCP Fast Open.
25302
25303 See also the &%pipelining_connect_advertise_hosts%& main option.
25304
25305 Note:
25306 When the facility is used, the transport &%helo_data%& option
25307 will be expanded before the &$sending_ip_address$& variable
25308 is filled in.
25309 A check is made for the use of that variable, without the
25310 presence of a &"def:"& test on it, but suitably complex coding
25311 can avoid the check and produce unexpected results.
25312 You have been warned.
25313
25314
25315 .option hosts_avoid_tls smtp "host list&!!" unset
25316 .cindex "TLS" "avoiding for certain hosts"
25317 Exim will not try to start a TLS session when delivering to any host that
25318 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25319
25320 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25321 .cindex "TLS" "avoiding for certain hosts"
25322 Exim will not try to start a TLS session for a verify callout,
25323 or when delivering in cutthrough mode,
25324 to any host that matches this list.
25325
25326
25327 .option hosts_max_try smtp integer 5
25328 .cindex "host" "maximum number to try"
25329 .cindex "limit" "number of hosts tried"
25330 .cindex "limit" "number of MX tried"
25331 .cindex "MX record" "maximum tried"
25332 This option limits the number of IP addresses that are tried for any one
25333 delivery in cases where there are temporary delivery errors. Section
25334 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25335
25336
25337 .option hosts_max_try_hardlimit smtp integer 50
25338 This is an additional check on the maximum number of IP addresses that Exim
25339 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25340 why it exists.
25341
25342
25343
25344 .option hosts_nopass_tls smtp "host list&!!" unset
25345 .cindex "TLS" "passing connection"
25346 .cindex "multiple SMTP deliveries"
25347 .cindex "TLS" "multiple message deliveries"
25348 For any host that matches this list, a connection on which a TLS session has
25349 been started will not be passed to a new delivery process for sending another
25350 message on the same connection. See section &<<SECTmulmessam>>& for an
25351 explanation of when this might be needed.
25352
25353 .option hosts_noproxy_tls smtp "host list&!!" unset
25354 .cindex "TLS" "passing connection"
25355 .cindex "multiple SMTP deliveries"
25356 .cindex "TLS" "multiple message deliveries"
25357 For any host that matches this list, a TLS session which has
25358 been started will not be passed to a new delivery process for sending another
25359 message on the same session.
25360
25361 The traditional implementation closes down TLS and re-starts it in the new
25362 process, on the same open TCP connection, for each successive message
25363 sent.  If permitted by this option a pipe to to the new process is set up
25364 instead, and the original process maintains the TLS connection and proxies
25365 the SMTP connection from and to the new process and any subsequents.
25366 The new process has no access to TLS information, so cannot include it in
25367 logging.
25368
25369
25370
25371 .option hosts_override smtp boolean false
25372 If this option is set and the &%hosts%& option is also set, any hosts that are
25373 attached to the address are ignored, and instead the hosts specified by the
25374 &%hosts%& option are always used. This option does not apply to
25375 &%fallback_hosts%&.
25376
25377
25378 .option hosts_randomize smtp boolean false
25379 .cindex "randomized host list"
25380 .cindex "host" "list of; randomized"
25381 .cindex "fallback" "randomized hosts"
25382 If this option is set, and either the list of hosts is taken from the
25383 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25384 were not obtained from MX records (this includes fallback hosts from the
25385 router), and were not randomized by the router, the order of trying the hosts
25386 is randomized each time the transport runs. Randomizing the order of a host
25387 list can be used to do crude load sharing.
25388
25389 When &%hosts_randomize%& is true, a host list may be split into groups whose
25390 order is separately randomized. This makes it possible to set up MX-like
25391 behaviour. The boundaries between groups are indicated by an item that is just
25392 &`+`& in the host list. For example:
25393 .code
25394 hosts = host1:host2:host3:+:host4:host5
25395 .endd
25396 The order of the first three hosts and the order of the last two hosts is
25397 randomized for each use, but the first three always end up before the last two.
25398 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25399
25400 .option hosts_require_auth smtp "host list&!!" unset
25401 .cindex "authentication" "required by client"
25402 This option provides a list of servers for which authentication must succeed
25403 before Exim will try to transfer a message. If authentication fails for
25404 servers which are not in this list, Exim tries to send unauthenticated. If
25405 authentication fails for one of these servers, delivery is deferred. This
25406 temporary error is detectable in the retry rules, so it can be turned into a
25407 hard failure if required. See also &%hosts_try_auth%&, and chapter
25408 &<<CHAPSMTPAUTH>>& for details of authentication.
25409
25410
25411 .option hosts_request_ocsp smtp "host list&!!" *
25412 .cindex "TLS" "requiring for certain servers"
25413 Exim will request a Certificate Status on a
25414 TLS session for any host that matches this list.
25415 &%tls_verify_certificates%& should also be set for the transport.
25416
25417 .option hosts_require_dane smtp "host list&!!" unset
25418 .cindex DANE "transport options"
25419 .cindex DANE "requiring for certain servers"
25420 If built with DANE support, Exim  will require that a DNSSEC-validated
25421 TLSA record is present for any host matching the list,
25422 and that a DANE-verified TLS connection is made. See
25423 the &%dnssec_request_domains%& router and transport options.
25424 There will be no fallback to in-clear communication.
25425 See section &<<SECDANE>>&.
25426
25427 .option hosts_require_ocsp smtp "host list&!!" unset
25428 .cindex "TLS" "requiring for certain servers"
25429 Exim will request, and check for a valid Certificate Status being given, on a
25430 TLS session for any host that matches this list.
25431 &%tls_verify_certificates%& should also be set for the transport.
25432
25433 .option hosts_require_tls smtp "host list&!!" unset
25434 .cindex "TLS" "requiring for certain servers"
25435 Exim will insist on using a TLS session when delivering to any host that
25436 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25437 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25438 incoming messages, use an appropriate ACL.
25439
25440 .option hosts_try_auth smtp "host list&!!" unset
25441 .cindex "authentication" "optional in client"
25442 This option provides a list of servers to which, provided they announce
25443 authentication support, Exim will attempt to authenticate as a client when it
25444 connects. If authentication fails, Exim will try to transfer the message
25445 unauthenticated. See also &%hosts_require_auth%&, and chapter
25446 &<<CHAPSMTPAUTH>>& for details of authentication.
25447
25448 .option hosts_try_chunking smtp "host list&!!" *
25449 .cindex CHUNKING "enabling, in client"
25450 .cindex BDAT "SMTP command"
25451 .cindex "RFC 3030" "CHUNKING"
25452 This option provides a list of servers to which, provided they announce
25453 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25454 Unless DKIM signing is being done,
25455 BDAT will not be used in conjunction with a transport filter.
25456
25457 .option hosts_try_dane smtp "host list&!!" *
25458 .cindex DANE "transport options"
25459 .cindex DANE "attempting for certain servers"
25460 If built with DANE support, Exim  will require that a DNSSEC-validated
25461 TLSA record is present for any host matching the list,
25462 and that a DANE-verified TLS connection is made. See
25463 the &%dnssec_request_domains%& router and transport options.
25464 There will be no fallback to in-clear communication.
25465 See section &<<SECDANE>>&.
25466
25467 .option hosts_try_fastopen smtp "host list&!!" *
25468 .cindex "fast open, TCP" "enabling, in client"
25469 .cindex "TCP Fast Open" "enabling, in client"
25470 .cindex "RFC 7413" "TCP Fast Open"
25471 This option provides a list of servers to which, provided
25472 the facility is supported by this system, Exim will attempt to
25473 perform a TCP Fast Open.
25474 No data is sent on the SYN segment but, if the remote server also
25475 supports the facility, it can send its SMTP banner immediately after
25476 the SYN,ACK segment.  This can save up to one round-trip time.
25477
25478 The facility is only active for previously-contacted servers,
25479 as the initiator must present a cookie in the SYN segment.
25480
25481 On (at least some) current Linux distributions the facility must be enabled
25482 in the kernel by the sysadmin before the support is usable.
25483 There is no option for control of the server side; if the system supports
25484 it it is always enabled.  Note that lengthy operations in the connect ACL,
25485 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25486
25487 .option hosts_try_prdr smtp "host list&!!" *
25488 .cindex "PRDR" "enabling, optional in client"
25489 .cindex "ESMTP extensions" PRDR
25490 This option provides a list of servers to which, provided they announce
25491 PRDR support, Exim will attempt to negotiate PRDR
25492 for multi-recipient messages.
25493 The option can usually be left as default.
25494
25495 .option interface smtp "string list&!!" unset
25496 .cindex "bind IP address"
25497 .cindex "IP address" "binding"
25498 .vindex "&$host$&"
25499 .vindex "&$host_address$&"
25500 This option specifies which interface to bind to when making an outgoing SMTP
25501 call. The value is an IP address, not an interface name such as
25502 &`eth0`&. Do not confuse this with the interface address that was used when a
25503 message was received, which is in &$received_ip_address$&, formerly known as
25504 &$interface_address$&. The name was changed to minimize confusion with the
25505 outgoing interface address. There is no variable that contains an outgoing
25506 interface address because, unless it is set by this option, its value is
25507 unknown.
25508
25509 During the expansion of the &%interface%& option the variables &$host$& and
25510 &$host_address$& refer to the host to which a connection is about to be made
25511 during the expansion of the string. Forced expansion failure, or an empty
25512 string result causes the option to be ignored. Otherwise, after expansion, the
25513 string must be a list of IP addresses, colon-separated by default, but the
25514 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25515 For example:
25516 .code
25517 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25518 .endd
25519 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25520 connection. If none of them are the correct type, the option is ignored. If
25521 &%interface%& is not set, or is ignored, the system's IP functions choose which
25522 interface to use if the host has more than one.
25523
25524
25525 .option keepalive smtp boolean true
25526 .cindex "keepalive" "on outgoing connection"
25527 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25528 connections. When set, it causes the kernel to probe idle connections
25529 periodically, by sending packets with &"old"& sequence numbers. The other end
25530 of the connection should send a acknowledgment if the connection is still okay
25531 or a reset if the connection has been aborted. The reason for doing this is
25532 that it has the beneficial effect of freeing up certain types of connection
25533 that can get stuck when the remote host is disconnected without tidying up the
25534 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25535 unreachable hosts.
25536
25537
25538 .option lmtp_ignore_quota smtp boolean false
25539 .cindex "LMTP" "ignoring quota errors"
25540 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25541 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25542 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25543
25544 .option max_rcpt smtp integer 100
25545 .cindex "RCPT" "maximum number of outgoing"
25546 This option limits the number of RCPT commands that are sent in a single
25547 SMTP message transaction. Each set of addresses is treated independently, and
25548 so can cause parallel connections to the same host if &%remote_max_parallel%&
25549 permits this.
25550
25551
25552 .new
25553 .option message_linelength_limit smtp integer 998
25554 .cindex "line length" limit
25555 This option sets the maximum line length, in bytes, that the transport
25556 will send.  Any messages with lines exceeding the given value
25557 will fail and a failure-DSN ("bounce") message will if possible be returned
25558 to the sender.
25559 The default value is that defined by the SMTP standards.
25560
25561 It is generally wise to also check in the data ACL so that messages
25562 received via SMTP can be refused without producing a bounce.
25563 .wen
25564
25565
25566 .option multi_domain smtp boolean&!! true
25567 .vindex "&$domain$&"
25568 When this option is set, the &(smtp)& transport can handle a number of
25569 addresses containing a mixture of different domains provided they all resolve
25570 to the same list of hosts. Turning the option off restricts the transport to
25571 handling only one domain at a time. This is useful if you want to use
25572 &$domain$& in an expansion for the transport, because it is set only when there
25573 is a single domain involved in a remote delivery.
25574
25575 It is expanded per-address and can depend on any of
25576 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25577 &$host$&, &$host_address$& and &$host_port$&.
25578
25579 .option port smtp string&!! "see below"
25580 .cindex "port" "sending TCP/IP"
25581 .cindex "TCP/IP" "setting outgoing port"
25582 This option specifies the TCP/IP port on the server to which Exim connects.
25583 &*Note:*& Do not confuse this with the port that was used when a message was
25584 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25585 The name was changed to minimize confusion with the outgoing port. There is no
25586 variable that contains an outgoing port.
25587
25588 If the value of this option begins with a digit it is taken as a port number;
25589 otherwise it is looked up using &[getservbyname()]&. The default value is
25590 normally &"smtp"&,
25591 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25592 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25593 If the expansion fails, or if a port number cannot be found, delivery
25594 is deferred.
25595
25596 Note that at least one Linux distribution has been seen failing
25597 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25598
25599
25600
25601 .option protocol smtp string smtp
25602 .cindex "LMTP" "over TCP/IP"
25603 .cindex "ssmtp protocol" "outbound"
25604 .cindex "TLS" "SSL-on-connect outbound"
25605 .vindex "&$port$&"
25606 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25607 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25608 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25609 deliveries into closed message stores. Exim also has support for running LMTP
25610 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25611
25612 If this option is set to &"smtps"&, the default value for the &%port%& option
25613 changes to &"smtps"&, and the transport initiates TLS immediately after
25614 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25615 The Internet standards bodies used to strongly discourage use of this mode,
25616 but as of RFC 8314 it is perferred over STARTTLS for message submission
25617 (as distinct from MTA-MTA communication).
25618
25619
25620 .option retry_include_ip_address smtp boolean&!! true
25621 Exim normally includes both the host name and the IP address in the key it
25622 constructs for indexing retry data after a temporary delivery failure. This
25623 means that when one of several IP addresses for a host is failing, it gets
25624 tried periodically (controlled by the retry rules), but use of the other IP
25625 addresses is not affected.
25626
25627 However, in some dialup environments hosts are assigned a different IP address
25628 each time they connect. In this situation the use of the IP address as part of
25629 the retry key leads to undesirable behaviour. Setting this option false causes
25630 Exim to use only the host name.
25631 Since it is expanded it can be made to depend on the host or domain.
25632
25633
25634 .option serialize_hosts smtp "host list&!!" unset
25635 .cindex "serializing connections"
25636 .cindex "host" "serializing connections"
25637 Because Exim operates in a distributed manner, if several messages for the same
25638 host arrive at around the same time, more than one simultaneous connection to
25639 the remote host can occur. This is not usually a problem except when there is a
25640 slow link between the hosts. In that situation it may be helpful to restrict
25641 Exim to one connection at a time. This can be done by setting
25642 &%serialize_hosts%& to match the relevant hosts.
25643
25644 .cindex "hints database" "serializing deliveries to a host"
25645 Exim implements serialization by means of a hints database in which a record is
25646 written whenever a process connects to one of the restricted hosts. The record
25647 is deleted when the connection is completed. Obviously there is scope for
25648 records to get left lying around if there is a system or program crash. To
25649 guard against this, Exim ignores any records that are more than six hours old.
25650
25651 If you set up this kind of serialization, you should also arrange to delete the
25652 relevant hints database whenever your system reboots. The names of the files
25653 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25654 may be one or two files, depending on the type of DBM in use. The same files
25655 are used for ETRN serialization.
25656
25657 See also the &%max_parallel%& generic transport option.
25658
25659
25660 .option size_addition smtp integer 1024
25661 .cindex "SIZE" "ESMTP extension"
25662 .cindex "message" "size issue for transport filter"
25663 .cindex "size" "of message"
25664 .cindex "transport" "filter"
25665 .cindex "filter" "transport filter"
25666 If a remote SMTP server indicates that it supports the SIZE option of the
25667 MAIL command, Exim uses this to pass over the message size at the start of
25668 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25669 sends, to allow for headers and other text that may be added during delivery by
25670 configuration options or in a transport filter. It may be necessary to increase
25671 this if a lot of text is added to messages.
25672
25673 Alternatively, if the value of &%size_addition%& is set negative, it disables
25674 the use of the SIZE option altogether.
25675
25676
25677 .option socks_proxy smtp string&!! unset
25678 .cindex proxy SOCKS
25679 This option enables use of SOCKS proxies for connections made by the
25680 transport.  For details see section &<<SECTproxySOCKS>>&.
25681
25682
25683 .option tls_certificate smtp string&!! unset
25684 .cindex "TLS" "client certificate, location of"
25685 .cindex "certificate" "client, location of"
25686 .vindex "&$host$&"
25687 .vindex "&$host_address$&"
25688 The value of this option must be the absolute path to a file which contains the
25689 client's certificate, for possible use when sending a message over an encrypted
25690 connection. The values of &$host$& and &$host_address$& are set to the name and
25691 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25692 details of TLS.
25693
25694 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25695 certificate when sending messages as a client. The global option of the same
25696 name specifies the certificate for Exim as a server; it is not automatically
25697 assumed that the same certificate should be used when Exim is operating as a
25698 client.
25699
25700
25701 .option tls_crl smtp string&!! unset
25702 .cindex "TLS" "client certificate revocation list"
25703 .cindex "certificate" "revocation list for client"
25704 This option specifies a certificate revocation list. The expanded value must
25705 be the name of a file that contains a CRL in PEM format.
25706
25707
25708 .option tls_dh_min_bits smtp integer 1024
25709 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25710 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25711 key agreement is negotiated, the server will provide a large prime number
25712 for use.  This option establishes the minimum acceptable size of that number.
25713 If the parameter offered by the server is too small, then the TLS handshake
25714 will fail.
25715
25716 Only supported when using GnuTLS.
25717
25718
25719 .option tls_privatekey smtp string&!! unset
25720 .cindex "TLS" "client private key, location of"
25721 .vindex "&$host$&"
25722 .vindex "&$host_address$&"
25723 The value of this option must be the absolute path to a file which contains the
25724 client's private key. This is used when sending a message over an encrypted
25725 connection using a client certificate. The values of &$host$& and
25726 &$host_address$& are set to the name and address of the server during the
25727 expansion. If this option is unset, or the expansion is forced to fail, or the
25728 result is an empty string, the private key is assumed to be in the same file as
25729 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25730
25731
25732 .option tls_require_ciphers smtp string&!! unset
25733 .cindex "TLS" "requiring specific ciphers"
25734 .cindex "cipher" "requiring specific"
25735 .vindex "&$host$&"
25736 .vindex "&$host_address$&"
25737 The value of this option must be a list of permitted cipher suites, for use
25738 when setting up an outgoing encrypted connection. (There is a global option of
25739 the same name for controlling incoming connections.) The values of &$host$& and
25740 &$host_address$& are set to the name and address of the server during the
25741 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25742 is used in different ways by OpenSSL and GnuTLS (see sections
25743 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25744 ciphers is a preference order.
25745
25746
25747 .new
25748 .option tls_resumption_hosts smtp "host list&!!" unset
25749 .cindex TLS resumption
25750 This option controls which connections to use the TLS resumption feature.
25751 See &<<SECTresumption>>& for details.
25752 .wen
25753
25754
25755
25756 .option tls_sni smtp string&!! unset
25757 .cindex "TLS" "Server Name Indication"
25758 .cindex "TLS" SNI
25759 .cindex SNI "setting in client"
25760 .vindex "&$tls_sni$&"
25761 If this option is set then it sets the $tls_out_sni variable and causes any
25762 TLS session to pass this value as the Server Name Indication extension to
25763 the remote side, which can be used by the remote side to select an appropriate
25764 certificate and private key for the session.
25765
25766 See &<<SECTtlssni>>& for more information.
25767
25768 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25769 TLS extensions.
25770
25771
25772
25773
25774 .option tls_tempfail_tryclear smtp boolean true
25775 .cindex "4&'xx'& responses" "to STARTTLS"
25776 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25777 setting up a TLS session, this option determines whether or not Exim should try
25778 to deliver the message unencrypted. If it is set false, delivery to the
25779 current host is deferred; if there are other hosts, they are tried. If this
25780 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25781 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25782 TLS negotiation fails, Exim closes the current connection (because it is in an
25783 unknown state), opens a new one to the same host, and then tries the delivery
25784 in clear.
25785
25786
25787 .option tls_try_verify_hosts smtp "host list&!!" *
25788 .cindex "TLS" "server certificate verification"
25789 .cindex "certificate" "verification of server"
25790 This option gives a list of hosts for which, on encrypted connections,
25791 certificate verification will be tried but need not succeed.
25792 The &%tls_verify_certificates%& option must also be set.
25793 Note that unless the host is in this list
25794 TLS connections will be denied to hosts using self-signed certificates
25795 when &%tls_verify_certificates%& is matched.
25796 The &$tls_out_certificate_verified$& variable is set when
25797 certificate verification succeeds.
25798
25799
25800 .option tls_verify_cert_hostnames smtp "host list&!!" *
25801 .cindex "TLS" "server certificate hostname verification"
25802 .cindex "certificate" "verification of server"
25803 This option give a list of hosts for which,
25804 while verifying the server certificate,
25805 checks will be included on the host name
25806 (note that this will generally be the result of a DNS MX lookup)
25807 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25808 limited to being the initial component of a 3-or-more component FQDN.
25809
25810 There is no equivalent checking on client certificates.
25811
25812
25813 .option tls_verify_certificates smtp string&!! system
25814 .cindex "TLS" "server certificate verification"
25815 .cindex "certificate" "verification of server"
25816 .vindex "&$host$&"
25817 .vindex "&$host_address$&"
25818 The value of this option must be either the
25819 word "system"
25820 or the absolute path to
25821 a file or directory containing permitted certificates for servers,
25822 for use when setting up an encrypted connection.
25823
25824 The "system" value for the option will use a location compiled into the SSL library.
25825 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25826 is taken as empty and an explicit location
25827 must be specified.
25828
25829 The use of a directory for the option value is not available for GnuTLS versions
25830 preceding 3.3.6 and a single file must be used.
25831
25832 With OpenSSL the certificates specified
25833 explicitly
25834 either by file or directory
25835 are added to those given by the system default location.
25836
25837 The values of &$host$& and
25838 &$host_address$& are set to the name and address of the server during the
25839 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25840
25841 For back-compatibility,
25842 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25843 (a single-colon empty list counts as being set)
25844 and certificate verification fails the TLS connection is closed.
25845
25846
25847 .option tls_verify_hosts smtp "host list&!!" unset
25848 .cindex "TLS" "server certificate verification"
25849 .cindex "certificate" "verification of server"
25850 This option gives a list of hosts for which, on encrypted connections,
25851 certificate verification must succeed.
25852 The &%tls_verify_certificates%& option must also be set.
25853 If both this option and &%tls_try_verify_hosts%& are unset
25854 operation is as if this option selected all hosts.
25855
25856 .option utf8_downconvert smtp integer&!! -1
25857 .cindex utf8 "address downconversion"
25858 .cindex i18n "utf8 address downconversion"
25859 If built with internationalization support,
25860 this option controls conversion of UTF-8 in message envelope addresses
25861 to a-label form.
25862 If, after expansion, the value is 1, 0, or -1 then this value overrides
25863 any value previously set for the message.  Otherwise, any previously
25864 set value is used.  To permit use of a previous value,
25865 set this option to an empty string.
25866 For details on the values see section &<<SECTi18nMTA>>&.
25867
25868
25869
25870
25871 .section "How the limits for the number of hosts to try are used" &&&
25872          "SECTvalhosmax"
25873 .cindex "host" "maximum number to try"
25874 .cindex "limit" "hosts; maximum number tried"
25875 There are two options that are concerned with the number of hosts that are
25876 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25877 &%hosts_max_try_hardlimit%&.
25878
25879
25880 The &%hosts_max_try%& option limits the number of hosts that are tried
25881 for a single delivery. However, despite the term &"host"& in its name, the
25882 option actually applies to each IP address independently. In other words, a
25883 multihomed host is treated as several independent hosts, just as it is for
25884 retrying.
25885
25886 Many of the larger ISPs have multiple MX records which often point to
25887 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25888 created as a result of routing one of these domains.
25889
25890 Trying every single IP address on such a long list does not seem sensible; if
25891 several at the top of the list fail, it is reasonable to assume there is some
25892 problem that is likely to affect all of them. Roughly speaking, the value of
25893 &%hosts_max_try%& is the maximum number that are tried before deferring the
25894 delivery. However, the logic cannot be quite that simple.
25895
25896 Firstly, IP addresses that are skipped because their retry times have not
25897 arrived do not count, and in addition, addresses that are past their retry
25898 limits are also not counted, even when they are tried. This means that when
25899 some IP addresses are past their retry limits, more than the value of
25900 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25901 that all IP addresses are considered before timing out an email address (but
25902 see below for an exception).
25903
25904 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25905 list to see if there is a subsequent host with a different (higher valued) MX.
25906 If there is, that host is considered next, and the current IP address is used
25907 but not counted. This behaviour helps in the case of a domain with a retry rule
25908 that hardly ever delays any hosts, as is now explained:
25909
25910 Consider the case of a long list of hosts with one MX value, and a few with a
25911 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25912 hosts at the top of the list are tried at first. With the default retry rule,
25913 which specifies increasing retry times, the higher MX hosts are eventually
25914 tried when those at the top of the list are skipped because they have not
25915 reached their retry times.
25916
25917 However, it is common practice to put a fixed short retry time on domains for
25918 large ISPs, on the grounds that their servers are rarely down for very long.
25919 Unfortunately, these are exactly the domains that tend to resolve to long lists
25920 of hosts. The short retry time means that the lowest MX hosts are tried every
25921 time. The attempts may be in a different order because of random sorting, but
25922 without the special MX check, the higher MX hosts would never be tried until
25923 all the lower MX hosts had timed out (which might be several days), because
25924 there are always some lower MX hosts that have reached their retry times. With
25925 the special check, Exim considers at least one IP address from each MX value at
25926 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25927 reached.
25928
25929 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25930 particular, Exim normally eventually tries all the IP addresses before timing
25931 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25932 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25933 been set up with hundreds of IP addresses for some domains. It can
25934 take a very long time indeed for an address to time out in these cases.
25935
25936 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25937 Exim never tries more than this number of IP addresses; if it hits this limit
25938 and they are all timed out, the email address is bounced, even though not all
25939 possible IP addresses have been tried.
25940 .ecindex IIDsmttra1
25941 .ecindex IIDsmttra2
25942
25943
25944
25945
25946
25947 . ////////////////////////////////////////////////////////////////////////////
25948 . ////////////////////////////////////////////////////////////////////////////
25949
25950 .chapter "Address rewriting" "CHAPrewrite"
25951 .scindex IIDaddrew "rewriting" "addresses"
25952 There are some circumstances in which Exim automatically rewrites domains in
25953 addresses. The two most common are when an address is given without a domain
25954 (referred to as an &"unqualified address"&) or when an address contains an
25955 abbreviated domain that is expanded by DNS lookup.
25956
25957 Unqualified envelope addresses are accepted only for locally submitted
25958 messages, or for messages that are received from hosts matching
25959 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25960 appropriate. Unqualified addresses in header lines are qualified if they are in
25961 locally submitted messages, or messages from hosts that are permitted to send
25962 unqualified envelope addresses. Otherwise, unqualified addresses in header
25963 lines are neither qualified nor rewritten.
25964
25965 One situation in which Exim does &'not'& automatically rewrite a domain is
25966 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25967 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25968 do this. The new RFCs do not contain this suggestion.
25969
25970
25971 .section "Explicitly configured address rewriting" "SECID147"
25972 This chapter describes the rewriting rules that can be used in the
25973 main rewrite section of the configuration file, and also in the generic
25974 &%headers_rewrite%& option that can be set on any transport.
25975
25976 Some people believe that configured address rewriting is a Mortal Sin.
25977 Others believe that life is not possible without it. Exim provides the
25978 facility; you do not have to use it.
25979
25980 The main rewriting rules that appear in the &"rewrite"& section of the
25981 configuration file are applied to addresses in incoming messages, both envelope
25982 addresses and addresses in header lines. Each rule specifies the types of
25983 address to which it applies.
25984
25985 Whether or not addresses in header lines are rewritten depends on the origin of
25986 the headers and the type of rewriting. Global rewriting, that is, rewriting
25987 rules from the rewrite section of the configuration file, is applied only to
25988 those headers that were received with the message. Header lines that are added
25989 by ACLs or by a system filter or by individual routers or transports (which
25990 are specific to individual recipient addresses) are not rewritten by the global
25991 rules.
25992
25993 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25994 applies all headers except those added by routers and transports. That is, as
25995 well as the headers that were received with the message, it also applies to
25996 headers that were added by an ACL or a system filter.
25997
25998
25999 In general, rewriting addresses from your own system or domain has some
26000 legitimacy. Rewriting other addresses should be done only with great care and
26001 in special circumstances. The author of Exim believes that rewriting should be
26002 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26003 Although it can sometimes be used as a routing tool, this is very strongly
26004 discouraged.
26005
26006 There are two commonly encountered circumstances where rewriting is used, as
26007 illustrated by these examples:
26008
26009 .ilist
26010 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26011 exchange mail with each other behind a firewall, but there is only a single
26012 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26013 &'hitch.fict.example'& when sending mail off-site.
26014 .next
26015 A host rewrites the local parts of its own users so that, for example,
26016 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26017 .endlist
26018
26019
26020
26021 .section "When does rewriting happen?" "SECID148"
26022 .cindex "rewriting" "timing of"
26023 .cindex "&ACL;" "rewriting addresses in"
26024 Configured address rewriting can take place at several different stages of a
26025 message's processing.
26026
26027 .vindex "&$sender_address$&"
26028 At the start of an ACL for MAIL, the sender address may have been rewritten
26029 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
26030 ordinary rewrite rules have yet been applied. If, however, the sender address
26031 is verified in the ACL, it is rewritten before verification, and remains
26032 rewritten thereafter. The subsequent value of &$sender_address$& is the
26033 rewritten address. This also applies if sender verification happens in a
26034 RCPT ACL. Otherwise, when the sender address is not verified, it is
26035 rewritten as soon as a message's header lines have been received.
26036
26037 .vindex "&$domain$&"
26038 .vindex "&$local_part$&"
26039 Similarly, at the start of an ACL for RCPT, the current recipient's address
26040 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26041 rewrite rules have yet been applied to it. However, the behaviour is different
26042 from the sender address when a recipient is verified. The address is rewritten
26043 for the verification, but the rewriting is not remembered at this stage. The
26044 value of &$local_part$& and &$domain$& after verification are always the same
26045 as they were before (that is, they contain the unrewritten &-- except for
26046 SMTP-time rewriting &-- address).
26047
26048 As soon as a message's header lines have been received, all the envelope
26049 recipient addresses are permanently rewritten, and rewriting is also applied to
26050 the addresses in the header lines (if configured). This happens before adding
26051 any header lines that were specified in MAIL or RCPT ACLs, and
26052 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26053 before the DATA ACL and &[local_scan()]& functions are run.
26054
26055 When an address is being routed, either for delivery or for verification,
26056 rewriting is applied immediately to child addresses that are generated by
26057 redirection, unless &%no_rewrite%& is set on the router.
26058
26059 .cindex "envelope from"
26060 .cindex "envelope sender" "rewriting at transport time"
26061 .cindex "rewriting" "at transport time"
26062 .cindex "header lines" "rewriting at transport time"
26063 At transport time, additional rewriting of addresses in header lines can be
26064 specified by setting the generic &%headers_rewrite%& option on a transport.
26065 This option contains rules that are identical in form to those in the rewrite
26066 section of the configuration file. They are applied to the original message
26067 header lines and any that were added by ACLs or a system filter. They are not
26068 applied to header lines that are added by routers or the transport.
26069
26070 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26071 transport option. However, it is not possible to rewrite envelope recipients at
26072 transport time.
26073
26074
26075
26076
26077 .section "Testing the rewriting rules that apply on input" "SECID149"
26078 .cindex "rewriting" "testing"
26079 .cindex "testing" "rewriting"
26080 Exim's input rewriting configuration appears in a part of the runtime
26081 configuration file headed by &"begin rewrite"&. It can be tested by the
26082 &%-brw%& command line option. This takes an address (which can be a full RFC
26083 2822 address) as its argument. The output is a list of how the address would be
26084 transformed by the rewriting rules for each of the different places it might
26085 appear in an incoming message, that is, for each different header and for the
26086 envelope sender and recipient fields. For example,
26087 .code
26088 exim -brw ph10@exim.workshop.example
26089 .endd
26090 might produce the output
26091 .code
26092 sender: Philip.Hazel@exim.workshop.example
26093 from: Philip.Hazel@exim.workshop.example
26094 to: ph10@exim.workshop.example
26095 cc: ph10@exim.workshop.example
26096 bcc: ph10@exim.workshop.example
26097 reply-to: Philip.Hazel@exim.workshop.example
26098 env-from: Philip.Hazel@exim.workshop.example
26099 env-to: ph10@exim.workshop.example
26100 .endd
26101 which shows that rewriting has been set up for that address when used in any of
26102 the source fields, but not when it appears as a recipient address. At the
26103 present time, there is no equivalent way of testing rewriting rules that are
26104 set for a particular transport.
26105
26106
26107 .section "Rewriting rules" "SECID150"
26108 .cindex "rewriting" "rules"
26109 The rewrite section of the configuration file consists of lines of rewriting
26110 rules in the form
26111 .display
26112 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26113 .endd
26114 Rewriting rules that are specified for the &%headers_rewrite%& generic
26115 transport option are given as a colon-separated list. Each item in the list
26116 takes the same form as a line in the main rewriting configuration (except that
26117 any colons must be doubled, of course).
26118
26119 The formats of source patterns and replacement strings are described below.
26120 Each is terminated by white space, unless enclosed in double quotes, in which
26121 case normal quoting conventions apply inside the quotes. The flags are single
26122 characters which may appear in any order. Spaces and tabs between them are
26123 ignored.
26124
26125 For each address that could potentially be rewritten, the rules are scanned in
26126 order, and replacements for the address from earlier rules can themselves be
26127 replaced by later rules (but see the &"q"& and &"R"& flags).
26128
26129 The order in which addresses are rewritten is undefined, may change between
26130 releases, and must not be relied on, with one exception: when a message is
26131 received, the envelope sender is always rewritten first, before any header
26132 lines are rewritten. For example, the replacement string for a rewrite of an
26133 address in &'To:'& must not assume that the message's address in &'From:'& has
26134 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26135 that the envelope sender has already been rewritten.
26136
26137 .vindex "&$domain$&"
26138 .vindex "&$local_part$&"
26139 The variables &$local_part$& and &$domain$& can be used in the replacement
26140 string to refer to the address that is being rewritten. Note that lookup-driven
26141 rewriting can be done by a rule of the form
26142 .code
26143 *@*   ${lookup ...
26144 .endd
26145 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26146 refer to the address that is being rewritten.
26147
26148
26149 .section "Rewriting patterns" "SECID151"
26150 .cindex "rewriting" "patterns"
26151 .cindex "address list" "in a rewriting pattern"
26152 The source pattern in a rewriting rule is any item which may appear in an
26153 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26154 single-item address list, which means that it is expanded before being tested
26155 against the address. As always, if you use a regular expression as a pattern,
26156 you must take care to escape dollar and backslash characters, or use the &`\N`&
26157 facility to suppress string expansion within the regular expression.
26158
26159 Domains in patterns should be given in lower case. Local parts in patterns are
26160 case-sensitive. If you want to do case-insensitive matching of local parts, you
26161 can use a regular expression that starts with &`^(?i)`&.
26162
26163 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26164 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26165 depending on the type of match which occurred. These can be used in the
26166 replacement string to insert portions of the incoming address. &$0$& always
26167 refers to the complete incoming address. When a regular expression is used, the
26168 numerical variables are set from its capturing subexpressions. For other types
26169 of pattern they are set as follows:
26170
26171 .ilist
26172 If a local part or domain starts with an asterisk, the numerical variables
26173 refer to the character strings matched by asterisks, with &$1$& associated with
26174 the first asterisk, and &$2$& with the second, if present. For example, if the
26175 pattern
26176 .code
26177 *queen@*.fict.example
26178 .endd
26179 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26180 .code
26181 $0 = hearts-queen@wonderland.fict.example
26182 $1 = hearts-
26183 $2 = wonderland
26184 .endd
26185 Note that if the local part does not start with an asterisk, but the domain
26186 does, it is &$1$& that contains the wild part of the domain.
26187
26188 .next
26189 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26190 of the domain are placed in the next available numerical variables. Suppose,
26191 for example, that the address &'foo@bar.baz.example'& is processed by a
26192 rewriting rule of the form
26193 .display
26194 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26195 .endd
26196 and the key in the file that matches the domain is &`*.baz.example`&. Then
26197 .code
26198 $1 = foo
26199 $2 = bar
26200 $3 = baz.example
26201 .endd
26202 If the address &'foo@baz.example'& is looked up, this matches the same
26203 wildcard file entry, and in this case &$2$& is set to the empty string, but
26204 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26205 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26206 whole domain. For non-partial domain lookups, no numerical variables are set.
26207 .endlist
26208
26209
26210 .section "Rewriting replacements" "SECID152"
26211 .cindex "rewriting" "replacements"
26212 If the replacement string for a rule is a single asterisk, addresses that
26213 match the pattern and the flags are &'not'& rewritten, and no subsequent
26214 rewriting rules are scanned. For example,
26215 .code
26216 hatta@lookingglass.fict.example  *  f
26217 .endd
26218 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26219 &'From:'& headers.
26220
26221 .vindex "&$domain$&"
26222 .vindex "&$local_part$&"
26223 If the replacement string is not a single asterisk, it is expanded, and must
26224 yield a fully qualified address. Within the expansion, the variables
26225 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26226 Any letters they contain retain their original case &-- they are not lower
26227 cased. The numerical variables are set up according to the type of pattern that
26228 matched the address, as described above. If the expansion is forced to fail by
26229 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26230 current rule is abandoned, but subsequent rules may take effect. Any other
26231 expansion failure causes the entire rewriting operation to be abandoned, and an
26232 entry written to the panic log.
26233
26234
26235
26236 .section "Rewriting flags" "SECID153"
26237 There are three different kinds of flag that may appear on rewriting rules:
26238
26239 .ilist
26240 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26241 c, f, h, r, s, t.
26242 .next
26243 A flag that specifies rewriting at SMTP time: S.
26244 .next
26245 Flags that control the rewriting process: Q, q, R, w.
26246 .endlist
26247
26248 For rules that are part of the &%headers_rewrite%& generic transport option,
26249 E, F, T, and S are not permitted.
26250
26251
26252
26253 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26254          "SECID154"
26255 .cindex "rewriting" "flags"
26256 If none of the following flag letters, nor the &"S"& flag (see section
26257 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26258 and to both the sender and recipient fields of the envelope, whereas a
26259 transport-time rewriting rule just applies to all headers. Otherwise, the
26260 rewriting rule is skipped unless the relevant addresses are being processed.
26261 .display
26262 &`E`&       rewrite all envelope fields
26263 &`F`&       rewrite the envelope From field
26264 &`T`&       rewrite the envelope To field
26265 &`b`&       rewrite the &'Bcc:'& header
26266 &`c`&       rewrite the &'Cc:'& header
26267 &`f`&       rewrite the &'From:'& header
26268 &`h`&       rewrite all headers
26269 &`r`&       rewrite the &'Reply-To:'& header
26270 &`s`&       rewrite the &'Sender:'& header
26271 &`t`&       rewrite the &'To:'& header
26272 .endd
26273 "All headers" means all of the headers listed above that can be selected
26274 individually, plus their &'Resent-'& versions. It does not include
26275 other headers such as &'Subject:'& etc.
26276
26277 You should be particularly careful about rewriting &'Sender:'& headers, and
26278 restrict this to special known cases in your own domains.
26279
26280
26281 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26282 .cindex "SMTP" "rewriting malformed addresses"
26283 .cindex "RCPT" "rewriting argument of"
26284 .cindex "MAIL" "rewriting argument of"
26285 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26286 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26287 before any other processing; even before syntax checking. The pattern is
26288 required to be a regular expression, and it is matched against the whole of the
26289 data for the command, including any surrounding angle brackets.
26290
26291 .vindex "&$domain$&"
26292 .vindex "&$local_part$&"
26293 This form of rewrite rule allows for the handling of addresses that are not
26294 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26295 input). Because the input is not required to be a syntactically valid address,
26296 the variables &$local_part$& and &$domain$& are not available during the
26297 expansion of the replacement string. The result of rewriting replaces the
26298 original address in the MAIL or RCPT command.
26299
26300
26301 .section "Flags controlling the rewriting process" "SECID155"
26302 There are four flags which control the way the rewriting process works. These
26303 take effect only when a rule is invoked, that is, when the address is of the
26304 correct type (matches the flags) and matches the pattern:
26305
26306 .ilist
26307 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26308 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26309 absence of &"Q"& the rewritten address must always include a domain.
26310 .next
26311 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26312 even if no rewriting actually takes place because of a &"fail"& in the
26313 expansion. The &"q"& flag is not effective if the address is of the wrong type
26314 (does not match the flags) or does not match the pattern.
26315 .next
26316 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26317 address, up to ten times. It can be combined with the &"q"& flag, to stop
26318 rewriting once it fails to match (after at least one successful rewrite).
26319 .next
26320 .cindex "rewriting" "whole addresses"
26321 When an address in a header is rewritten, the rewriting normally applies only
26322 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26323 left unchanged. For example, rewriting might change
26324 .code
26325 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26326 .endd
26327 into
26328 .code
26329 From: Ford Prefect <prefectf@hitch.fict.example>
26330 .endd
26331 .cindex "RFC 2047"
26332 Sometimes there is a need to replace the whole address item, and this can be
26333 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26334 causes an address in a header line to be rewritten, the entire address is
26335 replaced, not just the working part. The replacement must be a complete RFC
26336 2822 address, including the angle brackets if necessary. If text outside angle
26337 brackets contains a character whose value is greater than 126 or less than 32
26338 (except for tab), the text is encoded according to RFC 2047. The character set
26339 is taken from &%headers_charset%&, which gets its default at build time.
26340
26341 When the &"w"& flag is set on a rule that causes an envelope address to be
26342 rewritten, all but the working part of the replacement address is discarded.
26343 .endlist
26344
26345
26346 .section "Rewriting examples" "SECID156"
26347 Here is an example of the two common rewriting paradigms:
26348 .code
26349 *@*.hitch.fict.example  $1@hitch.fict.example
26350 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26351                      {$value}fail}@hitch.fict.example bctfrF
26352 .endd
26353 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26354 the string expansion to fail if the lookup does not succeed. In this context it
26355 has the effect of leaving the original address unchanged, but Exim goes on to
26356 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26357 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26358 explicitly, which would cause the rewritten address to be the same as before,
26359 at the cost of a small bit of processing. Not supplying either of these is an
26360 error, since the rewritten address would then contain no local part.
26361
26362 The first example above replaces the domain with a superior, more general
26363 domain. This may not be desirable for certain local parts. If the rule
26364 .code
26365 root@*.hitch.fict.example  *
26366 .endd
26367 were inserted before the first rule, rewriting would be suppressed for the
26368 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26369
26370 Rewriting can be made conditional on a number of tests, by making use of
26371 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26372 messages that originate outside the local host:
26373 .code
26374 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26375                          {$1@hitch.fict.example}fail}"
26376 .endd
26377 The replacement string is quoted in this example because it contains white
26378 space.
26379
26380 .cindex "rewriting" "bang paths"
26381 .cindex "bang paths" "rewriting"
26382 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26383 an address it treats it as an unqualified local part which it qualifies with
26384 the local qualification domain (if the source of the message is local or if the
26385 remote host is permitted to send unqualified addresses). Rewriting can
26386 sometimes be used to handle simple bang paths with a fixed number of
26387 components. For example, the rule
26388 .code
26389 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26390 .endd
26391 rewrites a two-component bang path &'host.name!user'& as the domain address
26392 &'user@host.name'&. However, there is a security implication in using this as
26393 a global rewriting rule for envelope addresses. It can provide a backdoor
26394 method for using your system as a relay, because the incoming addresses appear
26395 to be local. If the bang path addresses are received via SMTP, it is safer to
26396 use the &"S"& flag to rewrite them as they are received, so that relay checking
26397 can be done on the rewritten addresses.
26398 .ecindex IIDaddrew
26399
26400
26401
26402
26403
26404 . ////////////////////////////////////////////////////////////////////////////
26405 . ////////////////////////////////////////////////////////////////////////////
26406
26407 .chapter "Retry configuration" "CHAPretry"
26408 .scindex IIDretconf1 "retry" "configuration, description of"
26409 .scindex IIDregconf2 "configuration file" "retry section"
26410 The &"retry"& section of the runtime configuration file contains a list of
26411 retry rules that control how often Exim tries to deliver messages that cannot
26412 be delivered at the first attempt. If there are no retry rules (the section is
26413 empty or not present), there are no retries. In this situation, temporary
26414 errors are treated as permanent. The default configuration contains a single,
26415 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26416 line option can be used to test which retry rule will be used for a given
26417 address, domain and error.
26418
26419 The most common cause of retries is temporary failure to deliver to a remote
26420 host because the host is down, or inaccessible because of a network problem.
26421 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26422 address) basis, not on a per-message basis. Thus, if one message has recently
26423 been delayed, delivery of a new message to the same host is not immediately
26424 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26425 log selector is set, the message
26426 .cindex "retry" "time not reached"
26427 &"retry time not reached"& is written to the main log whenever a delivery is
26428 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26429 the handling of errors during remote deliveries.
26430
26431 Retry processing applies to routing as well as to delivering, except as covered
26432 in the next paragraph. The retry rules do not distinguish between these
26433 actions. It is not possible, for example, to specify different behaviour for
26434 failures to route the domain &'snark.fict.example'& and failures to deliver to
26435 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26436 added complication, so did not implement it. However, although they share the
26437 same retry rule, the actual retry times for routing and transporting a given
26438 domain are maintained independently.
26439
26440 When a delivery is not part of a queue run (typically an immediate delivery on
26441 receipt of a message), the routers are always run, and local deliveries are
26442 always attempted, even if retry times are set for them. This makes for better
26443 behaviour if one particular message is causing problems (for example, causing
26444 quota overflow, or provoking an error in a filter file). If such a delivery
26445 suffers a temporary failure, the retry data is updated as normal, and
26446 subsequent delivery attempts from queue runs occur only when the retry time for
26447 the local address is reached.
26448
26449 .section "Changing retry rules" "SECID157"
26450 If you change the retry rules in your configuration, you should consider
26451 whether or not to delete the retry data that is stored in Exim's spool area in
26452 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26453 always safe; that is why they are called &"hints"&.
26454
26455 The hints retry data contains suggested retry times based on the previous
26456 rules. In the case of a long-running problem with a remote host, it might
26457 record the fact that the host has timed out. If your new rules increase the
26458 timeout time for such a host, you should definitely remove the old retry data
26459 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26460 messages that it should now be retaining.
26461
26462
26463
26464 .section "Format of retry rules" "SECID158"
26465 .cindex "retry" "rules"
26466 Each retry rule occupies one line and consists of three or four parts,
26467 separated by white space: a pattern, an error name, an optional list of sender
26468 addresses, and a list of retry parameters. The pattern and sender lists must be
26469 enclosed in double quotes if they contain white space. The rules are searched
26470 in order until one is found where the pattern, error name, and sender list (if
26471 present) match the failing host or address, the error that occurred, and the
26472 message's sender, respectively.
26473
26474
26475 The pattern is any single item that may appear in an address list (see section
26476 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26477 which means that it is expanded before being tested against the address that
26478 has been delayed. A negated address list item is permitted. Address
26479 list processing treats a plain domain name as if it were preceded by &"*@"&,
26480 which makes it possible for many retry rules to start with just a domain. For
26481 example,
26482 .code
26483 lookingglass.fict.example        *  F,24h,30m;
26484 .endd
26485 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26486 whereas
26487 .code
26488 alice@lookingglass.fict.example  *  F,24h,30m;
26489 .endd
26490 applies only to temporary failures involving the local part &%alice%&.
26491 In practice, almost all rules start with a domain name pattern without a local
26492 part.
26493
26494 .cindex "regular expressions" "in retry rules"
26495 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26496 must match a complete address, not just a domain, because that is how regular
26497 expressions work in address lists.
26498 .display
26499 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26500 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26501 .endd
26502
26503
26504 .section "Choosing which retry rule to use for address errors" "SECID159"
26505 When Exim is looking for a retry rule after a routing attempt has failed (for
26506 example, after a DNS timeout), each line in the retry configuration is tested
26507 against the complete address only if &%retry_use_local_part%& is set for the
26508 router. Otherwise, only the domain is used, except when matching against a
26509 regular expression, when the local part of the address is replaced with &"*"&.
26510 A domain on its own can match a domain pattern, or a pattern that starts with
26511 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26512 &%check_local_user%& is true, and false for other routers.
26513
26514 Similarly, when Exim is looking for a retry rule after a local delivery has
26515 failed (for example, after a mailbox full error), each line in the retry
26516 configuration is tested against the complete address only if
26517 &%retry_use_local_part%& is set for the transport (it defaults true for all
26518 local transports).
26519
26520 .cindex "4&'xx'& responses" "retry rules for"
26521 However, when Exim is looking for a retry rule after a remote delivery attempt
26522 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26523 whole address is always used as the key when searching the retry rules. The
26524 rule that is found is used to create a retry time for the combination of the
26525 failing address and the message's sender. It is the combination of sender and
26526 recipient that is delayed in subsequent queue runs until its retry time is
26527 reached. You can delay the recipient without regard to the sender by setting
26528 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26529 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26530 commands.
26531
26532
26533
26534 .section "Choosing which retry rule to use for host and message errors" &&&
26535          "SECID160"
26536 For a temporary error that is not related to an individual address (for
26537 example, a connection timeout), each line in the retry configuration is checked
26538 twice. First, the name of the remote host is used as a domain name (preceded by
26539 &"*@"& when matching a regular expression). If this does not match the line,
26540 the domain from the email address is tried in a similar fashion. For example,
26541 suppose the MX records for &'a.b.c.example'& are
26542 .code
26543 a.b.c.example  MX  5  x.y.z.example
26544                MX  6  p.q.r.example
26545                MX  7  m.n.o.example
26546 .endd
26547 and the retry rules are
26548 .code
26549 p.q.r.example    *      F,24h,30m;
26550 a.b.c.example    *      F,4d,45m;
26551 .endd
26552 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26553 first rule matches neither the host nor the domain, so Exim looks at the second
26554 rule. This does not match the host, but it does match the domain, so it is used
26555 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26556 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26557 first retry rule is used, because it matches the host.
26558
26559 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26560 first rule to determine retry times, but for all the other hosts for the domain
26561 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26562 routing to &'a.b.c.example'& suffers a temporary failure.
26563
26564 &*Note*&: The host name is used when matching the patterns, not its IP address.
26565 However, if a message is routed directly to an IP address without the use of a
26566 host name, for example, if a &(manualroute)& router contains a setting such as:
26567 .code
26568 route_list = *.a.example  192.168.34.23
26569 .endd
26570 then the &"host name"& that is used when searching for a retry rule is the
26571 textual form of the IP address.
26572
26573 .section "Retry rules for specific errors" "SECID161"
26574 .cindex "retry" "specific errors; specifying"
26575 The second field in a retry rule is the name of a particular error, or an
26576 asterisk, which matches any error. The errors that can be tested for are:
26577
26578 .vlist
26579 .vitem &%auth_failed%&
26580 Authentication failed when trying to send to a host in the
26581 &%hosts_require_auth%& list in an &(smtp)& transport.
26582
26583 .vitem &%data_4xx%&
26584 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26585 after the command, or after sending the message's data.
26586
26587 .vitem &%mail_4xx%&
26588 A 4&'xx'& error was received for an outgoing MAIL command.
26589
26590 .vitem &%rcpt_4xx%&
26591 A 4&'xx'& error was received for an outgoing RCPT command.
26592 .endlist
26593
26594 For the three 4&'xx'& errors, either the first or both of the x's can be given
26595 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26596 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26597 and have retries every ten minutes with a one-hour timeout, you could set up a
26598 retry rule of this form:
26599 .code
26600 the.domain.name  rcpt_452   F,1h,10m
26601 .endd
26602 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26603 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26604
26605 .vlist
26606 .vitem &%lost_connection%&
26607 A server unexpectedly closed the SMTP connection. There may, of course,
26608 legitimate reasons for this (host died, network died), but if it repeats a lot
26609 for the same host, it indicates something odd.
26610
26611 .vitem &%lookup%&
26612 A DNS lookup for a host failed.
26613 Note that a &%dnslookup%& router will need to have matched
26614 its &%fail_defer_domains%& option for this retry type to be usable.
26615 Also note that a &%manualroute%& router will probably need
26616 its &%host_find_failed%& option set to &%defer%&.
26617
26618 .vitem &%refused_MX%&
26619 A connection to a host obtained from an MX record was refused.
26620
26621 .vitem &%refused_A%&
26622 A connection to a host not obtained from an MX record was refused.
26623
26624 .vitem &%refused%&
26625 A connection was refused.
26626
26627 .vitem &%timeout_connect_MX%&
26628 A connection attempt to a host obtained from an MX record timed out.
26629
26630 .vitem &%timeout_connect_A%&
26631 A connection attempt to a host not obtained from an MX record timed out.
26632
26633 .vitem &%timeout_connect%&
26634 A connection attempt timed out.
26635
26636 .vitem &%timeout_MX%&
26637 There was a timeout while connecting or during an SMTP session with a host
26638 obtained from an MX record.
26639
26640 .vitem &%timeout_A%&
26641 There was a timeout while connecting or during an SMTP session with a host not
26642 obtained from an MX record.
26643
26644 .vitem &%timeout%&
26645 There was a timeout while connecting or during an SMTP session.
26646
26647 .vitem &%tls_required%&
26648 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26649 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26650 to STARTTLS, or there was a problem setting up the TLS connection.
26651
26652 .vitem &%quota%&
26653 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26654 transport.
26655
26656 .vitem &%quota_%&<&'time'&>
26657 .cindex "quota" "error testing in retry rule"
26658 .cindex "retry" "quota error testing"
26659 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26660 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26661 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26662 for four days.
26663 .endlist
26664
26665 .cindex "mailbox" "time of last read"
26666 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26667 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26668 it should be based on the last time that the user accessed the mailbox.
26669 However, it is not always possible to determine this. Exim uses the following
26670 heuristic rules:
26671
26672 .ilist
26673 If the mailbox is a single file, the time of last access (the &"atime"&) is
26674 used. As no new messages are being delivered (because the mailbox is over
26675 quota), Exim does not access the file, so this is the time of last user access.
26676 .next
26677 .cindex "maildir format" "time of last read"
26678 For a maildir delivery, the time of last modification of the &_new_&
26679 subdirectory is used. As the mailbox is over quota, no new files are created in
26680 the &_new_& subdirectory, because no new messages are being delivered. Any
26681 change to the &_new_& subdirectory is therefore assumed to be the result of an
26682 MUA moving a new message to the &_cur_& directory when it is first read. The
26683 time that is used is therefore the last time that the user read a new message.
26684 .next
26685 For other kinds of multi-file mailbox, the time of last access cannot be
26686 obtained, so a retry rule that uses this type of error field is never matched.
26687 .endlist
26688
26689 The quota errors apply both to system-enforced quotas and to Exim's own quota
26690 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26691 when a local delivery is deferred because a partition is full (the ENOSPC
26692 error).
26693
26694
26695
26696 .section "Retry rules for specified senders" "SECID162"
26697 .cindex "retry" "rules; sender-specific"
26698 You can specify retry rules that apply only when the failing message has a
26699 specific sender. In particular, this can be used to define retry rules that
26700 apply only to bounce messages. The third item in a retry rule can be of this
26701 form:
26702 .display
26703 &`senders=`&<&'address list'&>
26704 .endd
26705 The retry timings themselves are then the fourth item. For example:
26706 .code
26707 *   rcpt_4xx   senders=:   F,1h,30m
26708 .endd
26709 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26710 host. If the address list contains white space, it must be enclosed in quotes.
26711 For example:
26712 .code
26713 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26714 .endd
26715 &*Warning*&: This facility can be unhelpful if it is used for host errors
26716 (which do not depend on the recipient). The reason is that the sender is used
26717 only to match the retry rule. Once the rule has been found for a host error,
26718 its contents are used to set a retry time for the host, and this will apply to
26719 all messages, not just those with specific senders.
26720
26721 When testing retry rules using &%-brt%&, you can supply a sender using the
26722 &%-f%& command line option, like this:
26723 .code
26724 exim -f "" -brt user@dom.ain
26725 .endd
26726 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26727 list is never matched.
26728
26729
26730
26731
26732
26733 .section "Retry parameters" "SECID163"
26734 .cindex "retry" "parameters in rules"
26735 The third (or fourth, if a senders list is present) field in a retry rule is a
26736 sequence of retry parameter sets, separated by semicolons. Each set consists of
26737 .display
26738 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26739 .endd
26740 The letter identifies the algorithm for computing a new retry time; the cutoff
26741 time is the time beyond which this algorithm no longer applies, and the
26742 arguments vary the algorithm's action. The cutoff time is measured from the
26743 time that the first failure for the domain (combined with the local part if
26744 relevant) was detected, not from the time the message was received.
26745
26746 .cindex "retry" "algorithms"
26747 .cindex "retry" "fixed intervals"
26748 .cindex "retry" "increasing intervals"
26749 .cindex "retry" "random intervals"
26750 The available algorithms are:
26751
26752 .ilist
26753 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26754 the interval.
26755 .next
26756 &'G'&: retry at geometrically increasing intervals. The first argument
26757 specifies a starting value for the interval, and the second a multiplier, which
26758 is used to increase the size of the interval at each retry.
26759 .next
26760 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26761 retry, the previous interval is multiplied by the factor in order to get a
26762 maximum for the next interval. The minimum interval is the first argument of
26763 the parameter, and an actual interval is chosen randomly between them. Such a
26764 rule has been found to be helpful in cluster configurations when all the
26765 members of the cluster restart at once, and may therefore synchronize their
26766 queue processing times.
26767 .endlist
26768
26769 When computing the next retry time, the algorithm definitions are scanned in
26770 order until one whose cutoff time has not yet passed is reached. This is then
26771 used to compute a new retry time that is later than the current time. In the
26772 case of fixed interval retries, this simply means adding the interval to the
26773 current time. For geometrically increasing intervals, retry intervals are
26774 computed from the rule's parameters until one that is greater than the previous
26775 interval is found. The main configuration variable
26776 .cindex "limit" "retry interval"
26777 .cindex "retry" "interval, maximum"
26778 .oindex "&%retry_interval_max%&"
26779 &%retry_interval_max%& limits the maximum interval between retries. It
26780 cannot be set greater than &`24h`&, which is its default value.
26781
26782 A single remote domain may have a number of hosts associated with it, and each
26783 host may have more than one IP address. Retry algorithms are selected on the
26784 basis of the domain name, but are applied to each IP address independently. If,
26785 for example, a host has two IP addresses and one is unusable, Exim will
26786 generate retry times for it and will not try to use it until its next retry
26787 time comes. Thus the good IP address is likely to be tried first most of the
26788 time.
26789
26790 .cindex "hints database" "use for retrying"
26791 Retry times are hints rather than promises. Exim does not make any attempt to
26792 run deliveries exactly at the computed times. Instead, a queue runner process
26793 starts delivery processes for delayed messages periodically, and these attempt
26794 new deliveries only for those addresses that have passed their next retry time.
26795 If a new message arrives for a deferred address, an immediate delivery attempt
26796 occurs only if the address has passed its retry time. In the absence of new
26797 messages, the minimum time between retries is the interval between queue runner
26798 processes. There is not much point in setting retry times of five minutes if
26799 your queue runners happen only once an hour, unless there are a significant
26800 number of incoming messages (which might be the case on a system that is
26801 sending everything to a smart host, for example).
26802
26803 The data in the retry hints database can be inspected by using the
26804 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26805 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26806 &'exinext'& utility script can be used to find out what the next retry times
26807 are for the hosts associated with a particular mail domain, and also for local
26808 deliveries that have been deferred.
26809
26810
26811 .section "Retry rule examples" "SECID164"
26812 Here are some example retry rules:
26813 .code
26814 alice@wonderland.fict.example quota_5d  F,7d,3h
26815 wonderland.fict.example       quota_5d
26816 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26817 lookingglass.fict.example     *         F,24h,30m;
26818 *                 refused_A   F,2h,20m;
26819 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26820 .endd
26821 The first rule sets up special handling for mail to
26822 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26823 mailbox has not been read for at least 5 days. Retries continue every three
26824 hours for 7 days. The second rule handles over-quota errors for all other local
26825 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26826 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26827 fail are bounced immediately if the mailbox has not been read for at least 5
26828 days.
26829
26830 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26831 happen every 15 minutes for an hour, then with geometrically increasing
26832 intervals until two days have passed since a delivery first failed. After the
26833 first hour there is a delay of one hour, then two hours, then four hours, and
26834 so on (this is a rather extreme example).
26835
26836 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26837 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26838 all other domains, with special action for connection refusal from hosts that
26839 were not obtained from an MX record.
26840
26841 The final rule in a retry configuration should always have asterisks in the
26842 first two fields so as to provide a general catch-all for any addresses that do
26843 not have their own special handling. This example tries every 15 minutes for 2
26844 hours, then with intervals starting at one hour and increasing by a factor of
26845 1.5 up to 16 hours, then every 8 hours up to 5 days.
26846
26847
26848
26849 .section "Timeout of retry data" "SECID165"
26850 .cindex "timeout" "of retry data"
26851 .oindex "&%retry_data_expire%&"
26852 .cindex "hints database" "data expiry"
26853 .cindex "retry" "timeout of data"
26854 Exim timestamps the data that it writes to its retry hints database. When it
26855 consults the data during a delivery it ignores any that is older than the value
26856 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26857 been tried for 7 days, Exim will try to deliver to it immediately a message
26858 arrives, and if that fails, it will calculate a retry time as if it were
26859 failing for the first time.
26860
26861 This improves the behaviour for messages routed to rarely-used hosts such as MX
26862 backups. If such a host was down at one time, and happens to be down again when
26863 Exim tries a month later, using the old retry data would imply that it had been
26864 down all the time, which is not a justified assumption.
26865
26866 If a host really is permanently dead, this behaviour causes a burst of retries
26867 every now and again, but only if messages routed to it are rare. If there is a
26868 message at least once every 7 days the retry data never expires.
26869
26870
26871
26872
26873 .section "Long-term failures" "SECID166"
26874 .cindex "delivery failure, long-term"
26875 .cindex "retry" "after long-term failure"
26876 Special processing happens when an email address has been failing for so long
26877 that the cutoff time for the last algorithm is reached. For example, using the
26878 default retry rule:
26879 .code
26880 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26881 .endd
26882 the cutoff time is four days. Reaching the retry cutoff is independent of how
26883 long any specific message has been failing; it is the length of continuous
26884 failure for the recipient address that counts.
26885
26886 When the cutoff time is reached for a local delivery, or for all the IP
26887 addresses associated with a remote delivery, a subsequent delivery failure
26888 causes Exim to give up on the address, and a bounce message is generated.
26889 In order to cater for new messages that use the failing address, a next retry
26890 time is still computed from the final algorithm, and is used as follows:
26891
26892 For local deliveries, one delivery attempt is always made for any subsequent
26893 messages. If this delivery fails, the address fails immediately. The
26894 post-cutoff retry time is not used.
26895
26896 .cindex "final cutoff" "retries, controlling"
26897 .cindex retry "final cutoff"
26898 If the delivery is remote, there are two possibilities, controlled by the
26899 .oindex "&%delay_after_cutoff%&"
26900 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26901 default. Until the post-cutoff retry time for one of the IP addresses,
26902 as set by the &%retry_data_expire%& option, is
26903 reached, the failing email address is bounced immediately, without a delivery
26904 attempt taking place. After that time, one new delivery attempt is made to
26905 those IP addresses that are past their retry times, and if that still fails,
26906 the address is bounced and new retry times are computed.
26907
26908 In other words, when all the hosts for a given email address have been failing
26909 for a long time, Exim bounces rather then defers until one of the hosts' retry
26910 times is reached. Then it tries once, and bounces if that attempt fails. This
26911 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26912 to a broken destination, but if the host does recover, Exim will eventually
26913 notice.
26914
26915 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26916 addresses are past their final cutoff time, Exim tries to deliver to those IP
26917 addresses that have not been tried since the message arrived. If there are
26918 no suitable IP addresses, or if they all fail, the address is bounced. In other
26919 words, it does not delay when a new message arrives, but tries the expired
26920 addresses immediately, unless they have been tried since the message arrived.
26921 If there is a continuous stream of messages for the failing domains, setting
26922 &%delay_after_cutoff%& false means that there will be many more attempts to
26923 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26924 true.
26925
26926 .section "Deliveries that work intermittently" "SECID167"
26927 .cindex "retry" "intermittently working deliveries"
26928 Some additional logic is needed to cope with cases where a host is
26929 intermittently available, or when a message has some attribute that prevents
26930 its delivery when others to the same address get through. In this situation,
26931 because some messages are successfully delivered, the &"retry clock"& for the
26932 host or address keeps getting reset by the successful deliveries, and so
26933 failing messages remain in the queue for ever because the cutoff time is never
26934 reached.
26935
26936 Two exceptional actions are applied to prevent this happening. The first
26937 applies to errors that are related to a message rather than a remote host.
26938 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26939 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26940 commands, and quota failures. For this type of error, if a message's arrival
26941 time is earlier than the &"first failed"& time for the error, the earlier time
26942 is used when scanning the retry rules to decide when to try next and when to
26943 time out the address.
26944
26945 The exceptional second action applies in all cases. If a message has been on
26946 the queue for longer than the cutoff time of any applicable retry rule for a
26947 given address, a delivery is attempted for that address, even if it is not yet
26948 time, and if this delivery fails, the address is timed out. A new retry time is
26949 not computed in this case, so that other messages for the same address are
26950 considered immediately.
26951 .ecindex IIDretconf1
26952 .ecindex IIDregconf2
26953
26954
26955
26956
26957
26958
26959 . ////////////////////////////////////////////////////////////////////////////
26960 . ////////////////////////////////////////////////////////////////////////////
26961
26962 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26963 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26964 .scindex IIDauthconf2 "authentication"
26965 The &"authenticators"& section of Exim's runtime configuration is concerned
26966 with SMTP authentication. This facility is an extension to the SMTP protocol,
26967 described in RFC 2554, which allows a client SMTP host to authenticate itself
26968 to a server. This is a common way for a server to recognize clients that are
26969 permitted to use it as a relay. SMTP authentication is not of relevance to the
26970 transfer of mail between servers that have no managerial connection with each
26971 other.
26972
26973 .cindex "AUTH" "description of"
26974 .cindex "ESMTP extensions" AUTH
26975 Very briefly, the way SMTP authentication works is as follows:
26976
26977 .ilist
26978 The server advertises a number of authentication &'mechanisms'& in response to
26979 the client's EHLO command.
26980 .next
26981 The client issues an AUTH command, naming a specific mechanism. The command
26982 may, optionally, contain some authentication data.
26983 .next
26984 The server may issue one or more &'challenges'&, to which the client must send
26985 appropriate responses. In simple authentication mechanisms, the challenges are
26986 just prompts for user names and passwords. The server does not have to issue
26987 any challenges &-- in some mechanisms the relevant data may all be transmitted
26988 with the AUTH command.
26989 .next
26990 The server either accepts or denies authentication.
26991 .next
26992 If authentication succeeds, the client may optionally make use of the AUTH
26993 option on the MAIL command to pass an authenticated sender in subsequent
26994 mail transactions. Authentication lasts for the remainder of the SMTP
26995 connection.
26996 .next
26997 If authentication fails, the client may give up, or it may try a different
26998 authentication mechanism, or it may try transferring mail over the
26999 unauthenticated connection.
27000 .endlist
27001
27002 If you are setting up a client, and want to know which authentication
27003 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27004 SMTP port) on the server, and issue an EHLO command. The response to this
27005 includes the list of supported mechanisms. For example:
27006 .display
27007 &`$ `&&*&`telnet server.example 25`&*&
27008 &`Trying 192.168.34.25...`&
27009 &`Connected to server.example.`&
27010 &`Escape character is &#x0027;^]&#x0027;.`&
27011 &`220 server.example ESMTP Exim 4.20 ...`&
27012 &*&`ehlo client.example`&*&
27013 &`250-server.example Hello client.example [10.8.4.5]`&
27014 &`250-SIZE 52428800`&
27015 &`250-PIPELINING`&
27016 &`250-AUTH PLAIN`&
27017 &`250 HELP`&
27018 .endd
27019 The second-last line of this example output shows that the server supports
27020 authentication using the PLAIN mechanism. In Exim, the different authentication
27021 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27022 routers and transports, which authenticators are included in the binary is
27023 controlled by build-time definitions. The following are currently available,
27024 included by setting
27025 .code
27026 AUTH_CRAM_MD5=yes
27027 AUTH_CYRUS_SASL=yes
27028 AUTH_DOVECOT=yes
27029 AUTH_EXTERNAL=yes
27030 AUTH_GSASL=yes
27031 AUTH_HEIMDAL_GSSAPI=yes
27032 AUTH_PLAINTEXT=yes
27033 AUTH_SPA=yes
27034 AUTH_TLS=yes
27035 .endd
27036 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27037 authentication mechanism (RFC 2195), and the second provides an interface to
27038 the Cyrus SASL authentication library.
27039 The third is an interface to Dovecot's authentication system, delegating the
27040 work via a socket interface.
27041 The fourth provides for negotiation of authentication done via non-SMTP means,
27042 as defined by RFC 4422 Appendix A.
27043 The fifth provides an interface to the GNU SASL authentication library, which
27044 provides mechanisms but typically not data sources.
27045 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27046 supporting setting a server keytab.
27047 The seventh can be configured to support
27048 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27049 not formally documented, but used by several MUAs.
27050 The eighth authenticator
27051 supports Microsoft's &'Secure Password Authentication'& mechanism.
27052 The last is an Exim authenticator but not an SMTP one;
27053 instead it can use information from a TLS negotiation.
27054
27055 The authenticators are configured using the same syntax as other drivers (see
27056 section &<<SECTfordricon>>&). If no authenticators are required, no
27057 authentication section need be present in the configuration file. Each
27058 authenticator can in principle have both server and client functions. When Exim
27059 is receiving SMTP mail, it is acting as a server; when it is sending out
27060 messages over SMTP, it is acting as a client. Authenticator configuration
27061 options are provided for use in both these circumstances.
27062
27063 To make it clear which options apply to which situation, the prefixes
27064 &%server_%& and &%client_%& are used on option names that are specific to
27065 either the server or the client function, respectively. Server and client
27066 functions are disabled if none of their options are set. If an authenticator is
27067 to be used for both server and client functions, a single definition, using
27068 both sets of options, is required. For example:
27069 .code
27070 cram:
27071   driver = cram_md5
27072   public_name = CRAM-MD5
27073   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27074   client_name = ph10
27075   client_secret = secret2
27076 .endd
27077 The &%server_%& option is used when Exim is acting as a server, and the
27078 &%client_%& options when it is acting as a client.
27079
27080 Descriptions of the individual authenticators are given in subsequent chapters.
27081 The remainder of this chapter covers the generic options for the
27082 authenticators, followed by general discussion of the way authentication works
27083 in Exim.
27084
27085 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27086 per-mechanism basis.  Please read carefully to determine which variables hold
27087 account labels such as usercodes and which hold passwords or other
27088 authenticating data.
27089
27090 Note that some mechanisms support two different identifiers for accounts: the
27091 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27092 and &'authz'& are commonly encountered.  The American spelling is standard here.
27093 Conceptually, authentication data such as passwords are tied to the identifier
27094 used to authenticate; servers may have rules to permit one user to act as a
27095 second user, so that after login the session is treated as though that second
27096 user had logged in.  That second user is the &'authorization id'&.  A robust
27097 configuration might confirm that the &'authz'& field is empty or matches the
27098 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27099 as verified data, the &'authz'& as an unverified request which the server might
27100 choose to honour.
27101
27102 A &'realm'& is a text string, typically a domain name, presented by a server
27103 to a client to help it select an account and credentials to use.  In some
27104 mechanisms, the client and server provably agree on the realm, but clients
27105 typically can not treat the realm as secure data to be blindly trusted.
27106
27107
27108
27109 .section "Generic options for authenticators" "SECID168"
27110 .cindex "authentication" "generic options"
27111 .cindex "options" "generic; for authenticators"
27112
27113 .option client_condition authenticators string&!! unset
27114 When Exim is authenticating as a client, it skips any authenticator whose
27115 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27116 used, for example, to skip plain text authenticators when the connection is not
27117 encrypted by a setting such as:
27118 .code
27119 client_condition = ${if !eq{$tls_out_cipher}{}}
27120 .endd
27121
27122
27123 .option client_set_id authenticators string&!! unset
27124 When client authentication succeeds, this condition is expanded; the
27125 result is used in the log lines for outbound messages.
27126 Typically it will be the user name used for authentication.
27127
27128
27129 .option driver authenticators string unset
27130 This option must always be set. It specifies which of the available
27131 authenticators is to be used.
27132
27133
27134 .option public_name authenticators string unset
27135 This option specifies the name of the authentication mechanism that the driver
27136 implements, and by which it is known to the outside world. These names should
27137 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27138 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27139 defaults to the driver's instance name.
27140
27141
27142 .option server_advertise_condition authenticators string&!! unset
27143 When a server is about to advertise an authentication mechanism, the condition
27144 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27145 mechanism is not advertised.
27146 If the expansion fails, the mechanism is not advertised. If the failure was not
27147 forced, and was not caused by a lookup defer, the incident is logged.
27148 See section &<<SECTauthexiser>>& below for further discussion.
27149
27150
27151 .option server_condition authenticators string&!! unset
27152 This option must be set for a &%plaintext%& server authenticator, where it
27153 is used directly to control authentication. See section &<<SECTplainserver>>&
27154 for details.
27155
27156 For the &(gsasl)& authenticator, this option is required for various
27157 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27158
27159 For the other authenticators, &%server_condition%& can be used as an additional
27160 authentication or authorization mechanism that is applied after the other
27161 authenticator conditions succeed. If it is set, it is expanded when the
27162 authenticator would otherwise return a success code. If the expansion is forced
27163 to fail, authentication fails. Any other expansion failure causes a temporary
27164 error code to be returned. If the result of a successful expansion is an empty
27165 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27166 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27167 other result, a temporary error code is returned, with the expanded string as
27168 the error text.
27169
27170
27171 .option server_debug_print authenticators string&!! unset
27172 If this option is set and authentication debugging is enabled (see the &%-d%&
27173 command line option), the string is expanded and included in the debugging
27174 output when the authenticator is run as a server. This can help with checking
27175 out the values of variables.
27176 If expansion of the string fails, the error message is written to the debugging
27177 output, and Exim carries on processing.
27178
27179
27180 .option server_set_id authenticators string&!! unset
27181 .vindex "&$authenticated_id$&"
27182 .vindex "&$authenticated_fail_id$&"
27183 When an Exim server successfully authenticates a client, this string is
27184 expanded using data from the authentication, and preserved for any incoming
27185 messages in the variable &$authenticated_id$&. It is also included in the log
27186 lines for incoming messages. For example, a user/password authenticator
27187 configuration might preserve the user name that was used to authenticate, and
27188 refer to it subsequently during delivery of the message.
27189 On a failing authentication the expansion result is instead saved in
27190 the &$authenticated_fail_id$& variable.
27191 If expansion fails, the option is ignored.
27192
27193
27194 .option server_mail_auth_condition authenticators string&!! unset
27195 This option allows a server to discard authenticated sender addresses supplied
27196 as part of MAIL commands in SMTP connections that are authenticated by the
27197 driver on which &%server_mail_auth_condition%& is set. The option is not used
27198 as part of the authentication process; instead its (unexpanded) value is
27199 remembered for later use.
27200 How it is used is described in the following section.
27201
27202
27203
27204
27205
27206 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27207 .cindex "authentication" "sender; authenticated"
27208 .cindex "AUTH" "on MAIL command"
27209 When a client supplied an AUTH= item on a MAIL command, Exim applies
27210 the following checks before accepting it as the authenticated sender of the
27211 message:
27212
27213 .ilist
27214 If the connection is not using extended SMTP (that is, HELO was used rather
27215 than EHLO), the use of AUTH= is a syntax error.
27216 .next
27217 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27218 .next
27219 .vindex "&$authenticated_sender$&"
27220 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27221 running, the value of &$authenticated_sender$& is set to the value obtained
27222 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27223 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27224 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27225 given for the MAIL command.
27226 .next
27227 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27228 is accepted and placed in &$authenticated_sender$& only if the client has
27229 authenticated.
27230 .next
27231 If the AUTH= value was accepted by either of the two previous rules, and
27232 the client has authenticated, and the authenticator has a setting for the
27233 &%server_mail_auth_condition%&, the condition is checked at this point. The
27234 valued that was saved from the authenticator is expanded. If the expansion
27235 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27236 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27237 the value of &$authenticated_sender$& is retained and passed on with the
27238 message.
27239 .endlist
27240
27241
27242 When &$authenticated_sender$& is set for a message, it is passed on to other
27243 hosts to which Exim authenticates as a client. Do not confuse this value with
27244 &$authenticated_id$&, which is a string obtained from the authentication
27245 process, and which is not usually a complete email address.
27246
27247 .vindex "&$sender_address$&"
27248 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27249 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27250 therefore make use of &$authenticated_sender$&. The converse is not true: the
27251 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27252 ACL is run.
27253
27254
27255
27256 .section "Authentication on an Exim server" "SECTauthexiser"
27257 .cindex "authentication" "on an Exim server"
27258 When Exim receives an EHLO command, it advertises the public names of those
27259 authenticators that are configured as servers, subject to the following
27260 conditions:
27261
27262 .ilist
27263 The client host must match &%auth_advertise_hosts%& (default *).
27264 .next
27265 It the &%server_advertise_condition%& option is set, its expansion must not
27266 yield the empty string, &"0"&, &"no"&, or &"false"&.
27267 .endlist
27268
27269 The order in which the authenticators are defined controls the order in which
27270 the mechanisms are advertised.
27271
27272 Some mail clients (for example, some versions of Netscape) require the user to
27273 provide a name and password for authentication whenever AUTH is advertised,
27274 even though authentication may not in fact be needed (for example, Exim may be
27275 set up to allow unconditional relaying from the client by an IP address check).
27276 You can make such clients more friendly by not advertising AUTH to them.
27277 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27278 that runs for RCPT) to relay without authentication, you should set
27279 .code
27280 auth_advertise_hosts = ! 10.9.8.0/24
27281 .endd
27282 so that no authentication mechanisms are advertised to them.
27283
27284 The &%server_advertise_condition%& controls the advertisement of individual
27285 authentication mechanisms. For example, it can be used to restrict the
27286 advertisement of a particular mechanism to encrypted connections, by a setting
27287 such as:
27288 .code
27289 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27290 .endd
27291 .vindex "&$tls_in_cipher$&"
27292 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27293 yields &"yes"&, which allows the advertisement to happen.
27294
27295 When an Exim server receives an AUTH command from a client, it rejects it
27296 immediately if AUTH was not advertised in response to an earlier EHLO
27297 command. This is the case if
27298
27299 .ilist
27300 The client host does not match &%auth_advertise_hosts%&; or
27301 .next
27302 No authenticators are configured with server options; or
27303 .next
27304 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27305 server authenticators.
27306 .endlist
27307
27308
27309 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27310 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27311 AUTH is accepted from any client host.
27312
27313 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27314 server authentication mechanism that was advertised in response to EHLO and
27315 that matches the one named in the AUTH command. If it finds one, it runs
27316 the appropriate authentication protocol, and authentication either succeeds or
27317 fails. If there is no matching advertised mechanism, the AUTH command is
27318 rejected with a 504 error.
27319
27320 .vindex "&$received_protocol$&"
27321 .vindex "&$sender_host_authenticated$&"
27322 When a message is received from an authenticated host, the value of
27323 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27324 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27325 public name) of the authenticator driver that successfully authenticated the
27326 client from which the message was received. This variable is empty if there was
27327 no successful authentication.
27328
27329 .cindex authentication "expansion item"
27330 Successful authentication sets up information used by the
27331 &%authresults%& expansion item.
27332
27333
27334
27335
27336 .section "Testing server authentication" "SECID169"
27337 .cindex "authentication" "testing a server"
27338 .cindex "AUTH" "testing a server"
27339 .cindex "base64 encoding" "creating authentication test data"
27340 Exim's &%-bh%& option can be useful for testing server authentication
27341 configurations. The data for the AUTH command has to be sent using base64
27342 encoding. A quick way to produce such data for testing is the following Perl
27343 script:
27344 .code
27345 use MIME::Base64;
27346 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27347 .endd
27348 .cindex "binary zero" "in authentication data"
27349 This interprets its argument as a Perl string, and then encodes it. The
27350 interpretation as a Perl string allows binary zeros, which are required for
27351 some kinds of authentication, to be included in the data. For example, a
27352 command line to run this script on such data might be
27353 .code
27354 encode '\0user\0password'
27355 .endd
27356 Note the use of single quotes to prevent the shell interpreting the
27357 backslashes, so that they can be interpreted by Perl to specify characters
27358 whose code value is zero.
27359
27360 &*Warning 1*&: If either of the user or password strings starts with an octal
27361 digit, you must use three zeros instead of one after the leading backslash. If
27362 you do not, the octal digit that starts your string will be incorrectly
27363 interpreted as part of the code for the first character.
27364
27365 &*Warning 2*&: If there are characters in the strings that Perl interprets
27366 specially, you must use a Perl escape to prevent them being misinterpreted. For
27367 example, a command such as
27368 .code
27369 encode '\0user@domain.com\0pas$$word'
27370 .endd
27371 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27372
27373 If you have the &%mimencode%& command installed, another way to do produce
27374 base64-encoded strings is to run the command
27375 .code
27376 echo -e -n `\0user\0password' | mimencode
27377 .endd
27378 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27379 in the argument, and the &%-n%& option specifies no newline at the end of its
27380 output. However, not all versions of &%echo%& recognize these options, so you
27381 should check your version before relying on this suggestion.
27382
27383
27384
27385 .section "Authentication by an Exim client" "SECID170"
27386 .cindex "authentication" "on an Exim client"
27387 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27388 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27389 announces support for authentication, and the host matches an entry in either
27390 of these options, Exim (as a client) tries to authenticate as follows:
27391
27392 .ilist
27393 For each authenticator that is configured as a client, in the order in which
27394 they are defined in the configuration, it searches the authentication
27395 mechanisms announced by the server for one whose name matches the public name
27396 of the authenticator.
27397 .next
27398 .vindex "&$host$&"
27399 .vindex "&$host_address$&"
27400 When it finds one that matches, it runs the authenticator's client code. The
27401 variables &$host$& and &$host_address$& are available for any string expansions
27402 that the client might do. They are set to the server's name and IP address. If
27403 any expansion is forced to fail, the authentication attempt is abandoned, and
27404 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27405 delivery to be deferred.
27406 .next
27407 If the result of the authentication attempt is a temporary error or a timeout,
27408 Exim abandons trying to send the message to the host for the moment. It will
27409 try again later. If there are any backup hosts available, they are tried in the
27410 usual way.
27411 .next
27412 If the response to authentication is a permanent error (5&'xx'& code), Exim
27413 carries on searching the list of authenticators and tries another one if
27414 possible. If all authentication attempts give permanent errors, or if there are
27415 no attempts because no mechanisms match (or option expansions force failure),
27416 what happens depends on whether the host matches &%hosts_require_auth%& or
27417 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27418 delivery is deferred. The error can be detected in the retry rules, and thereby
27419 turned into a permanent error if you wish. In the second case, Exim tries to
27420 deliver the message unauthenticated.
27421 .endlist
27422
27423 Note that the hostlist test for whether to do authentication can be
27424 confused if name-IP lookups change between the time the peer is decided
27425 upon and the time that the transport runs.  For example, with a manualroute
27426 router given a host name, and with DNS "round-robin" used by that name: if
27427 the local resolver cache times out between the router and the transport
27428 running, the transport may get an IP for the name for its authentication
27429 check which does not match the connection peer IP.
27430 No authentication will then be done, despite the names being identical.
27431
27432 For such cases use a separate transport which always authenticates.
27433
27434 .cindex "AUTH" "on MAIL command"
27435 When Exim has authenticated itself to a remote server, it adds the AUTH
27436 parameter to the MAIL commands it sends, if it has an authenticated sender for
27437 the message. If the message came from a remote host, the authenticated sender
27438 is the one that was receiving on an incoming MAIL command, provided that the
27439 incoming connection was authenticated and the &%server_mail_auth%& condition
27440 allowed the authenticated sender to be retained. If a local process calls Exim
27441 to send a message, the sender address that is built from the login name and
27442 &%qualify_domain%& is treated as authenticated. However, if the
27443 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27444 the authenticated sender that was received with the message.
27445 .ecindex IIDauthconf1
27446 .ecindex IIDauthconf2
27447
27448
27449
27450
27451
27452
27453 . ////////////////////////////////////////////////////////////////////////////
27454 . ////////////////////////////////////////////////////////////////////////////
27455
27456 .chapter "The plaintext authenticator" "CHAPplaintext"
27457 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27458 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27459 The &(plaintext)& authenticator can be configured to support the PLAIN and
27460 LOGIN authentication mechanisms, both of which transfer authentication data as
27461 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27462 security risk; you are strongly advised to insist on the use of SMTP encryption
27463 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27464 use unencrypted plain text, you should not use the same passwords for SMTP
27465 connections as you do for login accounts.
27466
27467 .section "Avoiding cleartext use" "SECTplain_TLS"
27468 The following generic option settings will disable &(plaintext)& authenticators when
27469 TLS is not being used:
27470 .code
27471   server_advertise_condition = ${if def:tls_in_cipher }
27472   client_condition =           ${if def:tls_out_cipher}
27473 .endd
27474
27475 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27476 but is still vulnerable to a Man In The Middle attack unless certificates
27477 (including their names) have been properly verified.
27478
27479 .section "Plaintext server options" "SECID171"
27480 .cindex "options" "&(plaintext)& authenticator (server)"
27481 When configured as a server, &(plaintext)& uses the following options:
27482
27483 .option server_condition authenticators string&!! unset
27484 This is actually a global authentication option, but it must be set in order to
27485 configure the &(plaintext)& driver as a server. Its use is described below.
27486
27487 .option server_prompts plaintext "string list&!!" unset
27488 The contents of this option, after expansion, must be a colon-separated list of
27489 prompt strings. If expansion fails, a temporary authentication rejection is
27490 given.
27491
27492 .section "Using plaintext in a server" "SECTplainserver"
27493 .cindex "AUTH" "in &(plaintext)& authenticator"
27494 .cindex "binary zero" "in &(plaintext)& authenticator"
27495 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27496         "in &(plaintext)& authenticator"
27497 .vindex "&$auth1$&, &$auth2$&, etc"
27498 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27499
27500 When running as a server, &(plaintext)& performs the authentication test by
27501 expanding a string. The data sent by the client with the AUTH command, or in
27502 response to subsequent prompts, is base64 encoded, and so may contain any byte
27503 values when decoded. If any data is supplied with the command, it is treated as
27504 a list of strings, separated by NULs (binary zeros), the first three of which
27505 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27506 (neither LOGIN nor PLAIN uses more than three strings).
27507
27508 For compatibility with previous releases of Exim, the values are also placed in
27509 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27510 variables for this purpose is now deprecated, as it can lead to confusion in
27511 string expansions that also use them for other things.
27512
27513 If there are more strings in &%server_prompts%& than the number of strings
27514 supplied with the AUTH command, the remaining prompts are used to obtain more
27515 data. Each response from the client may be a list of NUL-separated strings.
27516
27517 .vindex "&$authenticated_id$&"
27518 Once a sufficient number of data strings have been received,
27519 &%server_condition%& is expanded. If the expansion is forced to fail,
27520 authentication fails. Any other expansion failure causes a temporary error code
27521 to be returned. If the result of a successful expansion is an empty string,
27522 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27523 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27524 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27525 For any other result, a temporary error code is returned, with the expanded
27526 string as the error text.
27527
27528 &*Warning*&: If you use a lookup in the expansion to find the user's
27529 password, be sure to make the authentication fail if the user is unknown.
27530 There are good and bad examples at the end of the next section.
27531
27532
27533
27534 .section "The PLAIN authentication mechanism" "SECID172"
27535 .cindex "PLAIN authentication mechanism"
27536 .cindex authentication PLAIN
27537 .cindex "binary zero" "in &(plaintext)& authenticator"
27538 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27539 sent as one item of data (that is, one combined string containing two NUL
27540 separators). The data is sent either as part of the AUTH command, or
27541 subsequently in response to an empty prompt from the server.
27542
27543 The second and third strings are a user name and a corresponding password.
27544 Using a single fixed user name and password as an example, this could be
27545 configured as follows:
27546 .code
27547 fixed_plain:
27548   driver = plaintext
27549   public_name = PLAIN
27550   server_prompts = :
27551   server_condition = \
27552     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27553   server_set_id = $auth2
27554 .endd
27555 Note that the default result strings from &%if%& (&"true"& or an empty string)
27556 are exactly what we want here, so they need not be specified. Obviously, if the
27557 password contains expansion-significant characters such as dollar, backslash,
27558 or closing brace, they have to be escaped.
27559
27560 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27561 the end of a string list are ignored). If all the data comes as part of the
27562 AUTH command, as is commonly the case, the prompt is not used. This
27563 authenticator is advertised in the response to EHLO as
27564 .code
27565 250-AUTH PLAIN
27566 .endd
27567 and a client host can authenticate itself by sending the command
27568 .code
27569 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27570 .endd
27571 As this contains three strings (more than the number of prompts), no further
27572 data is required from the client. Alternatively, the client may just send
27573 .code
27574 AUTH PLAIN
27575 .endd
27576 to initiate authentication, in which case the server replies with an empty
27577 prompt. The client must respond with the combined data string.
27578
27579 The data string is base64 encoded, as required by the RFC. This example,
27580 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27581 represents a zero byte. This is split up into three strings, the first of which
27582 is empty. The &%server_condition%& option in the authenticator checks that the
27583 second two are &`username`& and &`mysecret`& respectively.
27584
27585 Having just one fixed user name and password, as in this example, is not very
27586 realistic, though for a small organization with only a handful of
27587 authenticating clients it could make sense.
27588
27589 A more sophisticated instance of this authenticator could use the user name in
27590 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27591 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27592 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27593 This is an incorrect example:
27594 .code
27595 server_condition = \
27596   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27597 .endd
27598 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27599 which it then compares to the supplied password (&$auth3$&). Why is this example
27600 incorrect? It works fine for existing users, but consider what happens if a
27601 non-existent user name is given. The lookup fails, but as no success/failure
27602 strings are given for the lookup, it yields an empty string. Thus, to defeat
27603 the authentication, all a client has to do is to supply a non-existent user
27604 name and an empty password. The correct way of writing this test is:
27605 .code
27606 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27607   {${if eq{$value}{$auth3}}} {false}}
27608 .endd
27609 In this case, if the lookup succeeds, the result is checked; if the lookup
27610 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27611 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27612 always fails if its second argument is empty. However, the second way of
27613 writing the test makes the logic clearer.
27614
27615
27616 .section "The LOGIN authentication mechanism" "SECID173"
27617 .cindex "LOGIN authentication mechanism"
27618 .cindex authentication LOGIN
27619 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27620 in a number of programs. No data is sent with the AUTH command. Instead, a
27621 user name and password are supplied separately, in response to prompts. The
27622 plaintext authenticator can be configured to support this as in this example:
27623 .code
27624 fixed_login:
27625   driver = plaintext
27626   public_name = LOGIN
27627   server_prompts = User Name : Password
27628   server_condition = \
27629     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27630   server_set_id = $auth1
27631 .endd
27632 Because of the way plaintext operates, this authenticator accepts data supplied
27633 with the AUTH command (in contravention of the specification of LOGIN), but
27634 if the client does not supply it (as is the case for LOGIN clients), the prompt
27635 strings are used to obtain two data items.
27636
27637 Some clients are very particular about the precise text of the prompts. For
27638 example, Outlook Express is reported to recognize only &"Username:"& and
27639 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27640 strings. It uses the &%ldapauth%& expansion condition to check the user
27641 name and password by binding to an LDAP server:
27642 .code
27643 login:
27644   driver = plaintext
27645   public_name = LOGIN
27646   server_prompts = Username:: : Password::
27647   server_condition = ${if and{{ \
27648     !eq{}{$auth1} }{ \
27649     ldapauth{\
27650       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27651       pass=${quote:$auth2} \
27652       ldap://ldap.example.org/} }} }
27653   server_set_id = uid=$auth1,ou=people,o=example.org
27654 .endd
27655 We have to check that the username is not empty before using it, because LDAP
27656 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27657 operator to correctly quote the DN for authentication. However, the basic
27658 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27659 correct one to use for the password, because quoting is needed only to make
27660 the password conform to the Exim syntax. At the LDAP level, the password is an
27661 uninterpreted string.
27662
27663
27664 .section "Support for different kinds of authentication" "SECID174"
27665 A number of string expansion features are provided for the purpose of
27666 interfacing to different ways of user authentication. These include checking
27667 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27668 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27669 &<<SECTexpcond>>&.
27670
27671
27672
27673
27674 .section "Using plaintext in a client" "SECID175"
27675 .cindex "options" "&(plaintext)& authenticator (client)"
27676 The &(plaintext)& authenticator has two client options:
27677
27678 .option client_ignore_invalid_base64 plaintext boolean false
27679 If the client receives a server prompt that is not a valid base64 string,
27680 authentication is abandoned by default. However, if this option is set true,
27681 the error in the challenge is ignored and the client sends the response as
27682 usual.
27683
27684 .option client_send plaintext string&!! unset
27685 The string is a colon-separated list of authentication data strings. Each
27686 string is independently expanded before being sent to the server. The first
27687 string is sent with the AUTH command; any more strings are sent in response
27688 to prompts from the server. Before each string is expanded, the value of the
27689 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27690 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27691 way. Thus, the prompt that is received in response to sending the first string
27692 (with the AUTH command) can be used in the expansion of the second string, and
27693 so on. If an invalid base64 string is received when
27694 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27695 &$auth$&<&'n'&> variable.
27696
27697 &*Note*&: You cannot use expansion to create multiple strings, because
27698 splitting takes priority and happens first.
27699
27700 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27701 the data, further processing is applied to each string before it is sent. If
27702 there are any single circumflex characters in the string, they are converted to
27703 NULs. Should an actual circumflex be required as data, it must be doubled in
27704 the string.
27705
27706 This is an example of a client configuration that implements the PLAIN
27707 authentication mechanism with a fixed user name and password:
27708 .code
27709 fixed_plain:
27710   driver = plaintext
27711   public_name = PLAIN
27712   client_send = ^username^mysecret
27713 .endd
27714 The lack of colons means that the entire text is sent with the AUTH
27715 command, with the circumflex characters converted to NULs. A similar example
27716 that uses the LOGIN mechanism is:
27717 .code
27718 fixed_login:
27719   driver = plaintext
27720   public_name = LOGIN
27721   client_send = : username : mysecret
27722 .endd
27723 The initial colon means that the first string is empty, so no data is sent with
27724 the AUTH command itself. The remaining strings are sent in response to
27725 prompts.
27726 .ecindex IIDplaiauth1
27727 .ecindex IIDplaiauth2
27728
27729
27730
27731
27732 . ////////////////////////////////////////////////////////////////////////////
27733 . ////////////////////////////////////////////////////////////////////////////
27734
27735 .chapter "The cram_md5 authenticator" "CHID9"
27736 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27737 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27738 .cindex "CRAM-MD5 authentication mechanism"
27739 .cindex authentication CRAM-MD5
27740 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27741 sends a challenge string to the client, and the response consists of a user
27742 name and the CRAM-MD5 digest of the challenge string combined with a secret
27743 string (password) which is known to both server and client. Thus, the secret
27744 is not sent over the network as plain text, which makes this authenticator more
27745 secure than &(plaintext)&. However, the downside is that the secret has to be
27746 available in plain text at either end.
27747
27748
27749 .section "Using cram_md5 as a server" "SECID176"
27750 .cindex "options" "&(cram_md5)& authenticator (server)"
27751 This authenticator has one server option, which must be set to configure the
27752 authenticator as a server:
27753
27754 .option server_secret cram_md5 string&!! unset
27755 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27756 When the server receives the client's response, the user name is placed in
27757 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27758 obtain the password for that user. The server then computes the CRAM-MD5 digest
27759 that the client should have sent, and checks that it received the correct
27760 string. If the expansion of &%server_secret%& is forced to fail, authentication
27761 fails. If the expansion fails for some other reason, a temporary error code is
27762 returned to the client.
27763
27764 For compatibility with previous releases of Exim, the user name is also placed
27765 in &$1$&. However, the use of this variables for this purpose is now
27766 deprecated, as it can lead to confusion in string expansions that also use
27767 numeric variables for other things.
27768
27769 For example, the following authenticator checks that the user name given by the
27770 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27771 user name, authentication fails.
27772 .code
27773 fixed_cram:
27774   driver = cram_md5
27775   public_name = CRAM-MD5
27776   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27777   server_set_id = $auth1
27778 .endd
27779 .vindex "&$authenticated_id$&"
27780 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27781 name in &$authenticated_id$&. A more typical configuration might look up the
27782 secret string in a file, using the user name as the key. For example:
27783 .code
27784 lookup_cram:
27785   driver = cram_md5
27786   public_name = CRAM-MD5
27787   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27788                   {$value}fail}
27789   server_set_id = $auth1
27790 .endd
27791 Note that this expansion explicitly forces failure if the lookup fails
27792 because &$auth1$& contains an unknown user name.
27793
27794 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27795 using the relevant libraries, you need to know the realm to specify in the
27796 lookup and then ask for the &"userPassword"& attribute for that user in that
27797 realm, with:
27798 .code
27799 cyrusless_crammd5:
27800   driver = cram_md5
27801   public_name = CRAM-MD5
27802   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27803                   dbmjz{/etc/sasldb2}{$value}fail}
27804   server_set_id = $auth1
27805 .endd
27806
27807 .section "Using cram_md5 as a client" "SECID177"
27808 .cindex "options" "&(cram_md5)& authenticator (client)"
27809 When used as a client, the &(cram_md5)& authenticator has two options:
27810
27811
27812
27813 .option client_name cram_md5 string&!! "the primary host name"
27814 This string is expanded, and the result used as the user name data when
27815 computing the response to the server's challenge.
27816
27817
27818 .option client_secret cram_md5 string&!! unset
27819 This option must be set for the authenticator to work as a client. Its value is
27820 expanded and the result used as the secret string when computing the response.
27821
27822
27823 .vindex "&$host$&"
27824 .vindex "&$host_address$&"
27825 Different user names and secrets can be used for different servers by referring
27826 to &$host$& or &$host_address$& in the options. Forced failure of either
27827 expansion string is treated as an indication that this authenticator is not
27828 prepared to handle this case. Exim moves on to the next configured client
27829 authenticator. Any other expansion failure causes Exim to give up trying to
27830 send the message to the current server.
27831
27832 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27833 strings, is:
27834 .code
27835 fixed_cram:
27836   driver = cram_md5
27837   public_name = CRAM-MD5
27838   client_name = ph10
27839   client_secret = secret
27840 .endd
27841 .ecindex IIDcramauth1
27842 .ecindex IIDcramauth2
27843
27844
27845
27846 . ////////////////////////////////////////////////////////////////////////////
27847 . ////////////////////////////////////////////////////////////////////////////
27848
27849 .chapter "The cyrus_sasl authenticator" "CHID10"
27850 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27851 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27852 .cindex "Cyrus" "SASL library"
27853 .cindex "Kerberos"
27854 The code for this authenticator was provided by Matthew Byng-Maddick while
27855 at A L Digital Ltd.
27856
27857 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27858 library implementation of the RFC 2222 (&"Simple Authentication and Security
27859 Layer"&). This library supports a number of authentication mechanisms,
27860 including PLAIN and LOGIN, but also several others that Exim does not support
27861 directly. In particular, there is support for Kerberos authentication.
27862
27863 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27864 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27865 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27866 name of the driver to determine which mechanism to support.
27867
27868 Where access to some kind of secret file is required, for example, in GSSAPI
27869 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27870 user, and that the Cyrus SASL library has no way of escalating privileges
27871 by default. You may also find you need to set environment variables,
27872 depending on the driver you are using.
27873
27874 The application name provided by Exim is &"exim"&, so various SASL options may
27875 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27876 Kerberos, note that because of limitations in the GSSAPI interface,
27877 changing the server keytab might need to be communicated down to the Kerberos
27878 layer independently. The mechanism for doing so is dependent upon the Kerberos
27879 implementation.
27880
27881 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27882 may be set to point to an alternative keytab file. Exim will pass this
27883 variable through from its own inherited environment when started as root or the
27884 Exim user. The keytab file needs to be readable by the Exim user.
27885 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27886 environment variable.  In practice, for those releases, the Cyrus authenticator
27887 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27888 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27889
27890
27891 .section "Using cyrus_sasl as a server" "SECID178"
27892 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27893 (on a successful authentication) into &$auth1$&. For compatibility with
27894 previous releases of Exim, the username is also placed in &$1$&. However, the
27895 use of this variable for this purpose is now deprecated, as it can lead to
27896 confusion in string expansions that also use numeric variables for other
27897 things.
27898
27899
27900 .option server_hostname cyrus_sasl string&!! "see below"
27901 This option selects the hostname that is used when communicating with the
27902 library. The default value is &`$primary_hostname`&. It is up to the underlying
27903 SASL plug-in what it does with this data.
27904
27905
27906 .option server_mech cyrus_sasl string "see below"
27907 This option selects the authentication mechanism this driver should use. The
27908 default is the value of the generic &%public_name%& option. This option allows
27909 you to use a different underlying mechanism from the advertised name. For
27910 example:
27911 .code
27912 sasl:
27913   driver = cyrus_sasl
27914   public_name = X-ANYTHING
27915   server_mech = CRAM-MD5
27916   server_set_id = $auth1
27917 .endd
27918
27919 .option server_realm cyrus_sasl string&!! unset
27920 This specifies the SASL realm that the server claims to be in.
27921
27922
27923 .option server_service cyrus_sasl string &`smtp`&
27924 This is the SASL service that the server claims to implement.
27925
27926
27927 For straightforward cases, you do not need to set any of the authenticator's
27928 private options. All you need to do is to specify an appropriate mechanism as
27929 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27930 PLAIN, you could have two authenticators as follows:
27931 .code
27932 sasl_cram_md5:
27933   driver = cyrus_sasl
27934   public_name = CRAM-MD5
27935   server_set_id = $auth1
27936
27937 sasl_plain:
27938   driver = cyrus_sasl
27939   public_name = PLAIN
27940   server_set_id = $auth2
27941 .endd
27942 Cyrus SASL does implement the LOGIN authentication method, even though it is
27943 not a standard method. It is disabled by default in the source distribution,
27944 but it is present in many binary distributions.
27945 .ecindex IIDcyrauth1
27946 .ecindex IIDcyrauth2
27947
27948
27949
27950
27951 . ////////////////////////////////////////////////////////////////////////////
27952 . ////////////////////////////////////////////////////////////////////////////
27953 .chapter "The dovecot authenticator" "CHAPdovecot"
27954 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27955 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27956 This authenticator is an interface to the authentication facility of the
27957 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27958 Note that Dovecot must be configured to use auth-client not auth-userdb.
27959 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27960 to use the same mechanisms for SMTP authentication. This is a server
27961 authenticator only. There is only one option:
27962
27963 .option server_socket dovecot string unset
27964
27965 This option must specify the UNIX socket that is the interface to Dovecot
27966 authentication. The &%public_name%& option must specify an authentication
27967 mechanism that Dovecot is configured to support. You can have several
27968 authenticators for different mechanisms. For example:
27969 .code
27970 dovecot_plain:
27971   driver = dovecot
27972   public_name = PLAIN
27973   server_socket = /var/run/dovecot/auth-client
27974   server_set_id = $auth1
27975
27976 dovecot_ntlm:
27977   driver = dovecot
27978   public_name = NTLM
27979   server_socket = /var/run/dovecot/auth-client
27980   server_set_id = $auth1
27981 .endd
27982 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27983 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27984 option is passed in the Dovecot authentication command. If, for a TLS
27985 connection, a client certificate has been verified, the &"valid-client-cert"&
27986 option is passed. When authentication succeeds, the identity of the user
27987 who authenticated is placed in &$auth1$&.
27988
27989 The Dovecot configuration to match the above wil look
27990 something like:
27991 .code
27992 conf.d/10-master.conf :-
27993
27994 service auth {
27995 ...
27996 #SASL
27997   unix_listener auth-client {
27998     mode = 0660
27999     user = mail
28000   }
28001 ...
28002 }
28003
28004 conf.d/10-auth.conf :-
28005
28006 auth_mechanisms = plain login ntlm
28007 .endd
28008
28009 .ecindex IIDdcotauth1
28010 .ecindex IIDdcotauth2
28011
28012
28013 . ////////////////////////////////////////////////////////////////////////////
28014 . ////////////////////////////////////////////////////////////////////////////
28015 .chapter "The gsasl authenticator" "CHAPgsasl"
28016 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28017 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28018 .cindex "authentication" "GNU SASL"
28019 .cindex "authentication" "SASL"
28020 .cindex "authentication" "EXTERNAL"
28021 .cindex "authentication" "ANONYMOUS"
28022 .cindex "authentication" "PLAIN"
28023 .cindex "authentication" "LOGIN"
28024 .cindex "authentication" "DIGEST-MD5"
28025 .cindex "authentication" "CRAM-MD5"
28026 .cindex "authentication" "SCRAM family"
28027 The &(gsasl)& authenticator provides integration for the GNU SASL
28028 library and the mechanisms it provides.  This is new as of the 4.80 release
28029 and there are a few areas where the library does not let Exim smoothly
28030 scale to handle future authentication mechanisms, so no guarantee can be
28031 made that any particular new authentication mechanism will be supported
28032 without code changes in Exim.
28033
28034 The library is expected to add support in an upcoming
28035 realease for the SCRAM-SHA-256 method.
28036 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28037 when this happens.
28038
28039
28040 .option client_authz gsasl string&!! unset
28041 This option can be used to supply an &'authorization id'&
28042 which is different to the &'authentication_id'& provided
28043 by &%client_username%& option.
28044 If unset or (after expansion) empty it is not used,
28045 which is the common case.
28046
28047 .option client_channelbinding gsasl boolean false
28048 See &%server_channelbinding%& below.
28049
28050 .option client_password gsasl string&!! unset
28051 This option is exapanded before use, and should result in
28052 the password to be used, in clear.
28053
28054 .option client_username gsasl string&!! unset
28055 This option is exapanded before use, and should result in
28056 the account name to be used.
28057
28058 .option client_spassword gsasl string&!! unset
28059 If a SCRAM mechanism is being used and this option is set
28060 it is used in preference to &%client_password%&.
28061 The value after expansion should be
28062 a 40 (for SHA-1) or 64 (for SHA-256) character string
28063 with the PBKDF2-prepared password, hex-encoded.
28064 Note that this value will depend on the salt and iteration-count
28065 supplied by the server.
28066
28067
28068
28069 .option server_channelbinding gsasl boolean false
28070 Do not set this true and rely on the properties
28071 without consulting a cryptographic engineer.
28072
28073 Some authentication mechanisms are able to use external context at both ends
28074 of the session to bind the authentication to that context, and fail the
28075 authentication process if that context differs.  Specifically, some TLS
28076 ciphersuites can provide identifying information about the cryptographic
28077 context.
28078
28079 This should have meant that certificate identity and verification becomes a
28080 non-issue, as a man-in-the-middle attack will cause the correct client and
28081 server to see different identifiers and authentication will fail.
28082
28083 This is
28084 only usable by mechanisms which support "channel binding"; at time of
28085 writing, that's the SCRAM family.
28086 When using this feature the "-PLUS" variants of the method names need to be used.
28087
28088 This defaults off to ensure smooth upgrade across Exim releases, in case
28089 this option causes some clients to start failing.  Some future release
28090 of Exim might have switched the default to be true.
28091
28092 However, Channel Binding in TLS has proven to be vulnerable in current versions.
28093 Do not plan to rely upon this feature for security, ever, without consulting
28094 with a subject matter expert (a cryptographic engineer).
28095
28096
28097 .option server_hostname gsasl string&!! "see below"
28098 This option selects the hostname that is used when communicating with the
28099 library. The default value is &`$primary_hostname`&.
28100 Some mechanisms will use this data.
28101
28102
28103 .option server_mech gsasl string "see below"
28104 This option selects the authentication mechanism this driver should use. The
28105 default is the value of the generic &%public_name%& option. This option allows
28106 you to use a different underlying mechanism from the advertised name. For
28107 example:
28108 .code
28109 sasl:
28110   driver = gsasl
28111   public_name = X-ANYTHING
28112   server_mech = CRAM-MD5
28113   server_set_id = $auth1
28114 .endd
28115
28116
28117 .option server_password gsasl string&!! unset
28118 Various mechanisms need access to the cleartext password on the server, so
28119 that proof-of-possession can be demonstrated on the wire, without sending
28120 the password itself.
28121
28122 The data available for lookup varies per mechanism.
28123 In all cases, &$auth1$& is set to the &'authentication id'&.
28124 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28125 if available, else the empty string.
28126 The &$auth3$& variable will always be the &'realm'& if available,
28127 else the empty string.
28128
28129 A forced failure will cause authentication to defer.
28130
28131 If using this option, it may make sense to set the &%server_condition%&
28132 option to be simply "true".
28133
28134
28135 .option server_realm gsasl string&!! unset
28136 This specifies the SASL realm that the server claims to be in.
28137 Some mechanisms will use this data.
28138
28139
28140 .option server_scram_iter gsasl string&!! 4096
28141 This option provides data for the SCRAM family of mechanisms.
28142 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28143 when this option is expanded.
28144
28145 The result of expansion should be a decimal number,
28146 and represents both a lower-bound on the security, and
28147 a compute cost factor imposed on the client
28148 (if it does not cache results, or the server changes
28149 either the iteration count or the salt).
28150 A minimum value of 4096 is required by the standards
28151 for all current SCRAM mechanism variants.
28152
28153 .option server_scram_salt gsasl string&!! unset
28154 This option provides data for the SCRAM family of mechanisms.
28155 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28156 when this option is expanded.
28157 The value should be a base64-encoded string,
28158 of random data typically 4-to-16 bytes long.
28159 If unset or empty after expansion the library will provides a value for the
28160 protocol conversation.
28161
28162
28163 .option server_key gsasl string&!! unset
28164 .option server_skey gsasl string&!! unset
28165 These options can be used for the SCRAM family of mechanisms
28166 to provide stored information related to a password,
28167 the storage of which is preferable to plaintext.
28168
28169 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28170 &%server_skey%& is StoredKey.
28171
28172 They are only available for version 1.9.0 (or later) of the gsasl library.
28173 When this is so, the macros
28174 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28175 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28176 will be defined.
28177
28178 The &$authN$& variables are available when these options are expanded.
28179
28180 If set, the results of expansion should for each
28181 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28182 of base64-coded data, and will be used in preference to the
28183 &%server_password%& option.
28184 If unset or not of the right length, &%server_password%& will be used.
28185
28186 The libgsasl library release includes a utility &'gsasl'& which can be used
28187 to generate these values.
28188
28189
28190 .option server_service gsasl string &`smtp`&
28191 This is the SASL service that the server claims to implement.
28192 Some mechanisms will use this data.
28193
28194
28195 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28196 .vindex "&$auth1$&, &$auth2$&, etc"
28197 These may be set when evaluating specific options, as detailed above.
28198 They will also be set when evaluating &%server_condition%&.
28199
28200 Unless otherwise stated below, the &(gsasl)& integration will use the following
28201 meanings for these variables:
28202
28203 .ilist
28204 .vindex "&$auth1$&"
28205 &$auth1$&: the &'authentication id'&
28206 .next
28207 .vindex "&$auth2$&"
28208 &$auth2$&: the &'authorization id'&
28209 .next
28210 .vindex "&$auth3$&"
28211 &$auth3$&: the &'realm'&
28212 .endlist
28213
28214 On a per-mechanism basis:
28215
28216 .ilist
28217 .cindex "authentication" "EXTERNAL"
28218 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28219 the &%server_condition%& option must be present.
28220 .next
28221 .cindex "authentication" "ANONYMOUS"
28222 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28223 the &%server_condition%& option must be present.
28224 .next
28225 .cindex "authentication" "GSSAPI"
28226 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28227 &$auth2$& will be set to the &'authorization id'&,
28228 the &%server_condition%& option must be present.
28229 .endlist
28230
28231 An &'anonymous token'& is something passed along as an unauthenticated
28232 identifier; this is analogous to FTP anonymous authentication passing an
28233 email address, or software-identifier@, as the "password".
28234
28235
28236 An example showing the password having the realm specified in the callback
28237 and demonstrating a Cyrus SASL to GSASL migration approach is:
28238 .code
28239 gsasl_cyrusless_crammd5:
28240   driver = gsasl
28241   public_name = CRAM-MD5
28242   server_realm = imap.example.org
28243   server_password = ${lookup{$auth1:$auth3:userPassword}\
28244                     dbmjz{/etc/sasldb2}{$value}fail}
28245   server_set_id = ${quote:$auth1}
28246   server_condition = yes
28247 .endd
28248
28249
28250 . ////////////////////////////////////////////////////////////////////////////
28251 . ////////////////////////////////////////////////////////////////////////////
28252
28253 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28254 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28255 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28256 .cindex "authentication" "GSSAPI"
28257 .cindex "authentication" "Kerberos"
28258 The &(heimdal_gssapi)& authenticator provides server integration for the
28259 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28260 reliably.
28261
28262 .option server_hostname heimdal_gssapi string&!! "see below"
28263 This option selects the hostname that is used, with &%server_service%&,
28264 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28265 identifier.  The default value is &`$primary_hostname`&.
28266
28267 .option server_keytab heimdal_gssapi string&!! unset
28268 If set, then Heimdal will not use the system default keytab (typically
28269 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28270 The value should be a pathname, with no &"file:"& prefix.
28271
28272 .option server_service heimdal_gssapi string&!! "smtp"
28273 This option specifies the service identifier used, in conjunction with
28274 &%server_hostname%&, for building the identifier for finding credentials
28275 from the keytab.
28276
28277
28278 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28279 Beware that these variables will typically include a realm, thus will appear
28280 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28281 not verified, so a malicious client can set it to anything.
28282
28283 The &$auth1$& field should be safely trustable as a value from the Key
28284 Distribution Center.  Note that these are not quite email addresses.
28285 Each identifier is for a role, and so the left-hand-side may include a
28286 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28287
28288 .vindex "&$auth1$&, &$auth2$&, etc"
28289 .ilist
28290 .vindex "&$auth1$&"
28291 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28292 .next
28293 .vindex "&$auth2$&"
28294 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28295 authentication.  If that was empty, this will also be set to the
28296 GSS Display Name.
28297 .endlist
28298
28299
28300 . ////////////////////////////////////////////////////////////////////////////
28301 . ////////////////////////////////////////////////////////////////////////////
28302
28303 .chapter "The spa authenticator" "CHAPspa"
28304 .scindex IIDspaauth1 "&(spa)& authenticator"
28305 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28306 .cindex "authentication" "Microsoft Secure Password"
28307 .cindex "authentication" "NTLM"
28308 .cindex "Microsoft Secure Password Authentication"
28309 .cindex "NTLM authentication"
28310 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28311 Password Authentication'& mechanism,
28312 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28313 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28314 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28315 server side was subsequently contributed by Tom Kistner. The mechanism works as
28316 follows:
28317
28318 .ilist
28319 After the AUTH command has been accepted, the client sends an SPA
28320 authentication request based on the user name and optional domain.
28321 .next
28322 The server sends back a challenge.
28323 .next
28324 The client builds a challenge response which makes use of the user's password
28325 and sends it to the server, which then accepts or rejects it.
28326 .endlist
28327
28328 Encryption is used to protect the password in transit.
28329
28330
28331
28332 .section "Using spa as a server" "SECID179"
28333 .cindex "options" "&(spa)& authenticator (server)"
28334 The &(spa)& authenticator has just one server option:
28335
28336 .option server_password spa string&!! unset
28337 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28338 This option is expanded, and the result must be the cleartext password for the
28339 authenticating user, whose name is at this point in &$auth1$&. For
28340 compatibility with previous releases of Exim, the user name is also placed in
28341 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28342 it can lead to confusion in string expansions that also use numeric variables
28343 for other things. For example:
28344 .code
28345 spa:
28346   driver = spa
28347   public_name = NTLM
28348   server_password = \
28349     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28350 .endd
28351 If the expansion is forced to fail, authentication fails. Any other expansion
28352 failure causes a temporary error code to be returned.
28353
28354
28355
28356
28357
28358 .section "Using spa as a client" "SECID180"
28359 .cindex "options" "&(spa)& authenticator (client)"
28360 The &(spa)& authenticator has the following client options:
28361
28362
28363
28364 .option client_domain spa string&!! unset
28365 This option specifies an optional domain for the authentication.
28366
28367
28368 .option client_password spa string&!! unset
28369 This option specifies the user's password, and must be set.
28370
28371
28372 .option client_username spa string&!! unset
28373 This option specifies the user name, and must be set. Here is an example of a
28374 configuration of this authenticator for use with the mail servers at
28375 &'msn.com'&:
28376 .code
28377 msn:
28378   driver = spa
28379   public_name = MSN
28380   client_username = msn/msn_username
28381   client_password = msn_plaintext_password
28382   client_domain = DOMAIN_OR_UNSET
28383 .endd
28384 .ecindex IIDspaauth1
28385 .ecindex IIDspaauth2
28386
28387
28388
28389
28390
28391 . ////////////////////////////////////////////////////////////////////////////
28392 . ////////////////////////////////////////////////////////////////////////////
28393
28394 .chapter "The external authenticator" "CHAPexternauth"
28395 .scindex IIDexternauth1 "&(external)& authenticator"
28396 .scindex IIDexternauth2 "authenticators" "&(external)&"
28397 .cindex "authentication" "Client Certificate"
28398 .cindex "authentication" "X509"
28399 .cindex "Certificate-based authentication"
28400 The &(external)& authenticator provides support for
28401 authentication based on non-SMTP information.
28402 The specification is in RFC 4422 Appendix A
28403 (&url(https://tools.ietf.org/html/rfc4422)).
28404 It is only a transport and negotiation mechanism;
28405 the process of authentication is entirely controlled
28406 by the server configuration.
28407
28408 The client presents an identity in-clear.
28409 It is probably wise for a server to only advertise,
28410 and for clients to only attempt,
28411 this authentication method on a secure (eg. under TLS) connection.
28412
28413 One possible use, compatible with the
28414 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28415 is for using X509 client certificates.
28416
28417 It thus overlaps in function with the TLS authenticator
28418 (see &<<CHAPtlsauth>>&)
28419 but is a full SMTP SASL authenticator
28420 rather than being implicit for TLS-connection carried
28421 client certificates only.
28422
28423 The examples and discussion in this chapter assume that
28424 client-certificate authentication is being done.
28425
28426 The client must present a certificate,
28427 for which it must have been requested via the
28428 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28429 (see &<<CHAPTLS>>&).
28430 For authentication to be effective the certificate should be
28431 verifiable against a trust-anchor certificate known to the server.
28432
28433 .section "External options" "SECTexternsoptions"
28434 .cindex "options" "&(external)& authenticator (server)"
28435 The &(external)& authenticator has two server options:
28436
28437 .option server_param2 external string&!! unset
28438 .option server_param3 external string&!! unset
28439 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28440 These options are expanded before the &%server_condition%& option
28441 and the result are placed in &$auth2$& and &$auth3$& resectively.
28442 If the expansion is forced to fail, authentication fails. Any other expansion
28443 failure causes a temporary error code to be returned.
28444
28445 They can be used to clarify the coding of a complex &%server_condition%&.
28446
28447 .section "Using external in a server" "SECTexternserver"
28448 .cindex "AUTH" "in &(external)& authenticator"
28449 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28450         "in &(external)& authenticator"
28451 .vindex "&$auth1$&, &$auth2$&, etc"
28452 .cindex "base64 encoding" "in &(external)& authenticator"
28453
28454 When running as a server, &(external)& performs the authentication test by
28455 expanding a string. The data sent by the client with the AUTH command, or in
28456 response to subsequent prompts, is base64 encoded, and so may contain any byte
28457 values when decoded. The decoded value is treated as
28458 an identity for authentication and
28459 placed in the expansion variable &$auth1$&.
28460
28461 For compatibility with previous releases of Exim, the value is also placed in
28462 the expansion variable &$1$&. However, the use of this
28463 variable for this purpose is now deprecated, as it can lead to confusion in
28464 string expansions that also use them for other things.
28465
28466 .vindex "&$authenticated_id$&"
28467 Once an identity has been received,
28468 &%server_condition%& is expanded. If the expansion is forced to fail,
28469 authentication fails. Any other expansion failure causes a temporary error code
28470 to be returned. If the result of a successful expansion is an empty string,
28471 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28472 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28473 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28474 For any other result, a temporary error code is returned, with the expanded
28475 string as the error text.
28476
28477 Example:
28478 .code
28479 ext_ccert_san_mail:
28480   driver =            external
28481   public_name =       EXTERNAL
28482
28483   server_advertise_condition = $tls_in_certificate_verified
28484   server_param2 =     ${certextract {subj_altname,mail,>:} \
28485                                     {$tls_in_peercert}}
28486   server_condition =  ${if forany {$auth2} \
28487                             {eq {$item}{$auth1}}}
28488   server_set_id =     $auth1
28489 .endd
28490 This accepts a client certificate that is verifiable against any
28491 of your configured trust-anchors
28492 (which usually means the full set of public CAs)
28493 and which has a mail-SAN matching the claimed identity sent by the client.
28494
28495 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28496 The account name is therefore guessable by an opponent.
28497 TLS 1.3 protects both server and client certificates, and is not vulnerable
28498 in this way.
28499
28500
28501 .section "Using external in a client" "SECTexternclient"
28502 .cindex "options" "&(external)& authenticator (client)"
28503 The &(external)& authenticator has one client option:
28504
28505 .option client_send external string&!! unset
28506 This option is expanded and sent with the AUTH command as the
28507 identity being asserted.
28508
28509 Example:
28510 .code
28511 ext_ccert:
28512   driver =      external
28513   public_name = EXTERNAL
28514
28515   client_condition = ${if !eq{$tls_out_cipher}{}}
28516   client_send = myaccount@smarthost.example.net
28517 .endd
28518
28519
28520 .ecindex IIDexternauth1
28521 .ecindex IIDexternauth2
28522
28523
28524
28525
28526
28527 . ////////////////////////////////////////////////////////////////////////////
28528 . ////////////////////////////////////////////////////////////////////////////
28529
28530 .chapter "The tls authenticator" "CHAPtlsauth"
28531 .scindex IIDtlsauth1 "&(tls)& authenticator"
28532 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28533 .cindex "authentication" "Client Certificate"
28534 .cindex "authentication" "X509"
28535 .cindex "Certificate-based authentication"
28536 The &(tls)& authenticator provides server support for
28537 authentication based on client certificates.
28538
28539 It is not an SMTP authentication mechanism and is not
28540 advertised by the server as part of the SMTP EHLO response.
28541 It is an Exim authenticator in the sense that it affects
28542 the protocol element of the log line, can be tested for
28543 by the &%authenticated%& ACL condition, and can set
28544 the &$authenticated_id$& variable.
28545
28546 The client must present a verifiable certificate,
28547 for which it must have been requested via the
28548 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28549 (see &<<CHAPTLS>>&).
28550
28551 If an authenticator of this type is configured it is
28552 run before any SMTP-level communication is done,
28553 and can authenticate the connection.
28554 If it does, SMTP authentication is not offered.
28555
28556 A maximum of one authenticator of this type may be present.
28557
28558
28559 .cindex "options" "&(tls)& authenticator (server)"
28560 The &(tls)& authenticator has three server options:
28561
28562 .option server_param1 tls string&!! unset
28563 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28564 This option is expanded after the TLS negotiation and
28565 the result is placed in &$auth1$&.
28566 If the expansion is forced to fail, authentication fails. Any other expansion
28567 failure causes a temporary error code to be returned.
28568
28569 .option server_param2 tls string&!! unset
28570 .option server_param3 tls string&!! unset
28571 As above, for &$auth2$& and &$auth3$&.
28572
28573 &%server_param1%& may also be spelled &%server_param%&.
28574
28575
28576 Example:
28577 .code
28578 tls:
28579   driver = tls
28580   server_param1 =     ${certextract {subj_altname,mail,>:} \
28581                                     {$tls_in_peercert}}
28582   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28583                                  {forany {$auth1} \
28584                             {!= {0} \
28585                                 {${lookup ldap{ldap:///\
28586                          mailname=${quote_ldap_dn:${lc:$item}},\
28587                          ou=users,LDAP_DC?mailid} {$value}{0} \
28588                        }    }  } }}}
28589   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28590 .endd
28591 This accepts a client certificate that is verifiable against any
28592 of your configured trust-anchors
28593 (which usually means the full set of public CAs)
28594 and which has a SAN with a good account name.
28595
28596 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28597 The account name is therefore guessable by an opponent.
28598 TLS 1.3 protects both server and client certificates, and is not vulnerable
28599 in this way.
28600 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28601
28602 . An alternative might use
28603 . .code
28604 .   server_param1 = ${sha256:$tls_in_peercert}
28605 . .endd
28606 . to require one of a set of specific certs that define a given account
28607 . (the verification is still required, but mostly irrelevant).
28608 . This would help for per-device use.
28609 .
28610 . However, for the future we really need support for checking a
28611 . user cert in LDAP - which probably wants a base-64 DER.
28612
28613 .ecindex IIDtlsauth1
28614 .ecindex IIDtlsauth2
28615
28616
28617 Note that because authentication is traditionally an SMTP operation,
28618 the &%authenticated%& ACL condition cannot be used in
28619 a connect- or helo-ACL.
28620
28621
28622
28623 . ////////////////////////////////////////////////////////////////////////////
28624 . ////////////////////////////////////////////////////////////////////////////
28625
28626 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28627          "Encrypted SMTP connections"
28628 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28629 .scindex IIDencsmtp2 "SMTP" "encryption"
28630 .cindex "TLS" "on SMTP connection"
28631 .cindex "OpenSSL"
28632 .cindex "GnuTLS"
28633 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28634 Sockets Layer), is implemented by making use of the OpenSSL library or the
28635 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28636 cryptographic code in the Exim distribution itself for implementing TLS. In
28637 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28638 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28639 You also need to understand the basic concepts of encryption at a managerial
28640 level, and in particular, the way that public keys, private keys, and
28641 certificates are used.
28642
28643 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28644 connection is established, the client issues a STARTTLS command. If the
28645 server accepts this, the client and the server negotiate an encryption
28646 mechanism. If the negotiation succeeds, the data that subsequently passes
28647 between them is encrypted.
28648
28649 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28650 and if so, what cipher suite is in use, whether the client supplied a
28651 certificate, and whether or not that certificate was verified. This makes it
28652 possible for an Exim server to deny or accept certain commands based on the
28653 encryption state.
28654
28655 &*Warning*&: Certain types of firewall and certain anti-virus products can
28656 disrupt TLS connections. You need to turn off SMTP scanning for these products
28657 in order to get TLS to work.
28658
28659
28660
28661 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28662          "SECID284"
28663 .cindex "submissions protocol"
28664 .cindex "ssmtp protocol"
28665 .cindex "smtps protocol"
28666 .cindex "SMTP" "submissions protocol"
28667 .cindex "SMTP" "ssmtp protocol"
28668 .cindex "SMTP" "smtps protocol"
28669 The history of port numbers for TLS in SMTP is a little messy and has been
28670 contentious.  As of RFC 8314, the common practice of using the historically
28671 allocated port 465 for "email submission but with TLS immediately upon connect
28672 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28673 by them in preference to STARTTLS.
28674
28675 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28676 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28677 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28678
28679 This approach was, for a while, officially abandoned when encrypted SMTP was
28680 standardized, but many clients kept using it, even as the TCP port number was
28681 reassigned for other use.
28682 Thus you may encounter guidance claiming that you shouldn't enable use of
28683 this port.
28684 In practice, a number of mail-clients have only ever supported submissions,
28685 not submission with STARTTLS upgrade.
28686 Ideally, offer both submission (587) and submissions (465) service.
28687
28688 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28689 global option. Its value must be a list of port numbers;
28690 the most common use is expected to be:
28691 .code
28692 tls_on_connect_ports = 465
28693 .endd
28694 The port numbers specified by this option apply to all SMTP connections, both
28695 via the daemon and via &'inetd'&. You still need to specify all the ports that
28696 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28697 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28698 an extra port &-- rather, it specifies different behaviour on a port that is
28699 defined elsewhere.
28700
28701 There is also a &%-tls-on-connect%& command line option. This overrides
28702 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28703
28704
28705
28706
28707
28708
28709 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28710 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28711 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28712 To build Exim to use OpenSSL you need to set
28713 .code
28714 USE_OPENSSL=yes
28715 .endd
28716 in Local/Makefile.
28717
28718 To build Exim to use GnuTLS, you need to set
28719 .code
28720 USE_GNUTLS=yes
28721 .endd
28722 in Local/Makefile.
28723
28724 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28725 include files and libraries for GnuTLS can be found.
28726
28727 There are some differences in usage when using GnuTLS instead of OpenSSL:
28728
28729 .ilist
28730 The &%tls_verify_certificates%& option
28731 cannot be the path of a directory
28732 for GnuTLS versions before 3.3.6
28733 (for later versions, or OpenSSL, it can be either).
28734 .next
28735 The default value for &%tls_dhparam%& differs for historical reasons.
28736 .next
28737 .vindex "&$tls_in_peerdn$&"
28738 .vindex "&$tls_out_peerdn$&"
28739 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28740 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28741 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28742 .next
28743 OpenSSL identifies cipher suites using hyphens as separators, for example:
28744 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28745 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28746 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28747 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28748 to handle its own older variants) when processing lists of cipher suites in the
28749 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28750 option).
28751 .next
28752 The &%tls_require_ciphers%& options operate differently, as described in the
28753 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28754 .next
28755 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28756 When using OpenSSL, this option is ignored.
28757 (If an API is found to let OpenSSL be configured in this way,
28758 let the Exim Maintainers know and we'll likely use it).
28759 .next
28760 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28761 main option, it must be ordered to match the &%tls_certificate%& list.
28762 .next
28763 Some other recently added features may only be available in one or the other.
28764 This should be documented with the feature.  If the documentation does not
28765 explicitly state that the feature is infeasible in the other TLS
28766 implementation, then patches are welcome.
28767 .endlist
28768
28769
28770 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28771 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28772 an explicit path; if the latter, then the text about generation still applies,
28773 but not the chosen filename.
28774 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28775 See the documentation of &%tls_dhparam%& for more information.
28776
28777 GnuTLS uses D-H parameters that may take a substantial amount of time
28778 to compute. It is unreasonable to re-compute them for every TLS session.
28779 Therefore, Exim keeps this data in a file in its spool directory, called
28780 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28781 of bits requested.
28782 The file is owned by the Exim user and is readable only by
28783 its owner. Every Exim process that start up GnuTLS reads the D-H
28784 parameters from this file. If the file does not exist, the first Exim process
28785 that needs it computes the data and writes it to a temporary file which is
28786 renamed once it is complete. It does not matter if several Exim processes do
28787 this simultaneously (apart from wasting a few resources). Once a file is in
28788 place, new Exim processes immediately start using it.
28789
28790 For maximum security, the parameters that are stored in this file should be
28791 recalculated periodically, the frequency depending on your paranoia level.
28792 If you are avoiding using the fixed D-H primes published in RFCs, then you
28793 are concerned about some advanced attacks and will wish to do this; if you do
28794 not regenerate then you might as well stick to the standard primes.
28795
28796 Arranging this is easy in principle; just delete the file when you want new
28797 values to be computed. However, there may be a problem. The calculation of new
28798 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28799 If the system is not very active, &_/dev/random_& may delay returning data
28800 until enough randomness (entropy) is available. This may cause Exim to hang for
28801 a substantial amount of time, causing timeouts on incoming connections.
28802
28803 The solution is to generate the parameters externally to Exim. They are stored
28804 in &_gnutls-params-N_& in PEM format, which means that they can be
28805 generated externally using the &(certtool)& command that is part of GnuTLS.
28806
28807 To replace the parameters with new ones, instead of deleting the file
28808 and letting Exim re-create it, you can generate new parameters using
28809 &(certtool)& and, when this has been done, replace Exim's cache file by
28810 renaming. The relevant commands are something like this:
28811 .code
28812 # ls
28813 [ look for file; assume gnutls-params-2236 is the most recent ]
28814 # rm -f new-params
28815 # touch new-params
28816 # chown exim:exim new-params
28817 # chmod 0600 new-params
28818 # certtool --generate-dh-params --bits 2236 >>new-params
28819 # openssl dhparam -noout -text -in new-params | head
28820 [ check the first line, make sure it's not more than 2236;
28821   if it is, then go back to the start ("rm") and repeat
28822   until the size generated is at most the size requested ]
28823 # chmod 0400 new-params
28824 # mv new-params gnutls-params-2236
28825 .endd
28826 If Exim never has to generate the parameters itself, the possibility of
28827 stalling is removed.
28828
28829 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28830 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28831 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28832 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28833 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28834 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28835 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28836 which applies to all D-H usage, client or server.  If the value returned by
28837 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28838 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28839 limit, which is still much higher than Exim historically used.
28840
28841 The filename and bits used will change as the GnuTLS maintainers change the
28842 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28843 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28844 2432 bits, while NSS is limited to 2236 bits.
28845
28846 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28847 increase the chance of the generated prime actually being within acceptable
28848 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28849 procedure above.  There is no sane procedure available to Exim to double-check
28850 the size of the generated prime, so it might still be too large.
28851
28852
28853 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28854 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28855 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28856 There is a function in the OpenSSL library that can be passed a list of cipher
28857 suites before the cipher negotiation takes place. This specifies which ciphers
28858 are acceptable for TLS versions prior to 1.3.
28859 The list is colon separated and may contain names like
28860 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28861 directly to this function call.
28862 Many systems will install the OpenSSL manual-pages, so you may have
28863 &'ciphers(1)'& available to you.
28864 The following quotation from the OpenSSL
28865 documentation specifies what forms of item are allowed in the cipher string:
28866
28867 .ilist
28868 It can consist of a single cipher suite such as RC4-SHA.
28869 .next
28870 It can represent a list of cipher suites containing a certain algorithm,
28871 or cipher suites of a certain type. For example SHA1 represents all
28872 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28873 SSL v3 algorithms.
28874 .next
28875 Lists of cipher suites can be combined in a single cipher string using
28876 the + character. This is used as a logical and operation. For example
28877 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28878 algorithms.
28879 .endlist
28880
28881 Each cipher string can be optionally preceded by one of the characters &`!`&,
28882 &`-`& or &`+`&.
28883 .ilist
28884 If &`!`& is used, the ciphers are permanently deleted from the list. The
28885 ciphers deleted can never reappear in the list even if they are explicitly
28886 stated.
28887 .next
28888 If &`-`& is used, the ciphers are deleted from the list, but some or all
28889 of the ciphers can be added again by later options.
28890 .next
28891 If &`+`& is used, the ciphers are moved to the end of the list. This
28892 option does not add any new ciphers; it just moves matching existing ones.
28893 .endlist
28894
28895 If none of these characters is present, the string is interpreted as
28896 a list of ciphers to be appended to the current preference list. If the list
28897 includes any ciphers already present they will be ignored: that is, they will
28898 not be moved to the end of the list.
28899 .endlist
28900
28901 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28902 string:
28903 .code
28904 # note single-quotes to get ! past any shell history expansion
28905 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28906 .endd
28907
28908 This example will let the library defaults be permitted on the MX port, where
28909 there's probably no identity verification anyway, but ups the ante on the
28910 submission ports where the administrator might have some influence on the
28911 choice of clients used:
28912 .code
28913 # OpenSSL variant; see man ciphers(1)
28914 tls_require_ciphers = ${if =={$received_port}{25}\
28915                            {DEFAULT}\
28916                            {HIGH:!MD5:!SHA1}}
28917 .endd
28918
28919 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28920 .code
28921 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28922 .endd
28923
28924 For TLS version 1.3 the control available is less fine-grained
28925 and Exim does not provide access to it at present.
28926 The value of the &%tls_require_ciphers%& option is ignored when
28927 TLS version 1.3 is negotiated.
28928
28929 As of writing the library default cipher suite list for TLSv1.3 is
28930 .code
28931 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28932 .endd
28933
28934
28935 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28936          "SECTreqciphgnu"
28937 .cindex "GnuTLS" "specifying parameters for"
28938 .cindex "TLS" "specifying ciphers (GnuTLS)"
28939 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28940 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28941 .cindex "TLS" "specifying protocols (GnuTLS)"
28942 .cindex "TLS" "specifying priority string (GnuTLS)"
28943 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28944 The GnuTLS library allows the caller to provide a "priority string", documented
28945 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28946 ciphersuite specification in OpenSSL.
28947
28948 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28949 and controls both protocols and ciphers.
28950
28951 The &%tls_require_ciphers%& option is available both as an global option,
28952 controlling how Exim behaves as a server, and also as an option of the
28953 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28954 the value is string expanded.  The resulting string is not an Exim list and
28955 the string is given to the GnuTLS library, so that Exim does not need to be
28956 aware of future feature enhancements of GnuTLS.
28957
28958 Documentation of the strings accepted may be found in the GnuTLS manual, under
28959 "Priority strings".  This is online as
28960 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28961 but beware that this relates to GnuTLS 3, which may be newer than the version
28962 installed on your system.  If you are using GnuTLS 3,
28963 then the example code
28964 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28965 on that site can be used to test a given string.
28966
28967 For example:
28968 .code
28969 # Disable older versions of protocols
28970 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28971 .endd
28972
28973 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28974 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28975 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28976
28977 This example will let the library defaults be permitted on the MX port, where
28978 there's probably no identity verification anyway, and lowers security further
28979 by increasing compatibility; but this ups the ante on the submission ports
28980 where the administrator might have some influence on the choice of clients
28981 used:
28982 .code
28983 # GnuTLS variant
28984 tls_require_ciphers = ${if =={$received_port}{25}\
28985                            {NORMAL:%COMPAT}\
28986                            {SECURE128}}
28987 .endd
28988
28989
28990 .section "Configuring an Exim server to use TLS" "SECID182"
28991 .cindex "TLS" "configuring an Exim server"
28992 .cindex "ESMTP extensions" STARTTLS
28993 When Exim has been built with TLS support, it advertises the availability of
28994 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28995 but not to any others. The default value of this option is *, which means
28996 that STARTTLS is always advertised.  Set it to blank to never advertise;
28997 this is reasonable for systems that want to use TLS only as a client.
28998
28999 If STARTTLS is to be used you
29000 need to set some other options in order to make TLS available.
29001
29002 If a client issues a STARTTLS command and there is some configuration
29003 problem in the server, the command is rejected with a 454 error. If the client
29004 persists in trying to issue SMTP commands, all except QUIT are rejected
29005 with the error
29006 .code
29007 554 Security failure
29008 .endd
29009 If a STARTTLS command is issued within an existing TLS session, it is
29010 rejected with a 554 error code.
29011
29012 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29013 must be set to match some hosts. The default is * which matches all hosts.
29014
29015 If this is all you do, TLS encryption will be enabled but not authentication -
29016 meaning that the peer has no assurance it is actually you he is talking to.
29017 You gain protection from a passive sniffer listening on the wire but not
29018 from someone able to intercept the communication.
29019
29020 Further protection requires some further configuration at the server end.
29021
29022 To make TLS work you need to set, in the server,
29023 .code
29024 tls_certificate = /some/file/name
29025 tls_privatekey = /some/file/name
29026 .endd
29027 These options are, in fact, expanded strings, so you can make them depend on
29028 the identity of the client that is connected if you wish. The first file
29029 contains the server's X509 certificate, and the second contains the private key
29030 that goes with it. These files need to be
29031 PEM format and readable by the Exim user, and must
29032 always be given as full path names.
29033 The key must not be password-protected.
29034 They can be the same file if both the
29035 certificate and the key are contained within it. If &%tls_privatekey%& is not
29036 set, or if its expansion is forced to fail or results in an empty string, this
29037 is assumed to be the case. The certificate file may also contain intermediate
29038 certificates that need to be sent to the client to enable it to authenticate
29039 the server's certificate.
29040
29041 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29042 colon-separated lists of file paths.  Ciphers using given authentication
29043 algorithms require the presence of a suitable certificate to supply the
29044 public-key.  The server selects among the certificates to present to the
29045 client depending on the selected cipher, hence the priority ordering for
29046 ciphers will affect which certificate is used.
29047
29048 If you do not understand about certificates and keys, please try to find a
29049 source of this background information, which is not Exim-specific. (There are a
29050 few comments below in section &<<SECTcerandall>>&.)
29051
29052 &*Note*&: These options do not apply when Exim is operating as a client &--
29053 they apply only in the case of a server. If you need to use a certificate in an
29054 Exim client, you must set the options of the same names in an &(smtp)&
29055 transport.
29056
29057 With just these options, an Exim server will be able to use TLS. It does not
29058 require the client to have a certificate (but see below for how to insist on
29059 this). There is one other option that may be needed in other situations. If
29060 .code
29061 tls_dhparam = /some/file/name
29062 .endd
29063 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29064 with the parameters contained in the file.
29065 Set this to &`none`& to disable use of DH entirely, by making no prime
29066 available:
29067 .code
29068 tls_dhparam = none
29069 .endd
29070 This may also be set to a string identifying a standard prime to be used for
29071 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29072 used is &`ike23`&.  There are a few standard primes available, see the
29073 documentation for &%tls_dhparam%& for the complete list.
29074
29075 See the command
29076 .code
29077 openssl dhparam
29078 .endd
29079 for a way of generating file data.
29080
29081 The strings supplied for these three options are expanded every time a client
29082 host connects. It is therefore possible to use different certificates and keys
29083 for different hosts, if you so wish, by making use of the client's IP address
29084 in &$sender_host_address$& to control the expansion. If a string expansion is
29085 forced to fail, Exim behaves as if the option is not set.
29086
29087 .cindex "cipher" "logging"
29088 .cindex "log" "TLS cipher"
29089 .vindex "&$tls_in_cipher$&"
29090 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29091 an incoming TLS connection. It is included in the &'Received:'& header of an
29092 incoming message (by default &-- you can, of course, change this), and it is
29093 also included in the log line that records a message's arrival, keyed by
29094 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29095 condition can be used to test for specific cipher suites in ACLs.
29096
29097 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29098 can check the name of the cipher suite and vary their actions accordingly. The
29099 cipher suite names vary, depending on which TLS library is being used. For
29100 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29101 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29102 documentation for more details.
29103
29104 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29105 (again depending on the &%tls_cipher%& log selector).
29106
29107
29108 .section "Requesting and verifying client certificates" "SECID183"
29109 .cindex "certificate" "verification of client"
29110 .cindex "TLS" "client certificate verification"
29111 If you want an Exim server to request a certificate when negotiating a TLS
29112 session with a client, you must set either &%tls_verify_hosts%& or
29113 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29114 apply to all TLS connections. For any host that matches one of these options,
29115 Exim requests a certificate as part of the setup of the TLS session. The
29116 contents of the certificate are verified by comparing it with a list of
29117 expected trust-anchors or certificates.
29118 These may be the system default set (depending on library version),
29119 an explicit file or,
29120 depending on library version, a directory, identified by
29121 &%tls_verify_certificates%&.
29122
29123 A file can contain multiple certificates, concatenated end to end. If a
29124 directory is used
29125 (OpenSSL only),
29126 each certificate must be in a separate file, with a name (or a symbolic link)
29127 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29128 certificate. You can compute the relevant hash by running the command
29129 .code
29130 openssl x509 -hash -noout -in /cert/file
29131 .endd
29132 where &_/cert/file_& contains a single certificate.
29133
29134 There is no checking of names of the client against the certificate
29135 Subject Name or Subject Alternate Names.
29136
29137 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29138 what happens if the client does not supply a certificate, or if the certificate
29139 does not match any of the certificates in the collection named by
29140 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29141 attempt to set up a TLS session is aborted, and the incoming connection is
29142 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29143 session continues. ACLs that run for subsequent SMTP commands can detect the
29144 fact that no certificate was verified, and vary their actions accordingly. For
29145 example, you can insist on a certificate before accepting a message for
29146 relaying, but not when the message is destined for local delivery.
29147
29148 .vindex "&$tls_in_peerdn$&"
29149 When a client supplies a certificate (whether it verifies or not), the value of
29150 the Distinguished Name of the certificate is made available in the variable
29151 &$tls_in_peerdn$& during subsequent processing of the message.
29152
29153 .cindex "log" "distinguished name"
29154 Because it is often a long text string, it is not included in the log line or
29155 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29156 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29157 &%received_header_text%& to change the &'Received:'& header. When no
29158 certificate is supplied, &$tls_in_peerdn$& is empty.
29159
29160
29161 .section "Revoked certificates" "SECID184"
29162 .cindex "TLS" "revoked certificates"
29163 .cindex "revocation list"
29164 .cindex "certificate" "revocation list"
29165 .cindex "OCSP" "stapling"
29166 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29167 certificates are revoked. If you have such a list, you can pass it to an Exim
29168 server using the global option called &%tls_crl%& and to an Exim client using
29169 an identically named option for the &(smtp)& transport. In each case, the value
29170 of the option is expanded and must then be the name of a file that contains a
29171 CRL in PEM format.
29172 The downside is that clients have to periodically re-download a potentially huge
29173 file from every certificate authority they know of.
29174
29175 The way with most moving parts at query time is Online Certificate
29176 Status Protocol (OCSP), where the client verifies the certificate
29177 against an OCSP server run by the CA.  This lets the CA track all
29178 usage of the certs.  It requires running software with access to the
29179 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29180 is based on HTTP and can be proxied accordingly.
29181
29182 The only widespread OCSP server implementation (known to this writer)
29183 comes as part of OpenSSL and aborts on an invalid request, such as
29184 connecting to the port and then disconnecting.  This requires
29185 re-entering the passphrase each time some random client does this.
29186
29187 The third way is OCSP Stapling; in this, the server using a certificate
29188 issued by the CA periodically requests an OCSP proof of validity from
29189 the OCSP server, then serves it up inline as part of the TLS
29190 negotiation.   This approach adds no extra round trips, does not let the
29191 CA track users, scales well with number of certs issued by the CA and is
29192 resilient to temporary OCSP server failures, as long as the server
29193 starts retrying to fetch an OCSP proof some time before its current
29194 proof expires.  The downside is that it requires server support.
29195
29196 Unless Exim is built with the support disabled,
29197 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29198 support for OCSP stapling is included.
29199
29200 There is a global option called &%tls_ocsp_file%&.
29201 The file specified therein is expected to be in DER format, and contain
29202 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29203 option will be re-expanded for SNI, if the &%tls_certificate%& option
29204 contains &`tls_in_sni`&, as per other TLS options.
29205
29206 Exim does not at this time implement any support for fetching a new OCSP
29207 proof.  The burden is on the administrator to handle this, outside of
29208 Exim.  The file specified should be replaced atomically, so that the
29209 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29210 on each connection, so a new file will be handled transparently on the
29211 next connection.
29212
29213 When built with OpenSSL Exim will check for a valid next update timestamp
29214 in the OCSP proof; if not present, or if the proof has expired, it will be
29215 ignored.
29216
29217 For the client to be able to verify the stapled OCSP the server must
29218 also supply, in its stapled information, any intermediate
29219 certificates for the chain leading to the OCSP proof from the signer
29220 of the server certificate.  There may be zero or one such. These
29221 intermediate certificates should be added to the server OCSP stapling
29222 file named by &%tls_ocsp_file%&.
29223
29224 Note that the proof only covers the terminal server certificate,
29225 not any of the chain from CA to it.
29226
29227 There is no current way to staple a proof for a client certificate.
29228
29229 .code
29230   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29231   OCSP server is supplied.  The server URL may be included in the
29232   server certificate, if the CA is helpful.
29233
29234   One failure mode seen was the OCSP Signer cert expiring before the end
29235   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29236   noted this as invalid overall, but the re-fetch script did not.
29237 .endd
29238
29239
29240
29241
29242 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29243 .cindex "cipher" "logging"
29244 .cindex "log" "TLS cipher"
29245 .cindex "log" "distinguished name"
29246 .cindex "TLS" "configuring an Exim client"
29247 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29248 deliveries as well as to incoming, the latter one causing logging of the
29249 server certificate's DN. The remaining client configuration for TLS is all
29250 within the &(smtp)& transport.
29251
29252 .cindex "ESMTP extensions" STARTTLS
29253 It is not necessary to set any options to have TLS work in the &(smtp)&
29254 transport. If Exim is built with TLS support, and TLS is advertised by a
29255 server, the &(smtp)& transport always tries to start a TLS session. However,
29256 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29257 transport) to a list of server hosts for which TLS should not be used.
29258
29259 If you do not want Exim to attempt to send messages unencrypted when an attempt
29260 to set up an encrypted connection fails in any way, you can set
29261 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29262 those hosts, delivery is always deferred if an encrypted connection cannot be
29263 set up. If there are any other hosts for the address, they are tried in the
29264 usual way.
29265
29266 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29267 the message unencrypted. It always does this if the response to STARTTLS is
29268 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29269 session after a success response code, what happens is controlled by the
29270 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29271 delivery to this host is deferred, and other hosts (if available) are tried. If
29272 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29273 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29274 negotiation fails, Exim closes the current connection (because it is in an
29275 unknown state), opens a new one to the same host, and then tries the delivery
29276 unencrypted.
29277
29278 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29279 transport provide the client with a certificate, which is passed to the server
29280 if it requests it. If the server is Exim, it will request a certificate only if
29281 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29282
29283 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29284 for client use (they are usable for server use).
29285 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29286 in failed connections.
29287
29288 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29289 specifies a collection of expected server certificates.
29290 These may be
29291 the system default set (depending on library version),
29292 a file,
29293 or (depending on library version) a directory.
29294 The client verifies the server's certificate
29295 against this collection, taking into account any revoked certificates that are
29296 in the list defined by &%tls_crl%&.
29297 Failure to verify fails the TLS connection unless either of the
29298 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29299
29300 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29301 certificate verification to the listed servers.  Verification either must
29302 or need not succeed respectively.
29303
29304 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29305 name checks are made on the server certificate.
29306 .new
29307 The match against this list is, as per other Exim usage, the
29308 IP for the host.  That is most closely associated with the
29309 name on the DNS A (or AAAA) record for the host.
29310 However, the name that needs to be in the certificate
29311 is the one at the head of any CNAME chain leading to the A record.
29312 .wen
29313 The option defaults to always checking.
29314
29315 The &(smtp)& transport has two OCSP-related options:
29316 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29317 is requested and required for the connection to proceed.  The default
29318 value is empty.
29319 &%hosts_request_ocsp%&; a host-list for which (additionally)
29320 a Certificate Status is requested (but not necessarily verified).  The default
29321 value is "*" meaning that requests are made unless configured
29322 otherwise.
29323
29324 The host(s) should also be in &%hosts_require_tls%&, and
29325 &%tls_verify_certificates%& configured for the transport,
29326 for OCSP to be relevant.
29327
29328 If
29329 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29330 list of permitted cipher suites. If either of these checks fails, delivery to
29331 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29332 alternative hosts, if any.
29333
29334  &*Note*&:
29335 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29336 is operating as a client. Exim does not assume that a server certificate (set
29337 by the global options of the same name) should also be used when operating as a
29338 client.
29339
29340 .vindex "&$host$&"
29341 .vindex "&$host_address$&"
29342 All the TLS options in the &(smtp)& transport are expanded before use, with
29343 &$host$& and &$host_address$& containing the name and address of the server to
29344 which the client is connected. Forced failure of an expansion causes Exim to
29345 behave as if the relevant option were unset.
29346
29347 .vindex &$tls_out_bits$&
29348 .vindex &$tls_out_cipher$&
29349 .vindex &$tls_out_peerdn$&
29350 .vindex &$tls_out_sni$&
29351 Before an SMTP connection is established, the
29352 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29353 variables are emptied. (Until the first connection, they contain the values
29354 that were set when the message was received.) If STARTTLS is subsequently
29355 successfully obeyed, these variables are set to the relevant values for the
29356 outgoing connection.
29357
29358
29359
29360 .section "Use of TLS Server Name Indication" "SECTtlssni"
29361 .cindex "TLS" "Server Name Indication"
29362 .cindex "TLS" SNI
29363 .cindex SNI
29364 .vindex "&$tls_in_sni$&"
29365 .oindex "&%tls_in_sni%&"
29366 With TLS1.0 or above, there is an extension mechanism by which extra
29367 information can be included at various points in the protocol.  One of these
29368 extensions, documented in RFC 6066 (and before that RFC 4366) is
29369 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29370 client in the initial handshake, so that the server can examine the servername
29371 within and possibly choose to use different certificates and keys (and more)
29372 for this session.
29373
29374 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29375 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29376 address.
29377
29378 With SMTP to MX, there are the same problems here as in choosing the identity
29379 against which to validate a certificate: you can't rely on insecure DNS to
29380 provide the identity which you then cryptographically verify.  So this will
29381 be of limited use in that environment.
29382
29383 With SMTP to Submission, there is a well-defined hostname which clients are
29384 connecting to and can validate certificates against.  Thus clients &*can*&
29385 choose to include this information in the TLS negotiation.  If this becomes
29386 wide-spread, then hosters can choose to present different certificates to
29387 different clients.  Or even negotiate different cipher suites.
29388
29389 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29390 if not empty, will be sent on a TLS session as part of the handshake.  There's
29391 nothing more to it.  Choosing a sensible value not derived insecurely is the
29392 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29393 for the lifetime of the client connection (including during authentication).
29394
29395 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29396 received from a client.
29397 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29398
29399 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29400 option (prior to expansion) then the following options will be re-expanded
29401 during TLS session handshake, to permit alternative values to be chosen:
29402
29403 .ilist
29404 &%tls_certificate%&
29405 .next
29406 &%tls_crl%&
29407 .next
29408 &%tls_privatekey%&
29409 .next
29410 &%tls_verify_certificates%&
29411 .next
29412 &%tls_ocsp_file%&
29413 .endlist
29414
29415 Great care should be taken to deal with matters of case, various injection
29416 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29417 can always be referenced; it is important to remember that &$tls_in_sni$& is
29418 arbitrary unverified data provided prior to authentication.
29419 Further, the initial certificate is loaded before SNI has arrived, so
29420 an expansion for &%tls_certificate%& must have a default which is used
29421 when &$tls_in_sni$& is empty.
29422
29423 The Exim developers are proceeding cautiously and so far no other TLS options
29424 are re-expanded.
29425
29426 When Exim is built against OpenSSL, OpenSSL must have been built with support
29427 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29428 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29429 see &`-servername`& in the output, then OpenSSL has support.
29430
29431 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29432 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29433 built, then you have SNI support).
29434
29435
29436
29437 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29438          "SECTmulmessam"
29439 .cindex "multiple SMTP deliveries with TLS"
29440 .cindex "TLS" "multiple message deliveries"
29441 Exim sends multiple messages down the same TCP/IP connection by starting up
29442 an entirely new delivery process for each message, passing the socket from
29443 one process to the next. This implementation does not fit well with the use
29444 of TLS, because there is quite a lot of state information associated with a TLS
29445 connection, not just a socket identification. Passing all the state information
29446 to a new process is not feasible. Consequently, for sending using TLS Exim
29447 starts an additional proxy process for handling the encryption, piping the
29448 unencrypted data stream from and to the delivery processes.
29449
29450 An older mode of operation can be enabled on a per-host basis by the
29451 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29452 this list the proxy process described above is not used; instead Exim
29453 shuts down an existing TLS session being run by the delivery process
29454 before passing the socket to a new process. The new process may then
29455 try to start a new TLS session, and if successful, may try to re-authenticate
29456 if AUTH is in use, before sending the next message.
29457
29458 The RFC is not clear as to whether or not an SMTP session continues in clear
29459 after TLS has been shut down, or whether TLS may be restarted again later, as
29460 just described. However, if the server is Exim, this shutdown and
29461 reinitialization works. It is not known which (if any) other servers operate
29462 successfully if the client closes a TLS session and continues with unencrypted
29463 SMTP, but there are certainly some that do not work. For such servers, Exim
29464 should not pass the socket to another process, because the failure of the
29465 subsequent attempt to use it would cause Exim to record a temporary host error,
29466 and delay other deliveries to that host.
29467
29468 To test for this case, Exim sends an EHLO command to the server after
29469 closing down the TLS session. If this fails in any way, the connection is
29470 closed instead of being passed to a new delivery process, but no retry
29471 information is recorded.
29472
29473 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29474 &(smtp)& transport to match those hosts for which Exim should not pass
29475 connections to new processes if TLS has been used.
29476
29477
29478
29479
29480 .section "Certificates and all that" "SECTcerandall"
29481 .cindex "certificate" "references to discussion"
29482 In order to understand fully how TLS works, you need to know about
29483 certificates, certificate signing, and certificate authorities.
29484 This is a large topic and an introductory guide is unsuitable for the Exim
29485 reference manual, so instead we provide pointers to existing documentation.
29486
29487 The Apache web-server was for a long time the canonical guide, so their
29488 documentation is a good place to start; their SSL module's Introduction
29489 document is currently at
29490 .display
29491 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29492 .endd
29493 and their FAQ is at
29494 .display
29495 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29496 .endd
29497
29498 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29499 0-201-61598-3) in 2001, contains both introductory and more in-depth
29500 descriptions.
29501 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29502 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29503 Ivan is the author of the popular TLS testing tools at
29504 &url(https://www.ssllabs.com/).
29505
29506
29507 .section "Certificate chains" "SECID186"
29508 The file named by &%tls_certificate%& may contain more than one
29509 certificate. This is useful in the case where the certificate that is being
29510 sent is validated by an intermediate certificate which the other end does
29511 not have. Multiple certificates must be in the correct order in the file.
29512 First the host's certificate itself, then the first intermediate
29513 certificate to validate the issuer of the host certificate, then the next
29514 intermediate certificate to validate the issuer of the first intermediate
29515 certificate, and so on, until finally (optionally) the root certificate.
29516 The root certificate must already be trusted by the recipient for
29517 validation to succeed, of course, but if it's not preinstalled, sending the
29518 root certificate along with the rest makes it available for the user to
29519 install if the receiving end is a client MUA that can interact with a user.
29520
29521 Note that certificates using MD5 are unlikely to work on today's Internet;
29522 even if your libraries allow loading them for use in Exim when acting as a
29523 server, increasingly clients will not accept such certificates.  The error
29524 diagnostics in such a case can be frustratingly vague.
29525
29526
29527
29528 .section "Self-signed certificates" "SECID187"
29529 .cindex "certificate" "self-signed"
29530 You can create a self-signed certificate using the &'req'& command provided
29531 with OpenSSL, like this:
29532 . ==== Do not shorten the duration here without reading and considering
29533 . ==== the text below.  Please leave it at 9999 days.
29534 .code
29535 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29536             -days 9999 -nodes
29537 .endd
29538 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29539 delimited and so can be identified independently. The &%-days%& option
29540 specifies a period for which the certificate is valid. The &%-nodes%& option is
29541 important: if you do not set it, the key is encrypted with a passphrase
29542 that you are prompted for, and any use that is made of the key causes more
29543 prompting for the passphrase. This is not helpful if you are going to use
29544 this certificate and key in an MTA, where prompting is not possible.
29545
29546 . ==== I expect to still be working 26 years from now.  The less technical
29547 . ==== debt I create, in terms of storing up trouble for my later years, the
29548 . ==== happier I will be then.  We really have reached the point where we
29549 . ==== should start, at the very least, provoking thought and making folks
29550 . ==== pause before proceeding, instead of leaving all the fixes until two
29551 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29552 . ==== -pdp, 2012
29553 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29554 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29555 the above command might produce a date in the past.  Think carefully about
29556 the lifetime of the systems you're deploying, and either reduce the duration
29557 of the certificate or reconsider your platform deployment.  (At time of
29558 writing, reducing the duration is the most likely choice, but the inexorable
29559 progression of time takes us steadily towards an era where this will not
29560 be a sensible resolution).
29561
29562 A self-signed certificate made in this way is sufficient for testing, and
29563 may be adequate for all your requirements if you are mainly interested in
29564 encrypting transfers, and not in secure identification.
29565
29566 However, many clients require that the certificate presented by the server be a
29567 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29568 certificate. In this situation, the self-signed certificate described above
29569 must be installed on the client host as a trusted root &'certification
29570 authority'& (CA), and the certificate used by Exim must be a user certificate
29571 signed with that self-signed certificate.
29572
29573 For information on creating self-signed CA certificates and using them to sign
29574 user certificates, see the &'General implementation overview'& chapter of the
29575 Open-source PKI book, available online at
29576 &url(https://sourceforge.net/projects/ospkibook/).
29577 .ecindex IIDencsmtp1
29578 .ecindex IIDencsmtp2
29579
29580
29581 .new
29582 .section "TLS Resumption" "SECTresumption"
29583 .cindex TLS resumption
29584 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
29585 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
29586 (or later).
29587
29588 Session resumption (this is the "stateless" variant) involves the server sending
29589 a "session ticket" to the client on one connection, which can be stored by the
29590 client and used for a later session.  The ticket contains sufficient state for
29591 the server to reconstruct the TLS session, avoiding some expensive crypto
29592 calculation and (on TLS1.2) one full packet roundtrip time.
29593
29594 .ilist
29595 Operational cost/benefit:
29596
29597  The extra data being transmitted costs a minor amount, and the client has
29598  extra costs in storing and retrieving the data.
29599
29600  In the Exim/Gnutls implementation the extra cost on an initial connection
29601  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
29602  The saved cost on a subsequent connection is about 4ms; three or more
29603  connections become a net win.  On longer network paths, two or more
29604  connections will have an average lower startup time thanks to the one
29605  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
29606  packet roundtrips.
29607
29608 .cindex "hints database" tls
29609  Since a new hints DB is used on the TLS client,
29610  the hints DB maintenance should be updated to additionally handle "tls".
29611
29612 .next
29613 Security aspects:
29614
29615  The session ticket is encrypted, but is obviously an additional security
29616  vulnarability surface.  An attacker able to decrypt it would have access
29617  all connections using the resumed session.
29618  The session ticket encryption key is not committed to storage by the server
29619  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
29620  overlap; GnuTLS 6hr but does not specify any overlap).
29621  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
29622  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
29623
29624  There is a question-mark over the security of the Diffie-Helman parameters
29625  used for session negotiation.
29626
29627 .next
29628 Observability:
29629
29630  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
29631  element.
29632
29633  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
29634  have bits 0-4 indicating respectively
29635  support built, client requested ticket, client offered session,
29636  server issued ticket, resume used.  A suitable decode list is provided
29637  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
29638
29639 .next
29640 Control:
29641
29642 The &%tls_resumption_hosts%& main option specifies a hostlist for which
29643 exim, operating as a server, will offer resumption to clients.
29644 Current best practice is to not offer the feature to MUA connection.
29645 Commonly this can be done like this:
29646 .code
29647 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
29648 .endd
29649 If the peer host matches the list after expansion then resumption
29650 is offered and/or accepted.
29651
29652 The &%tls_resumption_hosts%& smtp transport option performs the
29653 equivalent function for operation as a client.
29654 If the peer host matches the list after expansion then resumption
29655 is attempted (if a stored session is available) or the information
29656 stored (if supplied by the peer).
29657
29658
29659 .next
29660 Issues:
29661
29662  In a resumed session:
29663 .ilist
29664   The variables &$tls_{in,out}_cipher$& will have values different
29665  to the original (under GnuTLS).
29666 .next
29667   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
29668  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
29669 . XXX need to do something with that hosts_require_ocsp
29670 .endlist
29671
29672 .endlist
29673 .wen
29674
29675
29676 .section DANE "SECDANE"
29677 .cindex DANE
29678 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29679 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29680 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29681 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29682 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29683 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29684
29685 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29686 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29687 by (a) is thought to be smaller than that of the set of root CAs.
29688
29689 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29690 fail to pass on a server's STARTTLS.
29691
29692 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29693 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29694 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29695
29696 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29697 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29698 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29699 DNSSEC.
29700 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29701 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29702
29703 There are no changes to Exim specific to server-side operation of DANE.
29704 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29705 in &_Local/Makefile_&.
29706 If it has been included, the macro "_HAVE_DANE" will be defined.
29707
29708 A TLSA record consist of 4 fields, the "Certificate Usage", the
29709 "Selector", the "Matching type", and the "Certificate Association Data".
29710 For a detailed description of the TLSA record see
29711 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29712
29713 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29714 These are the "Trust Anchor" and "End Entity" variants.
29715 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29716 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29717 this is appropriate for a single system, using a self-signed certificate.
29718 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29719 well-known one.
29720 A private CA at simplest is just a self-signed certificate (with certain
29721 attributes) which is used to sign server certificates, but running one securely
29722 does require careful arrangement.
29723 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29724 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29725 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29726 all of which point to a single TLSA record.
29727 DANE-TA and DANE-EE can both be used together.
29728
29729 Our recommendation is to use DANE with a certificate from a public CA,
29730 because this enables a variety of strategies for remote clients to verify
29731 your certificate.
29732 You can then publish information both via DANE and another technology,
29733 "MTA-STS", described below.
29734
29735 When you use DANE-TA to publish trust anchor information, you ask entities
29736 outside your administrative control to trust the Certificate Authority for
29737 connections to you.
29738 If using a private CA then you should expect others to still apply the
29739 technical criteria they'd use for a public CA to your certificates.
29740 In particular, you should probably try to follow current best practices for CA
29741 operation around hash algorithms and key sizes.
29742 Do not expect other organizations to lower their security expectations just
29743 because a particular profile might be reasonable for your own internal use.
29744
29745 When this text was last updated, this in practice means to avoid use of SHA-1
29746 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29747 than 4096, for interoperability); to use keyUsage fields correctly; to use
29748 random serial numbers.
29749 The list of requirements is subject to change as best practices evolve.
29750 If you're not already using a private CA, or it doesn't meet these
29751 requirements, then we encourage you to avoid all these issues and use a public
29752 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29753
29754 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29755 a "Matching Type" (3rd) field of SHA2-512(2).
29756
29757 For the "Certificate Authority Data" (4th) field, commands like
29758
29759 .code
29760   openssl x509 -pubkey -noout <certificate.pem \
29761   | openssl rsa -outform der -pubin 2>/dev/null \
29762   | openssl sha512 \
29763   | awk '{print $2}'
29764 .endd
29765
29766 are workable to create a hash of the certificate's public key.
29767
29768 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29769
29770 .code
29771   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29772 .endd
29773
29774 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29775 is useful for quickly generating TLSA records.
29776
29777
29778 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29779
29780 The Certificate issued by the CA published in the DANE-TA model should be
29781 issued using a strong hash algorithm.
29782 Exim, and importantly various other MTAs sending to you, will not
29783 re-enable hash algorithms which have been disabled by default in TLS
29784 libraries.
29785 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29786 interoperability (and probably the maximum too, in 2018).
29787
29788 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29789 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29790 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29791
29792 .code
29793   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29794                                  {= {4}{$tls_out_tlsa_usage}} } \
29795                          {*}{}}
29796 .endd
29797
29798 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29799 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29800 found. If the definition of &%hosts_request_ocsp%& includes the
29801 string "tls_out_tlsa_usage", they are re-expanded in time to
29802 control the OCSP request.
29803
29804 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29805 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29806
29807
29808 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29809 and &%dane_require_tls_ciphers%&.
29810 The &"require"& variant will result in failure if the target host is not
29811 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29812 the &%dnssec_request_domains%& router or transport option.
29813
29814 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29815
29816 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29817 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29818 will be required for the host.  If it does not, the host will not
29819 be used; there is no fallback to non-DANE or non-TLS.
29820
29821 If DANE is requested and usable, then the TLS cipher list configuration
29822 prefers to use the option &%dane_require_tls_ciphers%& and falls
29823 back to &%tls_require_ciphers%& only if that is unset.
29824 This lets you configure "decent crypto" for DANE and "better than nothing
29825 crypto" as the default.  Note though that while GnuTLS lets the string control
29826 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29827 limited to ciphersuite constraints.
29828
29829 If DANE is requested and useable (see above) the following transport options are ignored:
29830 .code
29831   hosts_require_tls
29832   tls_verify_hosts
29833   tls_try_verify_hosts
29834   tls_verify_certificates
29835   tls_crl
29836   tls_verify_cert_hostnames
29837 .endd
29838
29839 If DANE is not usable, whether requested or not, and CA-anchored
29840 verification evaluation is wanted, the above variables should be set appropriately.
29841
29842 The router and transport option &%dnssec_request_domains%& must not be
29843 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29844
29845 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29846
29847 There is a new variable &$tls_out_dane$& which will have "yes" if
29848 verification succeeded using DANE and "no" otherwise (only useful
29849 in combination with events; see &<<CHAPevents>>&),
29850 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29851
29852 .cindex DANE reporting
29853 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29854 to achieve DANE-verified connection, if one was either requested and offered, or
29855 required.  This is intended to support TLS-reporting as defined in
29856 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29857 The &$event_data$& will be one of the Result Types defined in
29858 Section 4.3 of that document.
29859
29860 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29861
29862 DANE is specified in published RFCs and decouples certificate authority trust
29863 selection from a "race to the bottom" of "you must trust everything for mail
29864 to get through".  There is an alternative technology called MTA-STS, which
29865 instead publishes MX trust anchor information on an HTTPS website.  At the
29866 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29867 Exim has no support for MTA-STS as a client, but Exim mail server operators
29868 can choose to publish information describing their TLS configuration using
29869 MTA-STS to let those clients who do use that protocol derive trust
29870 information.
29871
29872 The MTA-STS design requires a certificate from a public Certificate Authority
29873 which is recognized by clients sending to you.
29874 That selection of which CAs are trusted by others is outside your control.
29875
29876 The most interoperable course of action is probably to use
29877 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29878 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29879 records for DANE clients (such as Exim and Postfix) and to publish anchor
29880 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29881 domain itself (with caveats around occasionally broken MTA-STS because of
29882 incompatible specification changes prior to reaching RFC status).
29883
29884
29885
29886 . ////////////////////////////////////////////////////////////////////////////
29887 . ////////////////////////////////////////////////////////////////////////////
29888
29889 .chapter "Access control lists" "CHAPACL"
29890 .scindex IIDacl "&ACL;" "description"
29891 .cindex "control of incoming mail"
29892 .cindex "message" "controlling incoming"
29893 .cindex "policy control" "access control lists"
29894 Access Control Lists (ACLs) are defined in a separate section of the runtime
29895 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29896 name, terminated by a colon. Here is a complete ACL section that contains just
29897 one very small ACL:
29898 .code
29899 begin acl
29900 small_acl:
29901   accept   hosts = one.host.only
29902 .endd
29903 You can have as many lists as you like in the ACL section, and the order in
29904 which they appear does not matter. The lists are self-terminating.
29905
29906 The majority of ACLs are used to control Exim's behaviour when it receives
29907 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29908 when a local process submits a message using SMTP by specifying the &%-bs%&
29909 option. The most common use is for controlling which recipients are accepted
29910 in incoming messages. In addition, you can define an ACL that is used to check
29911 local non-SMTP messages. The default configuration file contains an example of
29912 a realistic ACL for checking RCPT commands. This is discussed in chapter
29913 &<<CHAPdefconfil>>&.
29914
29915
29916 .section "Testing ACLs" "SECID188"
29917 The &%-bh%& command line option provides a way of testing your ACL
29918 configuration locally by running a fake SMTP session with which you interact.
29919
29920
29921 .section "Specifying when ACLs are used" "SECID189"
29922 .cindex "&ACL;" "options for specifying"
29923 In order to cause an ACL to be used, you have to name it in one of the relevant
29924 options in the main part of the configuration. These options are:
29925 .cindex "AUTH" "ACL for"
29926 .cindex "DATA" "ACLs for"
29927 .cindex "ETRN" "ACL for"
29928 .cindex "EXPN" "ACL for"
29929 .cindex "HELO" "ACL for"
29930 .cindex "EHLO" "ACL for"
29931 .cindex "DKIM" "ACL for"
29932 .cindex "MAIL" "ACL for"
29933 .cindex "QUIT, ACL for"
29934 .cindex "RCPT" "ACL for"
29935 .cindex "STARTTLS, ACL for"
29936 .cindex "VRFY" "ACL for"
29937 .cindex "SMTP" "connection, ACL for"
29938 .cindex "non-SMTP messages" "ACLs for"
29939 .cindex "MIME content scanning" "ACL for"
29940 .cindex "PRDR" "ACL for"
29941
29942 .table2 140pt
29943 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29944 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29945 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29946 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29947 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29948 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29949 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29950 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29951 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29952 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29953 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29954 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29955 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29956 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29957 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29958 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29959 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29960 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29961 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29962 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29963 .endtable
29964
29965 For example, if you set
29966 .code
29967 acl_smtp_rcpt = small_acl
29968 .endd
29969 the little ACL defined above is used whenever Exim receives a RCPT command
29970 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29971 done when RCPT commands arrive. A rejection of RCPT should cause the
29972 sending MTA to give up on the recipient address contained in the RCPT
29973 command, whereas rejection at other times may cause the client MTA to keep on
29974 trying to deliver the message. It is therefore recommended that you do as much
29975 testing as possible at RCPT time.
29976
29977
29978 .section "The non-SMTP ACLs" "SECID190"
29979 .cindex "non-SMTP messages" "ACLs for"
29980 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29981 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29982 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29983 the state of the SMTP connection such as encryption and authentication) are not
29984 relevant and are forbidden in these ACLs. However, the sender and recipients
29985 are known, so the &%senders%& and &%sender_domains%& conditions and the
29986 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29987 &$authenticated_sender$& are also available. You can specify added header lines
29988 in any of these ACLs.
29989
29990 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29991 non-SMTP message, before any of the message has been read. (This is the
29992 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29993 batched SMTP input, it runs after the DATA command has been reached. The
29994 result of this ACL is ignored; it cannot be used to reject a message. If you
29995 really need to, you could set a value in an ACL variable here and reject based
29996 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29997 controls, and in particular, it can be used to set
29998 .code
29999 control = suppress_local_fixups
30000 .endd
30001 This cannot be used in the other non-SMTP ACLs because by the time they are
30002 run, it is too late.
30003
30004 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30005 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30006
30007 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30008 kind of rejection is treated as permanent, because there is no way of sending a
30009 temporary error for these kinds of message.
30010
30011
30012 .section "The SMTP connect ACL" "SECID191"
30013 .cindex "SMTP" "connection, ACL for"
30014 .oindex &%smtp_banner%&
30015 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30016 session, after the test specified by &%host_reject_connection%& (which is now
30017 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30018 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30019 the message override the banner message that is otherwise specified by the
30020 &%smtp_banner%& option.
30021
30022
30023 .section "The EHLO/HELO ACL" "SECID192"
30024 .cindex "EHLO" "ACL for"
30025 .cindex "HELO" "ACL for"
30026 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30027 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30028 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30029 Note that a client may issue more than one EHLO or HELO command in an SMTP
30030 session, and indeed is required to issue a new EHLO or HELO after successfully
30031 setting up encryption following a STARTTLS command.
30032
30033 Note also that a deny neither forces the client to go away nor means that
30034 mail will be refused on the connection.  Consider checking for
30035 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30036
30037 If the command is accepted by an &%accept%& verb that has a &%message%&
30038 modifier, the message may not contain more than one line (it will be truncated
30039 at the first newline and a panic logged if it does). Such a message cannot
30040 affect the EHLO options that are listed on the second and subsequent lines of
30041 an EHLO response.
30042
30043
30044 .section "The DATA ACLs" "SECID193"
30045 .cindex "DATA" "ACLs for"
30046 Two ACLs are associated with the DATA command, because it is two-stage
30047 command, with two responses being sent to the client.
30048 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30049 is obeyed. This gives you control after all the RCPT commands, but before
30050 the message itself is received. It offers the opportunity to give a negative
30051 response to the DATA command before the data is transmitted. Header lines
30052 added by MAIL or RCPT ACLs are not visible at this time, but any that
30053 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30054
30055 You cannot test the contents of the message, for example, to verify addresses
30056 in the headers, at RCPT time or when the DATA command is received. Such
30057 tests have to appear in the ACL that is run after the message itself has been
30058 received, before the final response to the DATA command is sent. This is
30059 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30060 associated with the DATA command.
30061
30062 .cindex CHUNKING "BDAT command"
30063 .cindex BDAT "SMTP command"
30064 .cindex "RFC 3030" CHUNKING
30065 If CHUNKING was advertised and a BDAT command sequence is received,
30066 the &%acl_smtp_predata%& ACL is not run.
30067 . XXX why not?  It should be possible, for the first BDAT.
30068 The &%acl_smtp_data%& is run after the last BDAT command and all of
30069 the data specified is received.
30070
30071 For both of these ACLs, it is not possible to reject individual recipients. An
30072 error response rejects the entire message. Unfortunately, it is known that some
30073 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30074 before or after the data) correctly &-- they keep the message on their queues
30075 and try again later, but that is their problem, though it does waste some of
30076 your resources.
30077
30078 The &%acl_smtp_data%& ACL is run after
30079 the &%acl_smtp_data_prdr%&,
30080 the &%acl_smtp_dkim%&
30081 and the &%acl_smtp_mime%& ACLs.
30082
30083 .section "The SMTP DKIM ACL" "SECTDKIMACL"
30084 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30085 enabled (which is the default).
30086
30087 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30088 received, and is executed for each DKIM signature found in a message.  If not
30089 otherwise specified, the default action is to accept.
30090
30091 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30092
30093 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30094
30095
30096 .section "The SMTP MIME ACL" "SECID194"
30097 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30098 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30099
30100 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30101
30102
30103 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30104 .cindex "PRDR" "ACL for"
30105 .oindex "&%prdr_enable%&"
30106 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30107 with PRDR support enabled (which is the default).
30108 It becomes active only when the PRDR feature is negotiated between
30109 client and server for a message, and more than one recipient
30110 has been accepted.
30111
30112 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30113 has been received, and is executed once for each recipient of the message
30114 with &$local_part$& and &$domain$& valid.
30115 The test may accept, defer or deny for individual recipients.
30116 The &%acl_smtp_data%& will still be called after this ACL and
30117 can reject the message overall, even if this ACL has accepted it
30118 for some or all recipients.
30119
30120 PRDR may be used to support per-user content filtering.  Without it
30121 one must defer any recipient after the first that has a different
30122 content-filter configuration.  With PRDR, the RCPT-time check
30123 .cindex "PRDR" "variable for"
30124 for this can be disabled when the variable &$prdr_requested$&
30125 is &"yes"&.
30126 Any required difference in behaviour of the main DATA-time
30127 ACL should however depend on the PRDR-time ACL having run, as Exim
30128 will avoid doing so in some situations (e.g. single-recipient mails).
30129
30130 See also the &%prdr_enable%& global option
30131 and the &%hosts_try_prdr%& smtp transport option.
30132
30133 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30134 If the ACL is not defined, processing completes as if
30135 the feature was not requested by the client.
30136
30137 .section "The QUIT ACL" "SECTQUITACL"
30138 .cindex "QUIT, ACL for"
30139 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30140 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30141 does not in fact control any access.
30142 For this reason, it may only accept
30143 or warn as its final result.
30144
30145 This ACL can be used for tasks such as custom logging at the end of an SMTP
30146 session. For example, you can use ACL variables in other ACLs to count
30147 messages, recipients, etc., and log the totals at QUIT time using one or
30148 more &%logwrite%& modifiers on a &%warn%& verb.
30149
30150 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30151 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30152
30153 You do not need to have a final &%accept%&, but if you do, you can use a
30154 &%message%& modifier to specify custom text that is sent as part of the 221
30155 response to QUIT.
30156
30157 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30158 failure (for example, failure to open a log file, or when Exim is bombing out
30159 because it has detected an unrecoverable error), all SMTP commands from the
30160 client are given temporary error responses until QUIT is received or the
30161 connection is closed. In these special cases, the QUIT ACL does not run.
30162
30163
30164 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30165 .vindex &$acl_smtp_notquit$&
30166 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30167 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30168 trouble, such as being unable to write to its log files, this ACL is not run,
30169 because it might try to do things (such as write to log files) that make the
30170 situation even worse.
30171
30172 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30173 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30174 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30175 and &%warn%&.
30176
30177 .vindex &$smtp_notquit_reason$&
30178 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30179 to a string that indicates the reason for the termination of the SMTP
30180 connection. The possible values are:
30181 .table2
30182 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30183 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30184 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30185 .irow &`connection-lost`&          "The SMTP connection has been lost"
30186 .irow &`data-timeout`&             "Timeout while reading message data"
30187 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30188 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30189 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30190 .irow &`synchronization-error`&    "SMTP synchronization error"
30191 .irow &`tls-failed`&               "TLS failed to start"
30192 .endtable
30193 In most cases when an SMTP connection is closed without having received QUIT,
30194 Exim sends an SMTP response message before actually closing the connection.
30195 With the exception of the &`acl-drop`& case, the default message can be
30196 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30197 &%drop%& verb in another ACL, it is the message from the other ACL that is
30198 used.
30199
30200
30201 .section "Finding an ACL to use" "SECID195"
30202 .cindex "&ACL;" "finding which to use"
30203 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30204 you can use different ACLs in different circumstances. For example,
30205 .code
30206 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30207                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30208 .endd
30209 In the default configuration file there are some example settings for
30210 providing an RFC 4409 message &"submission"& service on port 587 and
30211 an RFC 8314 &"submissions"& service on port 465. You can use a string
30212 expansion like this to choose an ACL for MUAs on these ports which is
30213 more appropriate for this purpose than the default ACL on port 25.
30214
30215 The expanded string does not have to be the name of an ACL in the
30216 configuration file; there are other possibilities. Having expanded the
30217 string, Exim searches for an ACL as follows:
30218
30219 .ilist
30220 If the string begins with a slash, Exim uses it as a filename, and reads its
30221 contents as an ACL. The lines are processed in the same way as lines in the
30222 Exim configuration file. In particular, continuation lines are supported, blank
30223 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30224 If the file does not exist or cannot be read, an error occurs (typically
30225 causing a temporary failure of whatever caused the ACL to be run). For example:
30226 .code
30227 acl_smtp_data = /etc/acls/\
30228   ${lookup{$sender_host_address}lsearch\
30229   {/etc/acllist}{$value}{default}}
30230 .endd
30231 This looks up an ACL file to use on the basis of the host's IP address, falling
30232 back to a default if the lookup fails. If an ACL is successfully read from a
30233 file, it is retained in memory for the duration of the Exim process, so that it
30234 can be re-used without having to re-read the file.
30235 .next
30236 If the string does not start with a slash, and does not contain any spaces,
30237 Exim searches the ACL section of the configuration for an ACL whose name
30238 matches the string.
30239 .next
30240 If no named ACL is found, or if the string contains spaces, Exim parses
30241 the string as an inline ACL. This can save typing in cases where you just
30242 want to have something like
30243 .code
30244 acl_smtp_vrfy = accept
30245 .endd
30246 in order to allow free use of the VRFY command. Such a string may contain
30247 newlines; it is processed in the same way as an ACL that is read from a file.
30248 .endlist
30249
30250
30251
30252
30253 .section "ACL return codes" "SECID196"
30254 .cindex "&ACL;" "return codes"
30255 Except for the QUIT ACL, which does not affect the SMTP return code (see
30256 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30257 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30258 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30259 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30260 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30261 This also causes a 4&'xx'& return code.
30262
30263 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30264 &"deny"&, because there is no mechanism for passing temporary errors to the
30265 submitters of non-SMTP messages.
30266
30267
30268 ACLs that are relevant to message reception may also return &"discard"&. This
30269 has the effect of &"accept"&, but causes either the entire message or an
30270 individual recipient address to be discarded. In other words, it is a
30271 blackholing facility. Use it with care.
30272
30273 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30274 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30275 RCPT ACL is to discard just the one recipient address. If there are no
30276 recipients left when the message's data is received, the DATA ACL is not
30277 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30278 remaining recipients. The &"discard"& return is not permitted for the
30279 &%acl_smtp_predata%& ACL.
30280
30281 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30282 is done on the address and the result determines the SMTP response.
30283
30284
30285 .cindex "&[local_scan()]& function" "when all recipients discarded"
30286 The &[local_scan()]& function is always run, even if there are no remaining
30287 recipients; it may create new recipients.
30288
30289
30290
30291 .section "Unset ACL options" "SECID197"
30292 .cindex "&ACL;" "unset options"
30293 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30294 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30295 not defined at all. For any defined ACL, the default action when control
30296 reaches the end of the ACL statements is &"deny"&.
30297
30298 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30299 these two are ACLs that are used only for their side effects. They cannot be
30300 used to accept or reject anything.
30301
30302 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30303 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30304 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30305 when the ACL is not defined is &"accept"&.
30306
30307 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30308 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30309 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30310 messages over an SMTP connection. For an example, see the ACL in the default
30311 configuration file.
30312
30313
30314
30315
30316 .section "Data for message ACLs" "SECID198"
30317 .cindex "&ACL;" "data for message ACL"
30318 .vindex &$domain$&
30319 .vindex &$local_part$&
30320 .vindex &$sender_address$&
30321 .vindex &$sender_host_address$&
30322 .vindex &$smtp_command$&
30323 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30324 that contain information about the host and the message's sender (for example,
30325 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30326 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30327 &$local_part$& are set from the argument address. The entire SMTP command
30328 is available in &$smtp_command$&.
30329
30330 When an ACL for the AUTH parameter of MAIL is running, the variables that
30331 contain information about the host are set, but &$sender_address$& is not yet
30332 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30333 how it is used.
30334
30335 .vindex "&$message_size$&"
30336 The &$message_size$& variable is set to the value of the SIZE parameter on
30337 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30338 that parameter is not given. The value is updated to the true message size by
30339 the time the final DATA ACL is run (after the message data has been
30340 received).
30341
30342 .vindex "&$rcpt_count$&"
30343 .vindex "&$recipients_count$&"
30344 The &$rcpt_count$& variable increases by one for each RCPT command received.
30345 The &$recipients_count$& variable increases by one each time a RCPT command is
30346 accepted, so while an ACL for RCPT is being processed, it contains the number
30347 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30348 &$rcpt_count$& contains the total number of RCPT commands, and
30349 &$recipients_count$& contains the total number of accepted recipients.
30350
30351
30352
30353
30354
30355 .section "Data for non-message ACLs" "SECTdatfornon"
30356 .cindex "&ACL;" "data for non-message ACL"
30357 .vindex &$smtp_command_argument$&
30358 .vindex &$smtp_command$&
30359 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30360 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30361 and the entire SMTP command is available in &$smtp_command$&.
30362 These variables can be tested using a &%condition%& condition. For example,
30363 here is an ACL for use with AUTH, which insists that either the session is
30364 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30365 does not permit authentication methods that use cleartext passwords on
30366 unencrypted connections.
30367 .code
30368 acl_check_auth:
30369   accept encrypted = *
30370   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30371                      {CRAM-MD5}}
30372   deny   message   = TLS encryption or CRAM-MD5 required
30373 .endd
30374 (Another way of applying this restriction is to arrange for the authenticators
30375 that use cleartext passwords not to be advertised when the connection is not
30376 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30377 option to do this.)
30378
30379
30380
30381 .section "Format of an ACL" "SECID199"
30382 .cindex "&ACL;" "format of"
30383 .cindex "&ACL;" "verbs, definition of"
30384 An individual ACL consists of a number of statements. Each statement starts
30385 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30386 Modifiers can change the way the verb operates, define error and log messages,
30387 set variables, insert delays, and vary the processing of accepted messages.
30388
30389 If all the conditions are met, the verb is obeyed. The same condition may be
30390 used (with different arguments) more than once in the same statement. This
30391 provides a means of specifying an &"and"& conjunction between conditions. For
30392 example:
30393 .code
30394 deny  dnslists = list1.example
30395       dnslists = list2.example
30396 .endd
30397 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30398 the conditions and modifiers when it reaches a condition that fails. What
30399 happens then depends on the verb (and in one case, on a special modifier). Not
30400 all the conditions make sense at every testing point. For example, you cannot
30401 test a sender address in the ACL that is run for a VRFY command.
30402
30403
30404 .section "ACL verbs" "SECID200"
30405 The ACL verbs are as follows:
30406
30407 .ilist
30408 .cindex "&%accept%& ACL verb"
30409 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30410 of the conditions are not met, what happens depends on whether &%endpass%&
30411 appears among the conditions (for syntax see below). If the failing condition
30412 is before &%endpass%&, control is passed to the next ACL statement; if it is
30413 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30414 check a RCPT command:
30415 .code
30416 accept domains = +local_domains
30417        endpass
30418        verify = recipient
30419 .endd
30420 If the recipient domain does not match the &%domains%& condition, control
30421 passes to the next statement. If it does match, the recipient is verified, and
30422 the command is accepted if verification succeeds. However, if verification
30423 fails, the ACL yields &"deny"&, because the failing condition is after
30424 &%endpass%&.
30425
30426 The &%endpass%& feature has turned out to be confusing to many people, so its
30427 use is not recommended nowadays. It is always possible to rewrite an ACL so
30428 that &%endpass%& is not needed, and it is no longer used in the default
30429 configuration.
30430
30431 .cindex "&%message%& ACL modifier" "with &%accept%&"
30432 If a &%message%& modifier appears on an &%accept%& statement, its action
30433 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30434 (when an &%accept%& verb either accepts or passes control to the next
30435 statement), &%message%& can be used to vary the message that is sent when an
30436 SMTP command is accepted. For example, in a RCPT ACL you could have:
30437 .display
30438 &`accept  `&<&'some conditions'&>
30439 &`        message = OK, I will allow you through today`&
30440 .endd
30441 You can specify an SMTP response code, optionally followed by an &"extended
30442 response code"& at the start of the message, but the first digit must be the
30443 same as would be sent by default, which is 2 for an &%accept%& verb.
30444
30445 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30446 an error message that is used when access is denied. This behaviour is retained
30447 for backward compatibility, but current &"best practice"& is to avoid the use
30448 of &%endpass%&.
30449
30450
30451 .next
30452 .cindex "&%defer%& ACL verb"
30453 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30454 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30455 &%defer%& is the same as &%deny%&, because there is no way of sending a
30456 temporary error. For a RCPT command, &%defer%& is much the same as using a
30457 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30458 be used in any ACL, and even for a recipient it might be a simpler approach.
30459
30460
30461 .next
30462 .cindex "&%deny%& ACL verb"
30463 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30464 the conditions are not met, control is passed to the next ACL statement. For
30465 example,
30466 .code
30467 deny dnslists = blackholes.mail-abuse.org
30468 .endd
30469 rejects commands from hosts that are on a DNS black list.
30470
30471
30472 .next
30473 .cindex "&%discard%& ACL verb"
30474 &%discard%&: This verb behaves like &%accept%&, except that it returns
30475 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30476 that are concerned with receiving messages. When all the conditions are true,
30477 the sending entity receives a &"success"& response. However, &%discard%& causes
30478 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30479 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30480 message's recipients are discarded. Recipients that are discarded before DATA
30481 do not appear in the log line when the &%received_recipients%& log selector is set.
30482
30483 If the &%log_message%& modifier is set when &%discard%& operates,
30484 its contents are added to the line that is automatically written to the log.
30485 The &%message%& modifier operates exactly as it does for &%accept%&.
30486
30487
30488 .next
30489 .cindex "&%drop%& ACL verb"
30490 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30491 forcibly closed after the 5&'xx'& error message has been sent. For example:
30492 .code
30493 drop   condition = ${if > {$rcpt_count}{20}}
30494        message   = I don't take more than 20 RCPTs
30495 .endd
30496 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30497 The connection is always dropped after sending a 550 response.
30498
30499 .next
30500 .cindex "&%require%& ACL verb"
30501 &%require%&: If all the conditions are met, control is passed to the next ACL
30502 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30503 example, when checking a RCPT command,
30504 .code
30505 require message = Sender did not verify
30506         verify  = sender
30507 .endd
30508 passes control to subsequent statements only if the message's sender can be
30509 verified. Otherwise, it rejects the command. Note the positioning of the
30510 &%message%& modifier, before the &%verify%& condition. The reason for this is
30511 discussed in section &<<SECTcondmodproc>>&.
30512
30513 .next
30514 .cindex "&%warn%& ACL verb"
30515 &%warn%&: If all the conditions are true, a line specified by the
30516 &%log_message%& modifier is written to Exim's main log. Control always passes
30517 to the next ACL statement. If any condition is false, the log line is not
30518 written. If an identical log line is requested several times in the same
30519 message, only one copy is actually written to the log. If you want to force
30520 duplicates to be written, use the &%logwrite%& modifier instead.
30521
30522 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30523 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30524 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30525 first failing condition. There is more about adding header lines in section
30526 &<<SECTaddheadacl>>&.
30527
30528 If any condition on a &%warn%& statement cannot be completed (that is, there is
30529 some sort of defer), the log line specified by &%log_message%& is not written.
30530 This does not include the case of a forced failure from a lookup, which
30531 is considered to be a successful completion. After a defer, no further
30532 conditions or modifiers in the &%warn%& statement are processed. The incident
30533 is logged, and the ACL continues to be processed, from the next statement
30534 onwards.
30535
30536
30537 .vindex "&$acl_verify_message$&"
30538 When one of the &%warn%& conditions is an address verification that fails, the
30539 text of the verification failure message is in &$acl_verify_message$&. If you
30540 want this logged, you must set it up explicitly. For example:
30541 .code
30542 warn   !verify = sender
30543        log_message = sender verify failed: $acl_verify_message
30544 .endd
30545 .endlist
30546
30547 At the end of each ACL there is an implicit unconditional &%deny%&.
30548
30549 As you can see from the examples above, the conditions and modifiers are
30550 written one to a line, with the first one on the same line as the verb, and
30551 subsequent ones on following lines. If you have a very long condition, you can
30552 continue it onto several physical lines by the usual backslash continuation
30553 mechanism. It is conventional to align the conditions vertically.
30554
30555
30556
30557 .section "ACL variables" "SECTaclvariables"
30558 .cindex "&ACL;" "variables"
30559 There are some special variables that can be set during ACL processing. They
30560 can be used to pass information between different ACLs, different invocations
30561 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30562 transports, and filters that are used to deliver a message. The names of these
30563 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30564 an underscore, but the remainder of the name can be any sequence of
30565 alphanumeric characters and underscores that you choose. There is no limit on
30566 the number of ACL variables. The two sets act as follows:
30567 .ilist
30568 The values of those variables whose names begin with &$acl_c$& persist
30569 throughout an SMTP connection. They are never reset. Thus, a value that is set
30570 while receiving one message is still available when receiving the next message
30571 on the same SMTP connection.
30572 .next
30573 The values of those variables whose names begin with &$acl_m$& persist only
30574 while a message is being received. They are reset afterwards. They are also
30575 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30576 .endlist
30577
30578 When a message is accepted, the current values of all the ACL variables are
30579 preserved with the message and are subsequently made available at delivery
30580 time. The ACL variables are set by a modifier called &%set%&. For example:
30581 .code
30582 accept hosts = whatever
30583        set acl_m4 = some value
30584 accept authenticated = *
30585        set acl_c_auth = yes
30586 .endd
30587 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30588 be set. If you want to set a variable without taking any action, you can use a
30589 &%warn%& verb without any other modifiers or conditions.
30590
30591 .oindex &%strict_acl_vars%&
30592 What happens if a syntactically valid but undefined ACL variable is
30593 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30594 false (the default), an empty string is substituted; if it is true, an
30595 error is generated.
30596
30597 Versions of Exim before 4.64 have a limited set of numbered variables, but
30598 their names are compatible, so there is no problem with upgrading.
30599
30600
30601 .section "Condition and modifier processing" "SECTcondmodproc"
30602 .cindex "&ACL;" "conditions; processing"
30603 .cindex "&ACL;" "modifiers; processing"
30604 An exclamation mark preceding a condition negates its result. For example:
30605 .code
30606 deny   domains = *.dom.example
30607       !verify  = recipient
30608 .endd
30609 causes the ACL to return &"deny"& if the recipient domain ends in
30610 &'dom.example'& and the recipient address cannot be verified. Sometimes
30611 negation can be used on the right-hand side of a condition. For example, these
30612 two statements are equivalent:
30613 .code
30614 deny  hosts = !192.168.3.4
30615 deny !hosts =  192.168.3.4
30616 .endd
30617 However, for many conditions (&%verify%& being a good example), only left-hand
30618 side negation of the whole condition is possible.
30619
30620 The arguments of conditions and modifiers are expanded. A forced failure
30621 of an expansion causes a condition to be ignored, that is, it behaves as if the
30622 condition is true. Consider these two statements:
30623 .code
30624 accept  senders = ${lookup{$host_name}lsearch\
30625                   {/some/file}{$value}fail}
30626 accept  senders = ${lookup{$host_name}lsearch\
30627                   {/some/file}{$value}{}}
30628 .endd
30629 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30630 the returned list is searched, but if the lookup fails the behaviour is
30631 different in the two cases. The &%fail%& in the first statement causes the
30632 condition to be ignored, leaving no further conditions. The &%accept%& verb
30633 therefore succeeds. The second statement, however, generates an empty list when
30634 the lookup fails. No sender can match an empty list, so the condition fails,
30635 and therefore the &%accept%& also fails.
30636
30637 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30638 specify actions that are taken as the conditions for a statement are checked;
30639 others specify text for messages that are used when access is denied or a
30640 warning is generated. The &%control%& modifier affects the way an incoming
30641 message is handled.
30642
30643 The positioning of the modifiers in an ACL statement is important, because the
30644 processing of a verb ceases as soon as its outcome is known. Only those
30645 modifiers that have already been encountered will take effect. For example,
30646 consider this use of the &%message%& modifier:
30647 .code
30648 require message = Can't verify sender
30649         verify  = sender
30650         message = Can't verify recipient
30651         verify  = recipient
30652         message = This message cannot be used
30653 .endd
30654 If sender verification fails, Exim knows that the result of the statement is
30655 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30656 so its text is used as the error message. If sender verification succeeds, but
30657 recipient verification fails, the second message is used. If recipient
30658 verification succeeds, the third message becomes &"current"&, but is never used
30659 because there are no more conditions to cause failure.
30660
30661 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30662 modifier that is used, because all the conditions must be true for rejection to
30663 happen. Specifying more than one &%message%& modifier does not make sense, and
30664 the message can even be specified after all the conditions. For example:
30665 .code
30666 deny   hosts = ...
30667       !senders = *@my.domain.example
30668        message = Invalid sender from client host
30669 .endd
30670 The &"deny"& result does not happen until the end of the statement is reached,
30671 by which time Exim has set up the message.
30672
30673
30674
30675 .section "ACL modifiers" "SECTACLmodi"
30676 .cindex "&ACL;" "modifiers; list of"
30677 The ACL modifiers are as follows:
30678
30679 .vlist
30680 .vitem &*add_header*&&~=&~<&'text'&>
30681 This modifier specifies one or more header lines that are to be added to an
30682 incoming message, assuming, of course, that the message is ultimately
30683 accepted. For details, see section &<<SECTaddheadacl>>&.
30684
30685 .vitem &*continue*&&~=&~<&'text'&>
30686 .cindex "&%continue%& ACL modifier"
30687 .cindex "database" "updating in ACL"
30688 This modifier does nothing of itself, and processing of the ACL always
30689 continues with the next condition or modifier. The value of &%continue%& is in
30690 the side effects of expanding its argument. Typically this could be used to
30691 update a database. It is really just a syntactic tidiness, to avoid having to
30692 write rather ugly lines like this:
30693 .display
30694 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30695 .endd
30696 Instead, all you need is
30697 .display
30698 &`continue = `&<&'some expansion'&>
30699 .endd
30700
30701 .vitem &*control*&&~=&~<&'text'&>
30702 .cindex "&%control%& ACL modifier"
30703 This modifier affects the subsequent processing of the SMTP connection or of an
30704 incoming message that is accepted. The effect of the first type of control
30705 lasts for the duration of the connection, whereas the effect of the second type
30706 lasts only until the current message has been received. The message-specific
30707 controls always apply to the whole message, not to individual recipients,
30708 even if the &%control%& modifier appears in a RCPT ACL.
30709
30710 As there are now quite a few controls that can be applied, they are described
30711 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30712 in several different ways. For example:
30713
30714 . ==== As this is a nested list, any displays it contains must be indented
30715 . ==== as otherwise they are too far to the left. That comment applies only
30716 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30717 . ==== way.
30718
30719 .ilist
30720 It can be at the end of an &%accept%& statement:
30721 .code
30722     accept  ...some conditions
30723             control = queue
30724 .endd
30725 In this case, the control is applied when this statement yields &"accept"&, in
30726 other words, when the conditions are all true.
30727
30728 .next
30729 It can be in the middle of an &%accept%& statement:
30730 .code
30731     accept  ...some conditions...
30732             control = queue
30733             ...some more conditions...
30734 .endd
30735 If the first set of conditions are true, the control is applied, even if the
30736 statement does not accept because one of the second set of conditions is false.
30737 In this case, some subsequent statement must yield &"accept"& for the control
30738 to be relevant.
30739
30740 .next
30741 It can be used with &%warn%& to apply the control, leaving the
30742 decision about accepting or denying to a subsequent verb. For
30743 example:
30744 .code
30745     warn    ...some conditions...
30746             control = freeze
30747     accept  ...
30748 .endd
30749 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30750 &%logwrite%&, so it does not add anything to the message and does not write a
30751 log entry.
30752
30753 .next
30754 If you want to apply a control unconditionally, you can use it with a
30755 &%require%& verb. For example:
30756 .code
30757     require  control = no_multiline_responses
30758 .endd
30759 .endlist
30760
30761 .vitem &*delay*&&~=&~<&'time'&>
30762 .cindex "&%delay%& ACL modifier"
30763 .oindex "&%-bh%&"
30764 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30765 the time interval before proceeding. However, when testing Exim using the
30766 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30767 output instead). The time is given in the usual Exim notation, and the delay
30768 happens as soon as the modifier is processed. In an SMTP session, pending
30769 output is flushed before the delay is imposed.
30770
30771 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30772 example:
30773 .code
30774 deny    ...some conditions...
30775         delay = 30s
30776 .endd
30777 The delay happens if all the conditions are true, before the statement returns
30778 &"deny"&. Compare this with:
30779 .code
30780 deny    delay = 30s
30781         ...some conditions...
30782 .endd
30783 which waits for 30s before processing the conditions. The &%delay%& modifier
30784 can also be used with &%warn%& and together with &%control%&:
30785 .code
30786 warn    ...some conditions...
30787         delay = 2m
30788         control = freeze
30789 accept  ...
30790 .endd
30791
30792 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30793 responses to several commands are no longer buffered and sent in one packet (as
30794 they would normally be) because all output is flushed before imposing the
30795 delay. This optimization is disabled so that a number of small delays do not
30796 appear to the client as one large aggregated delay that might provoke an
30797 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30798 using a &%control%& modifier to set &%no_delay_flush%&.
30799
30800
30801 .vitem &*endpass*&
30802 .cindex "&%endpass%& ACL modifier"
30803 This modifier, which has no argument, is recognized only in &%accept%& and
30804 &%discard%& statements. It marks the boundary between the conditions whose
30805 failure causes control to pass to the next statement, and the conditions whose
30806 failure causes the ACL to return &"deny"&. This concept has proved to be
30807 confusing to some people, so the use of &%endpass%& is no longer recommended as
30808 &"best practice"&. See the description of &%accept%& above for more details.
30809
30810
30811 .vitem &*log_message*&&~=&~<&'text'&>
30812 .cindex "&%log_message%& ACL modifier"
30813 This modifier sets up a message that is used as part of the log message if the
30814 ACL denies access or a &%warn%& statement's conditions are true. For example:
30815 .code
30816 require log_message = wrong cipher suite $tls_in_cipher
30817         encrypted   = DES-CBC3-SHA
30818 .endd
30819 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30820 example:
30821 .display
30822 &`discard `&<&'some conditions'&>
30823 &`        log_message = Discarded $local_part@$domain because...`&
30824 .endd
30825 When access is denied, &%log_message%& adds to any underlying error message
30826 that may exist because of a condition failure. For example, while verifying a
30827 recipient address, a &':fail:'& redirection might have already set up a
30828 message.
30829
30830 The message may be defined before the conditions to which it applies, because
30831 the string expansion does not happen until Exim decides that access is to be
30832 denied. This means that any variables that are set by the condition are
30833 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30834 variables are set after a DNS black list lookup succeeds. If the expansion of
30835 &%log_message%& fails, or if the result is an empty string, the modifier is
30836 ignored.
30837
30838 .vindex "&$acl_verify_message$&"
30839 If you want to use a &%warn%& statement to log the result of an address
30840 verification, you can use &$acl_verify_message$& to include the verification
30841 error message.
30842
30843 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30844 the start of the logged message. If the same warning log message is requested
30845 more than once while receiving  a single email message, only one copy is
30846 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30847 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30848 is logged for a successful &%warn%& statement.
30849
30850 If &%log_message%& is not present and there is no underlying error message (for
30851 example, from the failure of address verification), but &%message%& is present,
30852 the &%message%& text is used for logging rejections. However, if any text for
30853 logging contains newlines, only the first line is logged. In the absence of
30854 both &%log_message%& and &%message%&, a default built-in message is used for
30855 logging rejections.
30856
30857
30858 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30859 .cindex "&%log_reject_target%& ACL modifier"
30860 .cindex "logging in ACL" "specifying which log"
30861 This modifier makes it possible to specify which logs are used for messages
30862 about ACL rejections. Its argument is a colon-separated list of words that can
30863 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30864 may be empty, in which case a rejection is not logged at all. For example, this
30865 ACL fragment writes no logging information when access is denied:
30866 .display
30867 &`deny `&<&'some conditions'&>
30868 &`     log_reject_target =`&
30869 .endd
30870 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30871 permanent and temporary rejections. Its effect lasts for the rest of the
30872 current ACL.
30873
30874
30875 .vitem &*logwrite*&&~=&~<&'text'&>
30876 .cindex "&%logwrite%& ACL modifier"
30877 .cindex "logging in ACL" "immediate"
30878 This modifier writes a message to a log file as soon as it is encountered when
30879 processing an ACL. (Compare &%log_message%&, which, except in the case of
30880 &%warn%& and &%discard%&, is used only if the ACL statement denies
30881 access.) The &%logwrite%& modifier can be used to log special incidents in
30882 ACLs. For example:
30883 .display
30884 &`accept `&<&'some special conditions'&>
30885 &`       control  = freeze`&
30886 &`       logwrite = froze message because ...`&
30887 .endd
30888 By default, the message is written to the main log. However, it may begin
30889 with a colon, followed by a comma-separated list of log names, and then
30890 another colon, to specify exactly which logs are to be written. For
30891 example:
30892 .code
30893 logwrite = :main,reject: text for main and reject logs
30894 logwrite = :panic: text for panic log only
30895 .endd
30896
30897
30898 .vitem &*message*&&~=&~<&'text'&>
30899 .cindex "&%message%& ACL modifier"
30900 This modifier sets up a text string that is expanded and used as a response
30901 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30902 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30903 there is some complication if &%endpass%& is involved; see the description of
30904 &%accept%& for details.)
30905
30906 The expansion of the message happens at the time Exim decides that the ACL is
30907 to end, not at the time it processes &%message%&. If the expansion fails, or
30908 generates an empty string, the modifier is ignored. Here is an example where
30909 &%message%& must be specified first, because the ACL ends with a rejection if
30910 the &%hosts%& condition fails:
30911 .code
30912 require  message = Host not recognized
30913          hosts = 10.0.0.0/8
30914 .endd
30915 (Once a condition has failed, no further conditions or modifiers are
30916 processed.)
30917
30918 .cindex "SMTP" "error codes"
30919 .oindex "&%smtp_banner%&
30920 For ACLs that are triggered by SMTP commands, the message is returned as part
30921 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30922 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30923 is accepted. In the case of the connect ACL, accepting with a message modifier
30924 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30925 accept message may not contain more than one line (otherwise it will be
30926 truncated at the first newline and a panic logged), and it cannot affect the
30927 EHLO options.
30928
30929 When SMTP is involved, the message may begin with an overriding response code,
30930 consisting of three digits optionally followed by an &"extended response code"&
30931 of the form &'n.n.n'&, each code being followed by a space. For example:
30932 .code
30933 deny  message = 599 1.2.3 Host not welcome
30934       hosts = 192.168.34.0/24
30935 .endd
30936 The first digit of the supplied response code must be the same as would be sent
30937 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30938 access, but for the predata ACL, note that the default success code is 354, not
30939 2&'xx'&.
30940
30941 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30942 the message modifier cannot override the 221 response code.
30943
30944 The text in a &%message%& modifier is literal; any quotes are taken as
30945 literals, but because the string is expanded, backslash escapes are processed
30946 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30947 response.
30948
30949 .vindex "&$acl_verify_message$&"
30950 For ACLs that are called by an &%acl =%& ACL condition, the message is
30951 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30952
30953 If &%message%& is used on a statement that verifies an address, the message
30954 specified overrides any message that is generated by the verification process.
30955 However, the original message is available in the variable
30956 &$acl_verify_message$&, so you can incorporate it into your message if you
30957 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30958 routers to be passed back as part of the SMTP response, you should either not
30959 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30960
30961 For compatibility with previous releases of Exim, a &%message%& modifier that
30962 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30963 modifier, but this usage is now deprecated. However, &%message%& acts only when
30964 all the conditions are true, wherever it appears in an ACL command, whereas
30965 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30966 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30967 effect.
30968
30969
30970 .vitem &*queue*&&~=&~<&'text'&>
30971 .cindex "&%queue%& ACL modifier"
30972 .cindex "named queues" "selecting in ACL"
30973 This modifier specifies the use of a named queue for spool files
30974 for the message.
30975 It can only be used before the message is received (i.e. not in
30976 the DATA ACL).
30977 This could be used, for example, for known high-volume burst sources
30978 of traffic, or for quarantine of messages.
30979 Separate queue-runner processes will be needed for named queues.
30980 If the text after expansion is empty, the default queue is used.
30981
30982
30983 .vitem &*remove_header*&&~=&~<&'text'&>
30984 This modifier specifies one or more header names in a colon-separated list
30985  that are to be removed from an incoming message, assuming, of course, that
30986 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30987
30988
30989 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30990 .cindex "&%set%& ACL modifier"
30991 This modifier puts a value into one of the ACL variables (see section
30992 &<<SECTaclvariables>>&).
30993
30994
30995 .vitem &*udpsend*&&~=&~<&'parameters'&>
30996 .cindex "UDP communications"
30997 This modifier sends a UDP packet, for purposes such as statistics
30998 collection or behaviour monitoring. The parameters are expanded, and
30999 the result of the expansion must be a colon-separated list consisting
31000 of a destination server, port number, and the packet contents. The
31001 server can be specified as a host name or IPv4 or IPv6 address. The
31002 separator can be changed with the usual angle bracket syntax. For
31003 example, you might want to collect information on which hosts connect
31004 when:
31005 .code
31006 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31007              $tod_zulu $sender_host_address
31008 .endd
31009 .endlist
31010
31011
31012
31013
31014 .section "Use of the control modifier" "SECTcontrols"
31015 .cindex "&%control%& ACL modifier"
31016 The &%control%& modifier supports the following settings:
31017
31018 .vlist
31019 .vitem &*control&~=&~allow_auth_unadvertised*&
31020 This modifier allows a client host to use the SMTP AUTH command even when it
31021 has not been advertised in response to EHLO. Furthermore, because there are
31022 apparently some really broken clients that do this, Exim will accept AUTH after
31023 HELO (rather than EHLO) when this control is set. It should be used only if you
31024 really need it, and you should limit its use to those broken clients that do
31025 not work without it. For example:
31026 .code
31027 warn hosts   = 192.168.34.25
31028      control = allow_auth_unadvertised
31029 .endd
31030 Normally, when an Exim server receives an AUTH command, it checks the name of
31031 the authentication mechanism that is given in the command to ensure that it
31032 matches an advertised mechanism. When this control is set, the check that a
31033 mechanism has been advertised is bypassed. Any configured mechanism can be used
31034 by the client. This control is permitted only in the connection and HELO ACLs.
31035
31036
31037 .vitem &*control&~=&~caseful_local_part*& &&&
31038        &*control&~=&~caselower_local_part*&
31039 .cindex "&ACL;" "case of local part in"
31040 .cindex "case of local parts"
31041 .vindex "&$local_part$&"
31042 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31043 (that is, during RCPT processing). By default, the contents of &$local_part$&
31044 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31045 any uppercase letters in the original local part are restored in &$local_part$&
31046 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31047 is encountered.
31048
31049 These controls affect only the current recipient. Moreover, they apply only to
31050 local part handling that takes place directly in the ACL (for example, as a key
31051 in lookups). If a test to verify the recipient is obeyed, the case-related
31052 handling of the local part during the verification is controlled by the router
31053 configuration (see the &%caseful_local_part%& generic router option).
31054
31055 This facility could be used, for example, to add a spam score to local parts
31056 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31057 spam score:
31058 .code
31059 warn  control = caseful_local_part
31060       set acl_m4 = ${eval:\
31061                      $acl_m4 + \
31062                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31063                     }
31064       control = caselower_local_part
31065 .endd
31066 Notice that we put back the lower cased version afterwards, assuming that
31067 is what is wanted for subsequent tests.
31068
31069
31070 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31071 .cindex "&ACL;" "cutthrough routing"
31072 .cindex "cutthrough" "requesting"
31073 This option requests delivery be attempted while the item is being received.
31074
31075 The option is usable in the RCPT ACL.
31076 If enabled for a message received via smtp and routed to an smtp transport,
31077 and only one transport, interface, destination host and port combination
31078 is used for all recipients of the message,
31079 then the delivery connection is made while the receiving connection is open
31080 and data is copied from one to the other.
31081
31082 An attempt to set this option for any recipient but the first
31083 for a mail will be quietly ignored.
31084 If a recipient-verify callout
31085 (with use_sender)
31086 connection is subsequently
31087 requested in the same ACL it is held open and used for
31088 any subsequent recipients and the data,
31089 otherwise one is made after the initial RCPT ACL completes.
31090
31091 Note that routers are used in verify mode,
31092 and cannot depend on content of received headers.
31093 Note also that headers cannot be
31094 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31095 Headers may be modified by routers (subject to the above) and transports.
31096 The &'Received-By:'& header is generated as soon as the body reception starts,
31097 rather than the traditional time after the full message is received;
31098 this will affect the timestamp.
31099
31100 All the usual ACLs are called; if one results in the message being
31101 rejected, all effort spent in delivery (including the costs on
31102 the ultimate destination) will be wasted.
31103 Note that in the case of data-time ACLs this includes the entire
31104 message body.
31105
31106 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31107 of outgoing messages is done, because it sends data to the ultimate destination
31108 before the entire message has been received from the source.
31109 It is not supported for messages received with the SMTP PRDR
31110 or CHUNKING
31111 options in use.
31112
31113 Should the ultimate destination system positively accept or reject the mail,
31114 a corresponding indication is given to the source system and nothing is queued.
31115 If the item is successfully delivered in cutthrough mode
31116 the delivery log lines are tagged with ">>" rather than "=>" and appear
31117 before the acceptance "<=" line.
31118
31119 If there is a temporary error the item is queued for later delivery in the
31120 usual fashion.
31121 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31122 to the control; the default value is &"spool"& and the alternate value
31123 &"pass"& copies an SMTP defer response from the target back to the initiator
31124 and does not queue the message.
31125 Note that this is independent of any recipient verify conditions in the ACL.
31126
31127 Delivery in this mode avoids the generation of a bounce mail to a
31128 (possibly faked)
31129 sender when the destination system is doing content-scan based rejection.
31130
31131
31132 .vitem &*control&~=&~debug/*&<&'options'&>
31133 .cindex "&ACL;" "enabling debug logging"
31134 .cindex "debugging" "enabling from an ACL"
31135 This control turns on debug logging, almost as though Exim had been invoked
31136 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31137 by default called &'debuglog'&.
31138 The filename can be adjusted with the &'tag'& option, which
31139 may access any variables already defined.  The logging may be adjusted with
31140 the &'opts'& option, which takes the same values as the &`-d`& command-line
31141 option.
31142 Logging started this way may be stopped, and the file removed,
31143 with the &'kill'& option.
31144 Some examples (which depend on variables that don't exist in all
31145 contexts):
31146 .code
31147       control = debug
31148       control = debug/tag=.$sender_host_address
31149       control = debug/opts=+expand+acl
31150       control = debug/tag=.$message_exim_id/opts=+expand
31151       control = debug/kill
31152 .endd
31153
31154
31155 .vitem &*control&~=&~dkim_disable_verify*&
31156 .cindex "disable DKIM verify"
31157 .cindex "DKIM" "disable verify"
31158 This control turns off DKIM verification processing entirely.  For details on
31159 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31160
31161
31162 .vitem &*control&~=&~dmarc_disable_verify*&
31163 .cindex "disable DMARC verify"
31164 .cindex "DMARC" "disable verify"
31165 This control turns off DMARC verification processing entirely.  For details on
31166 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31167
31168
31169 .vitem &*control&~=&~dscp/*&<&'value'&>
31170 .cindex "&ACL;" "setting DSCP value"
31171 .cindex "DSCP" "inbound"
31172 This option causes the DSCP value associated with the socket for the inbound
31173 connection to be adjusted to a given value, given as one of a number of fixed
31174 strings or to numeric value.
31175 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31176 Common values include &`throughput`&, &`mincost`&, and on newer systems
31177 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31178
31179 The outbound packets from Exim will be marked with this value in the header
31180 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31181 that these values will have any effect, not be stripped by networking
31182 equipment, or do much of anything without cooperation with your Network
31183 Engineer and those of all network operators between the source and destination.
31184
31185
31186 .vitem &*control&~=&~enforce_sync*& &&&
31187        &*control&~=&~no_enforce_sync*&
31188 .cindex "SMTP" "synchronization checking"
31189 .cindex "synchronization checking in SMTP"
31190 These controls make it possible to be selective about when SMTP synchronization
31191 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31192 state of the switch (it is true by default). See the description of this option
31193 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31194
31195 The effect of these two controls lasts for the remainder of the SMTP
31196 connection. They can appear in any ACL except the one for the non-SMTP
31197 messages. The most straightforward place to put them is in the ACL defined by
31198 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31199 before the first synchronization check. The expected use is to turn off the
31200 synchronization checks for badly-behaved hosts that you nevertheless need to
31201 work with.
31202
31203
31204 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31205 .cindex "fake defer"
31206 .cindex "defer, fake"
31207 This control works in exactly the same way as &%fakereject%& (described below)
31208 except that it causes an SMTP 450 response after the message data instead of a
31209 550 response. You must take care when using &%fakedefer%& because it causes the
31210 messages to be duplicated when the sender retries. Therefore, you should not
31211 use &%fakedefer%& if the message is to be delivered normally.
31212
31213 .vitem &*control&~=&~fakereject/*&<&'message'&>
31214 .cindex "fake rejection"
31215 .cindex "rejection, fake"
31216 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31217 words, only when an SMTP message is being received. If Exim accepts the
31218 message, instead the final 250 response, a 550 rejection message is sent.
31219 However, Exim proceeds to deliver the message as normal. The control applies
31220 only to the current message, not to any subsequent ones that may be received in
31221 the same SMTP connection.
31222
31223 The text for the 550 response is taken from the &%control%& modifier. If no
31224 message is supplied, the following is used:
31225 .code
31226 550-Your message has been rejected but is being
31227 550-kept for evaluation.
31228 550-If it was a legitimate message, it may still be
31229 550 delivered to the target recipient(s).
31230 .endd
31231 This facility should be used with extreme caution.
31232
31233 .vitem &*control&~=&~freeze*&
31234 .cindex "frozen messages" "forcing in ACL"
31235 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31236 other words, only when a message is being received. If the message is accepted,
31237 it is placed on Exim's queue and frozen. The control applies only to the
31238 current message, not to any subsequent ones that may be received in the same
31239 SMTP connection.
31240
31241 This modifier can optionally be followed by &`/no_tell`&. If the global option
31242 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31243 is told about the freezing), provided all the &*control=freeze*& modifiers that
31244 are obeyed for the current message have the &`/no_tell`& option.
31245
31246 .vitem &*control&~=&~no_delay_flush*&
31247 .cindex "SMTP" "output flushing, disabling for delay"
31248 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31249 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31250 use. This control, as long as it is encountered before the &%delay%& modifier,
31251 disables such output flushing.
31252
31253 .vitem &*control&~=&~no_callout_flush*&
31254 .cindex "SMTP" "output flushing, disabling for callout"
31255 Exim normally flushes SMTP output before performing a callout in an ACL, to
31256 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31257 use. This control, as long as it is encountered before the &%verify%& condition
31258 that causes the callout, disables such output flushing.
31259
31260 .vitem &*control&~=&~no_mbox_unspool*&
31261 This control is available when Exim is compiled with the content scanning
31262 extension. Content scanning may require a copy of the current message, or parts
31263 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31264 or spam scanner. Normally, such copies are deleted when they are no longer
31265 needed. If this control is set, the copies are not deleted. The control applies
31266 only to the current message, not to any subsequent ones that may be received in
31267 the same SMTP connection. It is provided for debugging purposes and is unlikely
31268 to be useful in production.
31269
31270 .vitem &*control&~=&~no_multiline_responses*&
31271 .cindex "multiline responses, suppressing"
31272 This control is permitted for any ACL except the one for non-SMTP messages.
31273 It seems that there are broken clients in use that cannot handle multiline
31274 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31275
31276 If this control is set, multiline SMTP responses from ACL rejections are
31277 suppressed. One way of doing this would have been to put out these responses as
31278 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31279 (&"use multiline responses for more"& it says &-- ha!), and some of the
31280 responses might get close to that. So this facility, which is after all only a
31281 sop to broken clients, is implemented by doing two very easy things:
31282
31283 .ilist
31284 Extra information that is normally output as part of a rejection caused by
31285 sender verification failure is omitted. Only the final line (typically &"sender
31286 verification failed"&) is sent.
31287 .next
31288 If a &%message%& modifier supplies a multiline response, only the first
31289 line is output.
31290 .endlist
31291
31292 The setting of the switch can, of course, be made conditional on the
31293 calling host. Its effect lasts until the end of the SMTP connection.
31294
31295 .vitem &*control&~=&~no_pipelining*&
31296 .cindex "PIPELINING" "suppressing advertising"
31297 .cindex "ESMTP extensions" PIPELINING
31298 This control turns off the advertising of the PIPELINING extension to SMTP in
31299 the current session. To be useful, it must be obeyed before Exim sends its
31300 response to an EHLO command. Therefore, it should normally appear in an ACL
31301 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31302 &%pipelining_advertise_hosts%&.
31303
31304 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31305        &*control&~=&~queue_only*&
31306 .oindex "&%queue%&"
31307 .oindex "&%queue_only%&"
31308 .cindex "queueing incoming messages"
31309 .cindex queueing "forcing in ACL"
31310 .cindex "first pass routing"
31311 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31312 other words, only when a message is being received. If the message is accepted,
31313 it is placed on Exim's queue and left there for delivery by a subsequent queue
31314 runner.
31315 If used with no options set,
31316 no immediate delivery process is started. In other words, it has the
31317 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31318
31319 If the &'first_pass_route'& option is given then
31320 the behaviour is like the command-line &'-oqds'& option;
31321 a delivery process is started which stops short of making
31322 any SMTP delivery.  The benefit is that the hints database will be updated for
31323 the message being waiting for a specific host, and a later queue run will be
31324 able to send all such messages on a single connection.
31325
31326 The control only applies to the current message, not to any subsequent ones that
31327  may be received in the same SMTP connection.
31328
31329 .vitem &*control&~=&~submission/*&<&'options'&>
31330 .cindex "message" "submission"
31331 .cindex "submission mode"
31332 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31333 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31334 the current message is a submission from a local MUA. In this case, Exim
31335 operates in &"submission mode"&, and applies certain fixups to the message if
31336 necessary. For example, it adds a &'Date:'& header line if one is not present.
31337 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31338 late (the message has already been created).
31339
31340 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31341 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31342 submission mode; the available options for this control are described there.
31343 The control applies only to the current message, not to any subsequent ones
31344 that may be received in the same SMTP connection.
31345
31346 .vitem &*control&~=&~suppress_local_fixups*&
31347 .cindex "submission fixups, suppressing"
31348 This control applies to locally submitted (non TCP/IP) messages, and is the
31349 complement of &`control = submission`&. It disables the fixups that are
31350 normally applied to locally-submitted messages. Specifically:
31351
31352 .ilist
31353 Any &'Sender:'& header line is left alone (in this respect, it is a
31354 dynamic version of &%local_sender_retain%&).
31355 .next
31356 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31357 .next
31358 There is no check that &'From:'& corresponds to the actual sender.
31359 .endlist ilist
31360
31361 This control may be useful when a remotely-originated message is accepted,
31362 passed to some scanning program, and then re-submitted for delivery. It can be
31363 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31364 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31365 data is read.
31366
31367 &*Note:*& This control applies only to the current message, not to any others
31368 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31369
31370 .vitem &*control&~=&~utf8_downconvert*&
31371 This control enables conversion of UTF-8 in message envelope addresses
31372 to a-label form.
31373 For details see section &<<SECTi18nMTA>>&.
31374 .endlist vlist
31375
31376
31377 .section "Summary of message fixup control" "SECTsummesfix"
31378 All four possibilities for message fixups can be specified:
31379
31380 .ilist
31381 Locally submitted, fixups applied: the default.
31382 .next
31383 Locally submitted, no fixups applied: use
31384 &`control = suppress_local_fixups`&.
31385 .next
31386 Remotely submitted, no fixups applied: the default.
31387 .next
31388 Remotely submitted, fixups applied: use &`control = submission`&.
31389 .endlist
31390
31391
31392
31393 .section "Adding header lines in ACLs" "SECTaddheadacl"
31394 .cindex "header lines" "adding in an ACL"
31395 .cindex "header lines" "position of added lines"
31396 .cindex "&%add_header%& ACL modifier"
31397 The &%add_header%& modifier can be used to add one or more extra header lines
31398 to an incoming message, as in this example:
31399 .code
31400 warn dnslists = sbl.spamhaus.org : \
31401                 dialup.mail-abuse.org
31402      add_header = X-blacklisted-at: $dnslist_domain
31403 .endd
31404 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31405 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31406 receiving a message). The message must ultimately be accepted for
31407 &%add_header%& to have any significant effect. You can use &%add_header%& with
31408 any ACL verb, including &%deny%& (though this is potentially useful only in a
31409 RCPT ACL).
31410
31411 Headers will not be added to the message if the modifier is used in
31412 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31413
31414 Leading and trailing newlines are removed from
31415 the data for the &%add_header%& modifier; if it then
31416 contains one or more newlines that
31417 are not followed by a space or a tab, it is assumed to contain multiple header
31418 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31419 front of any line that is not a valid header line.
31420
31421 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31422 They are added to the message before processing the DATA and MIME ACLs.
31423 However, if an identical header line is requested more than once, only one copy
31424 is actually added to the message. Further header lines may be accumulated
31425 during the DATA and MIME ACLs, after which they are added to the message, again
31426 with duplicates suppressed. Thus, it is possible to add two identical header
31427 lines to an SMTP message, but only if one is added before DATA and one after.
31428 In the case of non-SMTP messages, new headers are accumulated during the
31429 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31430 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31431 are included in the entry that is written to the reject log.
31432
31433 .cindex "header lines" "added; visibility of"
31434 Header lines are not visible in string expansions
31435 of message headers
31436 until they are added to the
31437 message. It follows that header lines defined in the MAIL, RCPT, and predata
31438 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31439 header lines that are added by the DATA or MIME ACLs are not visible in those
31440 ACLs. Because of this restriction, you cannot use header lines as a way of
31441 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31442 this, you can use ACL variables, as described in section
31443 &<<SECTaclvariables>>&.
31444
31445 The list of headers yet to be added is given by the &%$headers_added%& variable.
31446
31447 The &%add_header%& modifier acts immediately as it is encountered during the
31448 processing of an ACL. Notice the difference between these two cases:
31449 .display
31450 &`accept add_header = ADDED: some text`&
31451 &`       `&<&'some condition'&>
31452
31453 &`accept `&<&'some condition'&>
31454 &`       add_header = ADDED: some text`&
31455 .endd
31456 In the first case, the header line is always added, whether or not the
31457 condition is true. In the second case, the header line is added only if the
31458 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31459 ACL statement. All those that are encountered before a condition fails are
31460 honoured.
31461
31462 .cindex "&%warn%& ACL verb"
31463 For compatibility with previous versions of Exim, a &%message%& modifier for a
31464 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31465 effect only if all the conditions are true, even if it appears before some of
31466 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31467 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31468 are present on a &%warn%& verb, both are processed according to their
31469 specifications.
31470
31471 By default, new header lines are added to a message at the end of the existing
31472 header lines. However, you can specify that any particular header line should
31473 be added right at the start (before all the &'Received:'& lines), immediately
31474 after the first block of &'Received:'& lines, or immediately before any line
31475 that is not a &'Received:'& or &'Resent-something:'& header.
31476
31477 This is done by specifying &":at_start:"&, &":after_received:"&, or
31478 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31479 header line, respectively. (Header text cannot start with a colon, as there has
31480 to be a header name first.) For example:
31481 .code
31482 warn add_header = \
31483        :after_received:X-My-Header: something or other...
31484 .endd
31485 If more than one header line is supplied in a single &%add_header%& modifier,
31486 each one is treated independently and can therefore be placed differently. If
31487 you add more than one line at the start, or after the Received: block, they end
31488 up in reverse order.
31489
31490 &*Warning*&: This facility currently applies only to header lines that are
31491 added in an ACL. It does NOT work for header lines that are added in a
31492 system filter or in a router or transport.
31493
31494
31495
31496 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31497 .cindex "header lines" "removing in an ACL"
31498 .cindex "header lines" "position of removed lines"
31499 .cindex "&%remove_header%& ACL modifier"
31500 The &%remove_header%& modifier can be used to remove one or more header lines
31501 from an incoming message, as in this example:
31502 .code
31503 warn   message        = Remove internal headers
31504        remove_header  = x-route-mail1 : x-route-mail2
31505 .endd
31506 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31507 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31508 receiving a message). The message must ultimately be accepted for
31509 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31510 with any ACL verb, including &%deny%&, though this is really not useful for
31511 any verb that doesn't result in a delivered message.
31512
31513 Headers will not be removed from the message if the modifier is used in
31514 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31515
31516 More than one header can be removed at the same time by using a colon separated
31517 list of header names. The header matching is case insensitive. Wildcards are
31518 not permitted, nor is list expansion performed, so you cannot use hostlists to
31519 create a list of headers, however both connection and message variable expansion
31520 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31521 .code
31522 warn   hosts           = +internal_hosts
31523        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31524 warn   message         = Remove internal headers
31525        remove_header   = $acl_c_ihdrs
31526 .endd
31527 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31528 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31529 If multiple header lines match, all are removed.
31530 There is no harm in attempting to remove the same header twice nor in removing
31531 a non-existent header. Further header lines to be removed may be accumulated
31532 during the DATA and MIME ACLs, after which they are removed from the message,
31533 if present. In the case of non-SMTP messages, headers to be removed are
31534 accumulated during the non-SMTP ACLs, and are removed from the message after
31535 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31536 ACL, there really is no effect because there is no logging of what headers
31537 would have been removed.
31538
31539 .cindex "header lines" "removed; visibility of"
31540 Header lines are not visible in string expansions until the DATA phase when it
31541 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31542 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31543 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31544 this restriction, you cannot use header lines as a way of controlling data
31545 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31546 you should instead use ACL variables, as described in section
31547 &<<SECTaclvariables>>&.
31548
31549 The &%remove_header%& modifier acts immediately as it is encountered during the
31550 processing of an ACL. Notice the difference between these two cases:
31551 .display
31552 &`accept remove_header = X-Internal`&
31553 &`       `&<&'some condition'&>
31554
31555 &`accept `&<&'some condition'&>
31556 &`       remove_header = X-Internal`&
31557 .endd
31558 In the first case, the header line is always removed, whether or not the
31559 condition is true. In the second case, the header line is removed only if the
31560 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31561 same ACL statement. All those that are encountered before a condition fails
31562 are honoured.
31563
31564 &*Warning*&: This facility currently applies only to header lines that are
31565 present during ACL processing. It does NOT remove header lines that are added
31566 in a system filter or in a router or transport.
31567
31568
31569
31570
31571 .section "ACL conditions" "SECTaclconditions"
31572 .cindex "&ACL;" "conditions; list of"
31573 Some of the conditions listed in this section are available only when Exim is
31574 compiled with the content-scanning extension. They are included here briefly
31575 for completeness. More detailed descriptions can be found in the discussion on
31576 content scanning in chapter &<<CHAPexiscan>>&.
31577
31578 Not all conditions are relevant in all circumstances. For example, testing
31579 senders and recipients does not make sense in an ACL that is being run as the
31580 result of the arrival of an ETRN command, and checks on message headers can be
31581 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31582 can use the same condition (with different parameters) more than once in the
31583 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31584 The conditions are as follows:
31585
31586
31587 .vlist
31588 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31589 .cindex "&ACL;" "nested"
31590 .cindex "&ACL;" "indirect"
31591 .cindex "&ACL;" "arguments"
31592 .cindex "&%acl%& ACL condition"
31593 The possible values of the argument are the same as for the
31594 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31595 &"accept"& the condition is true; if it returns &"deny"& the condition is
31596 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31597 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31598 condition false. This means that further processing of the &%warn%& verb
31599 ceases, but processing of the ACL continues.
31600
31601 If the argument is a named ACL, up to nine space-separated optional values
31602 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31603 and $acl_narg is set to the count of values.
31604 Previous values of these variables are restored after the call returns.
31605 The name and values are expanded separately.
31606 Note that spaces in complex expansions which are used as arguments
31607 will act as argument separators.
31608
31609 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31610 the connection is dropped. If it returns &"discard"&, the verb must be
31611 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31612 conditions are tested.
31613
31614 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31615 loops. This condition allows you to use different ACLs in different
31616 circumstances. For example, different ACLs can be used to handle RCPT commands
31617 for different local users or different local domains.
31618
31619 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31620 .cindex "&%authenticated%& ACL condition"
31621 .cindex "authentication" "ACL checking"
31622 .cindex "&ACL;" "testing for authentication"
31623 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31624 the name of the authenticator is tested against the list. To test for
31625 authentication by any authenticator, you can set
31626 .code
31627 authenticated = *
31628 .endd
31629
31630 .vitem &*condition&~=&~*&<&'string'&>
31631 .cindex "&%condition%& ACL condition"
31632 .cindex "customizing" "ACL condition"
31633 .cindex "&ACL;" "customized test"
31634 .cindex "&ACL;" "testing, customized"
31635 This feature allows you to make up custom conditions. If the result of
31636 expanding the string is an empty string, the number zero, or one of the strings
31637 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31638 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31639 any other value, some error is assumed to have occurred, and the ACL returns
31640 &"defer"&. However, if the expansion is forced to fail, the condition is
31641 ignored. The effect is to treat it as true, whether it is positive or
31642 negative.
31643
31644 .vitem &*decode&~=&~*&<&'location'&>
31645 .cindex "&%decode%& ACL condition"
31646 This condition is available only when Exim is compiled with the
31647 content-scanning extension, and it is allowed only in the ACL defined by
31648 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31649 If all goes well, the condition is true. It is false only if there are
31650 problems such as a syntax error or a memory shortage. For more details, see
31651 chapter &<<CHAPexiscan>>&.
31652
31653 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31654 .cindex "&%dnslists%& ACL condition"
31655 .cindex "DNS list" "in ACL"
31656 .cindex "black list (DNS)"
31657 .cindex "&ACL;" "testing a DNS list"
31658 This condition checks for entries in DNS black lists. These are also known as
31659 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31660 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31661 different variants of this condition to describe briefly here. See sections
31662 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31663
31664 .vitem &*domains&~=&~*&<&'domain&~list'&>
31665 .cindex "&%domains%& ACL condition"
31666 .cindex "domain" "ACL checking"
31667 .cindex "&ACL;" "testing a recipient domain"
31668 .vindex "&$domain_data$&"
31669 This condition is relevant only after a RCPT command. It checks that the domain
31670 of the recipient address is in the domain list. If percent-hack processing is
31671 enabled, it is done before this test is done. If the check succeeds with a
31672 lookup, the result of the lookup is placed in &$domain_data$& until the next
31673 &%domains%& test.
31674
31675 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31676 use &%domains%& in a DATA ACL.
31677
31678
31679 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31680 .cindex "&%encrypted%& ACL condition"
31681 .cindex "encryption" "checking in an ACL"
31682 .cindex "&ACL;" "testing for encryption"
31683 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31684 name of the cipher suite in use is tested against the list. To test for
31685 encryption without testing for any specific cipher suite(s), set
31686 .code
31687 encrypted = *
31688 .endd
31689
31690
31691 .vitem &*hosts&~=&~*&<&'host&~list'&>
31692 .cindex "&%hosts%& ACL condition"
31693 .cindex "host" "ACL checking"
31694 .cindex "&ACL;" "testing the client host"
31695 This condition tests that the calling host matches the host list. If you have
31696 name lookups or wildcarded host names and IP addresses in the same host list,
31697 you should normally put the IP addresses first. For example, you could have:
31698 .code
31699 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31700 .endd
31701 The lookup in this example uses the host name for its key. This is implied by
31702 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31703 and it wouldn't matter which way round you had these two items.)
31704
31705 The reason for the problem with host names lies in the left-to-right way that
31706 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31707 but when it reaches an item that requires a host name, it fails if it cannot
31708 find a host name to compare with the pattern. If the above list is given in the
31709 opposite order, the &%accept%& statement fails for a host whose name cannot be
31710 found, even if its IP address is 10.9.8.7.
31711
31712 If you really do want to do the name check first, and still recognize the IP
31713 address even if the name lookup fails, you can rewrite the ACL like this:
31714 .code
31715 accept hosts = dbm;/etc/friendly/hosts
31716 accept hosts = 10.9.8.7
31717 .endd
31718 The default action on failing to find the host name is to assume that the host
31719 is not in the list, so the first &%accept%& statement fails. The second
31720 statement can then check the IP address.
31721
31722 .vindex "&$host_data$&"
31723 If a &%hosts%& condition is satisfied by means of a lookup, the result
31724 of the lookup is made available in the &$host_data$& variable. This
31725 allows you, for example, to set up a statement like this:
31726 .code
31727 deny  hosts = net-lsearch;/some/file
31728       message = $host_data
31729 .endd
31730 which gives a custom error message for each denied host.
31731
31732 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31733 .cindex "&%local_parts%& ACL condition"
31734 .cindex "local part" "ACL checking"
31735 .cindex "&ACL;" "testing a local part"
31736 .vindex "&$local_part_data$&"
31737 This condition is relevant only after a RCPT command. It checks that the local
31738 part of the recipient address is in the list. If percent-hack processing is
31739 enabled, it is done before this test. If the check succeeds with a lookup, the
31740 result of the lookup is placed in &$local_part_data$&, which remains set until
31741 the next &%local_parts%& test.
31742
31743 .vitem &*malware&~=&~*&<&'option'&>
31744 .cindex "&%malware%& ACL condition"
31745 .cindex "&ACL;" "virus scanning"
31746 .cindex "&ACL;" "scanning for viruses"
31747 This condition is available only when Exim is compiled with the
31748 content-scanning extension
31749 and only after a DATA command.
31750 It causes the incoming message to be scanned for
31751 viruses. For details, see chapter &<<CHAPexiscan>>&.
31752
31753 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31754 .cindex "&%mime_regex%& ACL condition"
31755 .cindex "&ACL;" "testing by regex matching"
31756 This condition is available only when Exim is compiled with the
31757 content-scanning extension, and it is allowed only in the ACL defined by
31758 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31759 with any of the regular expressions. For details, see chapter
31760 &<<CHAPexiscan>>&.
31761
31762 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31763 .cindex "rate limiting"
31764 This condition can be used to limit the rate at which a user or host submits
31765 messages. Details are given in section &<<SECTratelimiting>>&.
31766
31767 .vitem &*recipients&~=&~*&<&'address&~list'&>
31768 .cindex "&%recipients%& ACL condition"
31769 .cindex "recipient" "ACL checking"
31770 .cindex "&ACL;" "testing a recipient"
31771 This condition is relevant only after a RCPT command. It checks the entire
31772 recipient address against a list of recipients.
31773
31774 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31775 .cindex "&%regex%& ACL condition"
31776 .cindex "&ACL;" "testing by regex matching"
31777 This condition is available only when Exim is compiled with the
31778 content-scanning extension, and is available only in the DATA, MIME, and
31779 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31780 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31781
31782 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31783 .cindex "&%sender_domains%& ACL condition"
31784 .cindex "sender" "ACL checking"
31785 .cindex "&ACL;" "testing a sender domain"
31786 .vindex "&$domain$&"
31787 .vindex "&$sender_address_domain$&"
31788 This condition tests the domain of the sender of the message against the given
31789 domain list. &*Note*&: The domain of the sender address is in
31790 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31791 of this condition. This is an exception to the general rule for testing domain
31792 lists. It is done this way so that, if this condition is used in an ACL for a
31793 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31794 influence the sender checking.
31795
31796 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31797 relaying, because sender addresses are easily, and commonly, forged.
31798
31799 .vitem &*senders&~=&~*&<&'address&~list'&>
31800 .cindex "&%senders%& ACL condition"
31801 .cindex "sender" "ACL checking"
31802 .cindex "&ACL;" "testing a sender"
31803 This condition tests the sender of the message against the given list. To test
31804 for a bounce message, which has an empty sender, set
31805 .code
31806 senders = :
31807 .endd
31808 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31809 relaying, because sender addresses are easily, and commonly, forged.
31810
31811 .vitem &*spam&~=&~*&<&'username'&>
31812 .cindex "&%spam%& ACL condition"
31813 .cindex "&ACL;" "scanning for spam"
31814 This condition is available only when Exim is compiled with the
31815 content-scanning extension. It causes the incoming message to be scanned by
31816 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31817
31818 .vitem &*verify&~=&~certificate*&
31819 .cindex "&%verify%& ACL condition"
31820 .cindex "TLS" "client certificate verification"
31821 .cindex "certificate" "verification of client"
31822 .cindex "&ACL;" "certificate verification"
31823 .cindex "&ACL;" "testing a TLS certificate"
31824 This condition is true in an SMTP session if the session is encrypted, and a
31825 certificate was received from the client, and the certificate was verified. The
31826 server requests a certificate only if the client matches &%tls_verify_hosts%&
31827 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31828
31829 .vitem &*verify&~=&~csa*&
31830 .cindex "CSA verification"
31831 This condition checks whether the sending host (the client) is authorized to
31832 send email. Details of how this works are given in section
31833 &<<SECTverifyCSA>>&.
31834
31835 .vitem &*verify&~=&~header_names_ascii*&
31836 .cindex "&%verify%& ACL condition"
31837 .cindex "&ACL;" "verifying header names only ASCII"
31838 .cindex "header lines" "verifying header names only ASCII"
31839 .cindex "verifying" "header names only ASCII"
31840 This condition is relevant only in an ACL that is run after a message has been
31841 received.
31842 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
31843 It checks all header names (not the content) to make sure
31844 there are no non-ASCII characters, also excluding control characters.  The
31845 allowable characters are decimal ASCII values 33 through 126.
31846
31847 Exim itself will handle headers with non-ASCII characters, but it can cause
31848 problems for downstream applications, so this option will allow their
31849 detection and rejection in the DATA ACL's.
31850
31851 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31852 .cindex "&%verify%& ACL condition"
31853 .cindex "&ACL;" "verifying sender in the header"
31854 .cindex "header lines" "verifying the sender in"
31855 .cindex "sender" "verifying in header"
31856 .cindex "verifying" "sender in header"
31857 This condition is relevant only in an ACL that is run after a message has been
31858 received, that is, in an ACL specified by &%acl_smtp_data%& or
31859 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31860 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31861 is loosely thought of as a &"sender"& address (hence the name of the test).
31862 However, an address that appears in one of these headers need not be an address
31863 that accepts bounce messages; only sender addresses in envelopes are required
31864 to accept bounces. Therefore, if you use the callout option on this check, you
31865 might want to arrange for a non-empty address in the MAIL command.
31866
31867 Details of address verification and the options are given later, starting at
31868 section &<<SECTaddressverification>>& (callouts are described in section
31869 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31870 condition to restrict it to bounce messages only:
31871 .code
31872 deny    senders = :
31873        !verify  = header_sender
31874         message = A valid sender header is required for bounces
31875 .endd
31876
31877 .vitem &*verify&~=&~header_syntax*&
31878 .cindex "&%verify%& ACL condition"
31879 .cindex "&ACL;" "verifying header syntax"
31880 .cindex "header lines" "verifying syntax"
31881 .cindex "verifying" "header syntax"
31882 This condition is relevant only in an ACL that is run after a message has been
31883 received, that is, in an ACL specified by &%acl_smtp_data%& or
31884 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31885 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31886 and &'Bcc:'&), returning true if there are no problems.
31887 Unqualified addresses (local parts without domains) are
31888 permitted only in locally generated messages and from hosts that match
31889 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31890 appropriate.
31891
31892 Note that this condition is a syntax check only. However, a common spamming
31893 ploy used to be to send syntactically invalid headers such as
31894 .code
31895 To: @
31896 .endd
31897 and this condition can be used to reject such messages, though they are not as
31898 common as they used to be.
31899
31900 .vitem &*verify&~=&~helo*&
31901 .cindex "&%verify%& ACL condition"
31902 .cindex "&ACL;" "verifying HELO/EHLO"
31903 .cindex "HELO" "verifying"
31904 .cindex "EHLO" "verifying"
31905 .cindex "verifying" "EHLO"
31906 .cindex "verifying" "HELO"
31907 This condition is true if a HELO or EHLO command has been received from the
31908 client host, and its contents have been verified. If there has been no previous
31909 attempt to verify the HELO/EHLO contents, it is carried out when this
31910 condition is encountered. See the description of the &%helo_verify_hosts%& and
31911 &%helo_try_verify_hosts%& options for details of how to request verification
31912 independently of this condition, and for detail of the verification.
31913
31914 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31915 option), this condition is always true.
31916
31917
31918 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31919 .cindex "verifying" "not blind"
31920 .cindex "bcc recipients, verifying none"
31921 This condition checks that there are no blind (bcc) recipients in the message.
31922 Every envelope recipient must appear either in a &'To:'& header line or in a
31923 &'Cc:'& header line for this condition to be true. Local parts are checked
31924 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31925 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31926 used only in a DATA or non-SMTP ACL.
31927
31928 There is one possible option, &`case_insensitive`&.  If this is present then
31929 local parts are checked case-insensitively.
31930
31931 There are, of course, many legitimate messages that make use of blind (bcc)
31932 recipients. This check should not be used on its own for blocking messages.
31933
31934
31935 .vitem &*verify&~=&~recipient/*&<&'options'&>
31936 .cindex "&%verify%& ACL condition"
31937 .cindex "&ACL;" "verifying recipient"
31938 .cindex "recipient" "verifying"
31939 .cindex "verifying" "recipient"
31940 .vindex "&$address_data$&"
31941 This condition is relevant only after a RCPT command. It verifies the current
31942 recipient. Details of address verification are given later, starting at section
31943 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31944 of &$address_data$& is the last value that was set while routing the address.
31945 This applies even if the verification fails. When an address that is being
31946 verified is redirected to a single address, verification continues with the new
31947 address, and in that case, the subsequent value of &$address_data$& is the
31948 value for the child address.
31949
31950 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31951 .cindex "&%verify%& ACL condition"
31952 .cindex "&ACL;" "verifying host reverse lookup"
31953 .cindex "host" "verifying reverse lookup"
31954 This condition ensures that a verified host name has been looked up from the IP
31955 address of the client host. (This may have happened already if the host name
31956 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31957 Verification ensures that the host name obtained from a reverse DNS lookup, or
31958 one of its aliases, does, when it is itself looked up in the DNS, yield the
31959 original IP address.
31960
31961 There is one possible option, &`defer_ok`&.  If this is present and a
31962 DNS operation returns a temporary error, the verify condition succeeds.
31963
31964 If this condition is used for a locally generated message (that is, when there
31965 is no client host involved), it always succeeds.
31966
31967 .vitem &*verify&~=&~sender/*&<&'options'&>
31968 .cindex "&%verify%& ACL condition"
31969 .cindex "&ACL;" "verifying sender"
31970 .cindex "sender" "verifying"
31971 .cindex "verifying" "sender"
31972 This condition is relevant only after a MAIL or RCPT command, or after a
31973 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31974 the message's sender is empty (that is, this is a bounce message), the
31975 condition is true. Otherwise, the sender address is verified.
31976
31977 .vindex "&$address_data$&"
31978 .vindex "&$sender_address_data$&"
31979 If there is data in the &$address_data$& variable at the end of routing, its
31980 value is placed in &$sender_address_data$& at the end of verification. This
31981 value can be used in subsequent conditions and modifiers in the same ACL
31982 statement. It does not persist after the end of the current statement. If you
31983 want to preserve the value for longer, you can save it in an ACL variable.
31984
31985 Details of verification are given later, starting at section
31986 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31987 to avoid doing it more than once per message.
31988
31989 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31990 .cindex "&%verify%& ACL condition"
31991 This is a variation of the previous option, in which a modified address is
31992 verified as a sender.
31993
31994 Note that '/' is legal in local-parts; if the address may have such
31995 (eg. is generated from the received message)
31996 they must be protected from the options parsing by doubling:
31997 .code
31998 verify = sender=${listquote{/}{${address:$h_sender:}}}
31999 .endd
32000 .endlist
32001
32002
32003
32004 .section "Using DNS lists" "SECTmorednslists"
32005 .cindex "DNS list" "in ACL"
32006 .cindex "black list (DNS)"
32007 .cindex "&ACL;" "testing a DNS list"
32008 In its simplest form, the &%dnslists%& condition tests whether the calling host
32009 is on at least one of a number of DNS lists by looking up the inverted IP
32010 address in one or more DNS domains. (Note that DNS list domains are not mail
32011 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32012 special options instead.) For example, if the calling host's IP
32013 address is 192.168.62.43, and the ACL statement is
32014 .code
32015 deny dnslists = blackholes.mail-abuse.org : \
32016                 dialups.mail-abuse.org
32017 .endd
32018 the following records are looked up:
32019 .code
32020 43.62.168.192.blackholes.mail-abuse.org
32021 43.62.168.192.dialups.mail-abuse.org
32022 .endd
32023 As soon as Exim finds an existing DNS record, processing of the list stops.
32024 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32025 to test that a host is on more than one list (an &"and"& conjunction), you can
32026 use two separate conditions:
32027 .code
32028 deny dnslists = blackholes.mail-abuse.org
32029      dnslists = dialups.mail-abuse.org
32030 .endd
32031 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32032 behaves as if the host does not match the list item, that is, as if the DNS
32033 record does not exist. If there are further items in the DNS list, they are
32034 processed.
32035
32036 This is usually the required action when &%dnslists%& is used with &%deny%&
32037 (which is the most common usage), because it prevents a DNS failure from
32038 blocking mail. However, you can change this behaviour by putting one of the
32039 following special items in the list:
32040 .display
32041 &`+include_unknown `&   behave as if the item is on the list
32042 &`+exclude_unknown `&   behave as if the item is not on the list (default)
32043 &`+defer_unknown   `&   give a temporary error
32044 .endd
32045 .cindex "&`+include_unknown`&"
32046 .cindex "&`+exclude_unknown`&"
32047 .cindex "&`+defer_unknown`&"
32048 Each of these applies to any subsequent items on the list. For example:
32049 .code
32050 deny dnslists = +defer_unknown : foo.bar.example
32051 .endd
32052 Testing the list of domains stops as soon as a match is found. If you want to
32053 warn for one list and block for another, you can use two different statements:
32054 .code
32055 deny  dnslists = blackholes.mail-abuse.org
32056 warn  dnslists = dialups.mail-abuse.org
32057       message  = X-Warn: sending host is on dialups list
32058 .endd
32059 .cindex caching "of dns lookup"
32060 .cindex DNS TTL
32061 DNS list lookups are cached by Exim for the duration of the SMTP session
32062 (but limited by the DNS return TTL value),
32063 so a lookup based on the IP address is done at most once for any incoming
32064 connection (assuming long-enough TTL).
32065 Exim does not share information between multiple incoming
32066 connections (but your local name server cache should be active).
32067
32068 There are a number of DNS lists to choose from, some commercial, some free,
32069 or free for small deployments.  An overview can be found at
32070 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32071
32072
32073
32074 .section "Specifying the IP address for a DNS list lookup" "SECID201"
32075 .cindex "DNS list" "keyed by explicit IP address"
32076 By default, the IP address that is used in a DNS list lookup is the IP address
32077 of the calling host. However, you can specify another IP address by listing it
32078 after the domain name, introduced by a slash. For example:
32079 .code
32080 deny dnslists = black.list.tld/192.168.1.2
32081 .endd
32082 This feature is not very helpful with explicit IP addresses; it is intended for
32083 use with IP addresses that are looked up, for example, the IP addresses of the
32084 MX hosts or nameservers of an email sender address. For an example, see section
32085 &<<SECTmulkeyfor>>& below.
32086
32087
32088
32089
32090 .section "DNS lists keyed on domain names" "SECID202"
32091 .cindex "DNS list" "keyed by domain name"
32092 There are some lists that are keyed on domain names rather than inverted IP
32093 addresses (see, e.g., the &'domain based zones'& link at
32094 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32095 with these lists. You can change the name that is looked up in a DNS list by
32096 listing it after the domain name, introduced by a slash. For example,
32097 .code
32098 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32099       message  = Sender's domain is listed at $dnslist_domain
32100 .endd
32101 This particular example is useful only in ACLs that are obeyed after the
32102 RCPT or DATA commands, when a sender address is available. If (for
32103 example) the message's sender is &'user@tld.example'& the name that is looked
32104 up by this example is
32105 .code
32106 tld.example.dsn.rfc-ignorant.org
32107 .endd
32108 A single &%dnslists%& condition can contain entries for both names and IP
32109 addresses. For example:
32110 .code
32111 deny dnslists = sbl.spamhaus.org : \
32112                 dsn.rfc-ignorant.org/$sender_address_domain
32113 .endd
32114 The first item checks the sending host's IP address; the second checks a domain
32115 name. The whole condition is true if either of the DNS lookups succeeds.
32116
32117
32118
32119
32120 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32121 .cindex "DNS list" "multiple keys for"
32122 The syntax described above for looking up explicitly-defined values (either
32123 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32124 name for the DNS list, what follows the slash can in fact be a list of items.
32125 As with all lists in Exim, the default separator is a colon. However, because
32126 this is a sublist within the list of DNS blacklist domains, it is necessary
32127 either to double the separators like this:
32128 .code
32129 dnslists = black.list.tld/name.1::name.2
32130 .endd
32131 or to change the separator character, like this:
32132 .code
32133 dnslists = black.list.tld/<;name.1;name.2
32134 .endd
32135 If an item in the list is an IP address, it is inverted before the DNS
32136 blacklist domain is appended. If it is not an IP address, no inversion
32137 occurs. Consider this condition:
32138 .code
32139 dnslists = black.list.tld/<;192.168.1.2;a.domain
32140 .endd
32141 The DNS lookups that occur are:
32142 .code
32143 2.1.168.192.black.list.tld
32144 a.domain.black.list.tld
32145 .endd
32146 Once a DNS record has been found (that matches a specific IP return
32147 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32148 are done. If there is a temporary DNS error, the rest of the sublist of domains
32149 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32150 only if no other DNS lookup in this sublist succeeds. In other words, a
32151 successful lookup for any of the items in the sublist overrides a temporary
32152 error for a previous item.
32153
32154 The ability to supply a list of items after the slash is in some sense just a
32155 syntactic convenience. These two examples have the same effect:
32156 .code
32157 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32158 dnslists = black.list.tld/a.domain::b.domain
32159 .endd
32160 However, when the data for the list is obtained from a lookup, the second form
32161 is usually much more convenient. Consider this example:
32162 .code
32163 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32164                                    ${lookup dnsdb {>|mxh=\
32165                                    $sender_address_domain} }} }
32166      message  = The mail servers for the domain \
32167                 $sender_address_domain \
32168                 are listed at $dnslist_domain ($dnslist_value); \
32169                 see $dnslist_text.
32170 .endd
32171 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32172 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32173 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32174 of expanding the condition might be something like this:
32175 .code
32176 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32177 .endd
32178 Thus, this example checks whether or not the IP addresses of the sender
32179 domain's mail servers are on the Spamhaus black list.
32180
32181 The key that was used for a successful DNS list lookup is put into the variable
32182 &$dnslist_matched$& (see section &<<SECID204>>&).
32183
32184
32185
32186
32187 .section "Data returned by DNS lists" "SECID203"
32188 .cindex "DNS list" "data returned from"
32189 DNS lists are constructed using address records in the DNS. The original RBL
32190 just used the address 127.0.0.1 on the right hand side of each record, but the
32191 RBL+ list and some other lists use a number of values with different meanings.
32192 The values used on the RBL+ list are:
32193 .display
32194 127.1.0.1  RBL
32195 127.1.0.2  DUL
32196 127.1.0.3  DUL and RBL
32197 127.1.0.4  RSS
32198 127.1.0.5  RSS and RBL
32199 127.1.0.6  RSS and DUL
32200 127.1.0.7  RSS and DUL and RBL
32201 .endd
32202 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32203 different values. Some DNS lists may return more than one address record;
32204 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32205
32206
32207 .section "Variables set from DNS lists" "SECID204"
32208 .cindex "expansion" "variables, set from DNS list"
32209 .cindex "DNS list" "variables set from"
32210 .vindex "&$dnslist_domain$&"
32211 .vindex "&$dnslist_matched$&"
32212 .vindex "&$dnslist_text$&"
32213 .vindex "&$dnslist_value$&"
32214 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32215 the name of the overall domain that matched (for example,
32216 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32217 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32218 the DNS record. When the key is an IP address, it is not reversed in
32219 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32220 cases, for example:
32221 .code
32222 deny dnslists = spamhaus.example
32223 .endd
32224 the key is also available in another variable (in this case,
32225 &$sender_host_address$&). In more complicated cases, however, this is not true.
32226 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32227 might generate a dnslists lookup like this:
32228 .code
32229 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32230 .endd
32231 If this condition succeeds, the value in &$dnslist_matched$& might be
32232 &`192.168.6.7`& (for example).
32233
32234 If more than one address record is returned by the DNS lookup, all the IP
32235 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32236 The variable &$dnslist_text$& contains the contents of any associated TXT
32237 record. For lists such as RBL+ the TXT record for a merged entry is often not
32238 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32239 information.
32240
32241 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32242 &-- even if these appear before the condition in the ACL, they are not
32243 expanded until after it has failed. For example:
32244 .code
32245 deny    hosts = !+local_networks
32246         message = $sender_host_address is listed \
32247                   at $dnslist_domain
32248         dnslists = rbl-plus.mail-abuse.example
32249 .endd
32250
32251
32252
32253 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32254 .cindex "DNS list" "matching specific returned data"
32255 You can add an equals sign and an IP address after a &%dnslists%& domain name
32256 in order to restrict its action to DNS records with a matching right hand side.
32257 For example,
32258 .code
32259 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32260 .endd
32261 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32262 any address record is considered to be a match. For the moment, we assume
32263 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32264 describes how multiple records are handled.
32265
32266 More than one IP address may be given for checking, using a comma as a
32267 separator. These are alternatives &-- if any one of them matches, the
32268 &%dnslists%& condition is true. For example:
32269 .code
32270 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32271 .endd
32272 If you want to specify a constraining address list and also specify names or IP
32273 addresses to be looked up, the constraining address list must be specified
32274 first. For example:
32275 .code
32276 deny dnslists = dsn.rfc-ignorant.org\
32277                 =127.0.0.2/$sender_address_domain
32278 .endd
32279
32280 If the character &`&&`& is used instead of &`=`&, the comparison for each
32281 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32282 In other words, the listed addresses are used as bit masks. The comparison is
32283 true if all the bits in the mask are present in the address that is being
32284 tested. For example:
32285 .code
32286 dnslists = a.b.c&0.0.0.3
32287 .endd
32288 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32289 want to test whether one bit or another bit is present (as opposed to both
32290 being present), you must use multiple values. For example:
32291 .code
32292 dnslists = a.b.c&0.0.0.1,0.0.0.2
32293 .endd
32294 matches if the final component of the address is an odd number or two times
32295 an odd number.
32296
32297
32298
32299 .section "Negated DNS matching conditions" "SECID205"
32300 You can supply a negative list of IP addresses as part of a &%dnslists%&
32301 condition. Whereas
32302 .code
32303 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32304 .endd
32305 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32306 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32307 .code
32308 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32309 .endd
32310 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32311 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32312 words, the result of the test is inverted if an exclamation mark appears before
32313 the &`=`& (or the &`&&`&) sign.
32314
32315 &*Note*&: This kind of negation is not the same as negation in a domain,
32316 host, or address list (which is why the syntax is different).
32317
32318 If you are using just one list, the negation syntax does not gain you much. The
32319 previous example is precisely equivalent to
32320 .code
32321 deny  dnslists = a.b.c
32322      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32323 .endd
32324 However, if you are using multiple lists, the negation syntax is clearer.
32325 Consider this example:
32326 .code
32327 deny  dnslists = sbl.spamhaus.org : \
32328                  list.dsbl.org : \
32329                  dnsbl.njabl.org!=127.0.0.3 : \
32330                  relays.ordb.org
32331 .endd
32332 Using only positive lists, this would have to be:
32333 .code
32334 deny  dnslists = sbl.spamhaus.org : \
32335                  list.dsbl.org
32336 deny  dnslists = dnsbl.njabl.org
32337      !dnslists = dnsbl.njabl.org=127.0.0.3
32338 deny  dnslists = relays.ordb.org
32339 .endd
32340 which is less clear, and harder to maintain.
32341
32342
32343
32344
32345 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32346 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32347 thereby providing more than one IP address. When an item in a &%dnslists%& list
32348 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32349 the match to specific results from the DNS lookup, there are two ways in which
32350 the checking can be handled. For example, consider the condition:
32351 .code
32352 dnslists = a.b.c=127.0.0.1
32353 .endd
32354 What happens if the DNS lookup for the incoming IP address yields both
32355 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32356 condition true because at least one given value was found, or is it false
32357 because at least one of the found values was not listed? And how does this
32358 affect negated conditions? Both possibilities are provided for with the help of
32359 additional separators &`==`& and &`=&&`&.
32360
32361 .ilist
32362 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32363 IP addresses matches one of the listed addresses. For the example above, the
32364 condition is true because 127.0.0.1 matches.
32365 .next
32366 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32367 looked up IP addresses matches one of the listed addresses. If the condition is
32368 changed to:
32369 .code
32370 dnslists = a.b.c==127.0.0.1
32371 .endd
32372 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32373 false because 127.0.0.2 is not listed. You would need to have:
32374 .code
32375 dnslists = a.b.c==127.0.0.1,127.0.0.2
32376 .endd
32377 for the condition to be true.
32378 .endlist
32379
32380 When &`!`& is used to negate IP address matching, it inverts the result, giving
32381 the precise opposite of the behaviour above. Thus:
32382 .ilist
32383 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32384 addresses matches one of the listed addresses. Consider:
32385 .code
32386 dnslists = a.b.c!&0.0.0.1
32387 .endd
32388 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32389 false because 127.0.0.1 matches.
32390 .next
32391 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32392 looked up IP address that does not match. Consider:
32393 .code
32394 dnslists = a.b.c!=&0.0.0.1
32395 .endd
32396 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32397 true, because 127.0.0.2 does not match. You would need to have:
32398 .code
32399 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32400 .endd
32401 for the condition to be false.
32402 .endlist
32403 When the DNS lookup yields only a single IP address, there is no difference
32404 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32405
32406
32407
32408
32409 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32410 .cindex "DNS list" "information from merged"
32411 When the facility for restricting the matching IP values in a DNS list is used,
32412 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32413 the true reason for rejection. This happens when lists are merged and the IP
32414 address in the A record is used to distinguish them; unfortunately there is
32415 only one TXT record. One way round this is not to use merged lists, but that
32416 can be inefficient because it requires multiple DNS lookups where one would do
32417 in the vast majority of cases when the host of interest is not on any of the
32418 lists.
32419
32420 A less inefficient way of solving this problem is available. If
32421 two domain names, comma-separated, are given, the second is used first to
32422 do an initial check, making use of any IP value restrictions that are set.
32423 If there is a match, the first domain is used, without any IP value
32424 restrictions, to get the TXT record. As a byproduct of this, there is also
32425 a check that the IP being tested is indeed on the first list. The first
32426 domain is the one that is put in &$dnslist_domain$&. For example:
32427 .code
32428 deny   dnslists = \
32429          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32430          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32431        message  = \
32432          rejected because $sender_host_address is blacklisted \
32433          at $dnslist_domain\n$dnslist_text
32434 .endd
32435 For the first blacklist item, this starts by doing a lookup in
32436 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32437 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32438 value, and as long as something is found, it looks for the corresponding TXT
32439 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32440 The second blacklist item is processed similarly.
32441
32442 If you are interested in more than one merged list, the same list must be
32443 given several times, but because the results of the DNS lookups are cached,
32444 the DNS calls themselves are not repeated. For example:
32445 .code
32446 deny dnslists = \
32447          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32448          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32449          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32450          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32451 .endd
32452 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32453 values matches (or if no record is found), this is the only lookup that is
32454 done. Only if there is a match is one of the more specific lists consulted.
32455
32456
32457
32458 .section "DNS lists and IPv6" "SECTmorednslistslast"
32459 .cindex "IPv6" "DNS black lists"
32460 .cindex "DNS list" "IPv6 usage"
32461 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32462 nibble by nibble. For example, if the calling host's IP address is
32463 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32464 .code
32465 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32466   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32467 .endd
32468 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32469 lists contain wildcard records, intended for IPv4, that interact badly with
32470 IPv6. For example, the DNS entry
32471 .code
32472 *.3.some.list.example.    A    127.0.0.1
32473 .endd
32474 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32475 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32476
32477 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32478 &%condition%& condition, as in this example:
32479 .code
32480 deny   condition = ${if isip4{$sender_host_address}}
32481        dnslists  = some.list.example
32482 .endd
32483
32484 If an explicit key is being used for a DNS lookup and it may be an IPv6
32485 address you should specify alternate list separators for both the outer
32486 (DNS list name) list and inner (lookup keys) list:
32487 .code
32488        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32489 .endd
32490
32491 .section "Rate limiting incoming messages" "SECTratelimiting"
32492 .cindex "rate limiting" "client sending"
32493 .cindex "limiting client sending rates"
32494 .oindex "&%smtp_ratelimit_*%&"
32495 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32496 which clients can send email. This is more powerful than the
32497 &%smtp_ratelimit_*%& options, because those options control the rate of
32498 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32499 works across all connections (concurrent and sequential) from the same client
32500 host. The syntax of the &%ratelimit%& condition is:
32501 .display
32502 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32503 .endd
32504 If the average client sending rate is less than &'m'& messages per time
32505 period &'p'& then the condition is false; otherwise it is true.
32506
32507 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32508 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32509 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32510 of &'p'&.
32511
32512 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32513 time interval, for example, &`8h`& for eight hours. A larger time constant
32514 means that it takes Exim longer to forget a client's past behaviour. The
32515 parameter &'m'& is the maximum number of messages that a client is permitted to
32516 send in each time interval. It also specifies the number of messages permitted
32517 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32518 constant, you can allow a client to send more messages in a burst without
32519 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32520 both small, messages must be sent at an even rate.
32521
32522 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32523 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32524 when deploying the &%ratelimit%& ACL condition. The script prints usage
32525 instructions when it is run with no arguments.
32526
32527 The key is used to look up the data for calculating the client's average
32528 sending rate. This data is stored in Exim's spool directory, alongside the
32529 retry and other hints databases. The default key is &$sender_host_address$&,
32530 which means Exim computes the sending rate of each client host IP address.
32531 By changing the key you can change how Exim identifies clients for the purpose
32532 of ratelimiting. For example, to limit the sending rate of each authenticated
32533 user, independent of the computer they are sending from, set the key to
32534 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32535 example, &$authenticated_id$& is only meaningful if the client has
32536 authenticated (which you can check with the &%authenticated%& ACL condition).
32537
32538 The lookup key does not have to identify clients: If you want to limit the
32539 rate at which a recipient receives messages, you can use the key
32540 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32541 ACL.
32542
32543 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32544 specifies what Exim measures the rate of, for example, messages or recipients
32545 or bytes. You can adjust the measurement using the &%unique=%& and/or
32546 &%count=%& options. You can also control when Exim updates the recorded rate
32547 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32548 separated by a slash, like the other parameters. They may appear in any order.
32549
32550 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32551 any options that alter the meaning of the stored data. The limit &'m'& is not
32552 stored, so you can alter the configured maximum rate and Exim will still
32553 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32554 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32555 behaviour. The lookup key is not affected by changes to the update mode and
32556 the &%count=%& option.
32557
32558
32559 .section "Ratelimit options for what is being measured" "ratoptmea"
32560 .cindex "rate limiting" "per_* options"
32561 The &%per_conn%& option limits the client's connection rate. It is not
32562 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32563 &%acl_not_smtp_start%& ACLs.
32564
32565 The &%per_mail%& option limits the client's rate of sending messages. This is
32566 the default if none of the &%per_*%& options is specified. It can be used in
32567 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32568 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32569
32570 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32571 the same ACLs as the &%per_mail%& option, though it is best to use this option
32572 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32573 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32574 in its MAIL command, which may be inaccurate or completely missing. You can
32575 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32576 in kilobytes, megabytes, or gigabytes, respectively.
32577
32578 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32579 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32580 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32581 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32582 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32583 in either case the rate limiting engine will see a message with many
32584 recipients as a large high-speed burst.
32585
32586 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32587 number of different recipients that the client has sent messages to in the
32588 last time period. That is, if the client repeatedly sends messages to the same
32589 recipient, its measured rate is not increased. This option can only be used in
32590 &%acl_smtp_rcpt%&.
32591
32592 The &%per_cmd%& option causes Exim to recompute the rate every time the
32593 condition is processed. This can be used to limit the rate of any SMTP
32594 command. If it is used in multiple ACLs it can limit the aggregate rate of
32595 multiple different commands.
32596
32597 The &%count=%& option can be used to alter how much Exim adds to the client's
32598 measured rate. For example, the &%per_byte%& option is equivalent to
32599 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32600 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32601 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32602
32603 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32604
32605
32606 .section "Ratelimit update modes" "ratoptupd"
32607 .cindex "rate limiting" "reading data without updating"
32608 You can specify one of three options with the &%ratelimit%& condition to
32609 control when its database is updated. This section describes the &%readonly%&
32610 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32611
32612 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32613 previously-computed rate to check against the limit.
32614
32615 For example, you can test the client's sending rate and deny it access (when
32616 it is too fast) in the connect ACL. If the client passes this check then it
32617 can go on to send a message, in which case its recorded rate will be updated
32618 in the MAIL ACL. Subsequent connections from the same client will check this
32619 new rate.
32620 .code
32621 acl_check_connect:
32622  deny ratelimit = 100 / 5m / readonly
32623       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32624                   (max $sender_rate_limit)
32625 # ...
32626 acl_check_mail:
32627  warn ratelimit = 100 / 5m / strict
32628       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32629                   (max $sender_rate_limit)
32630 .endd
32631
32632 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32633 processing a message then it may increase the client's measured rate more than
32634 it should. For example, this will happen if you check the &%per_rcpt%& option
32635 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32636 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32637 multiple update problems by using the &%readonly%& option on later ratelimit
32638 checks.
32639
32640 The &%per_*%& options described above do not make sense in some ACLs. If you
32641 use a &%per_*%& option in an ACL where it is not normally permitted then the
32642 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32643 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32644 next section) so you must specify the &%readonly%& option explicitly.
32645
32646
32647 .section "Ratelimit options for handling fast clients" "ratoptfast"
32648 .cindex "rate limiting" "strict and leaky modes"
32649 If a client's average rate is greater than the maximum, the rate limiting
32650 engine can react in two possible ways, depending on the presence of the
32651 &%strict%& or &%leaky%& update modes. This is independent of the other
32652 counter-measures (such as rejecting the message) that may be specified by the
32653 rest of the ACL.
32654
32655 The &%leaky%& (default) option means that the client's recorded rate is not
32656 updated if it is above the limit. The effect of this is that Exim measures the
32657 client's average rate of successfully sent email,
32658 up to the given limit.
32659 This is appropriate if the countermeasure when the condition is true
32660 consists of refusing the message, and
32661 is generally the better choice if you have clients that retry automatically.
32662 If the action when true is anything more complex then this option is
32663 likely not what is wanted.
32664
32665 The &%strict%& option means that the client's recorded rate is always
32666 updated. The effect of this is that Exim measures the client's average rate
32667 of attempts to send email, which can be much higher than the maximum it is
32668 actually allowed. If the client is over the limit it may be subjected to
32669 counter-measures by the ACL. It must slow down and allow sufficient time to
32670 pass that its computed rate falls below the maximum before it can send email
32671 again. The time (the number of smoothing periods) it must wait and not
32672 attempt to send mail can be calculated with this formula:
32673 .code
32674         ln(peakrate/maxrate)
32675 .endd
32676
32677
32678 .section "Limiting the rate of different events" "ratoptuniq"
32679 .cindex "rate limiting" "counting unique events"
32680 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32681 rate of different events. For example, the &%per_addr%& option uses this
32682 mechanism to count the number of different recipients that the client has
32683 sent messages to in the last time period; it is equivalent to
32684 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32685 measure the rate that a client uses different sender addresses with the
32686 options &`per_mail/unique=$sender_address`&.
32687
32688 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32689 has seen for that key. The whole set is thrown away when it is older than the
32690 rate smoothing period &'p'&, so each different event is counted at most once
32691 per period. In the &%leaky%& update mode, an event that causes the client to
32692 go over the limit is not added to the set, in the same way that the client's
32693 recorded rate is not updated in the same situation.
32694
32695 When you combine the &%unique=%& and &%readonly%& options, the specific
32696 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32697 rate.
32698
32699 The &%unique=%& mechanism needs more space in the ratelimit database than the
32700 other &%ratelimit%& options in order to store the event set. The number of
32701 unique values is potentially as large as the rate limit, so the extra space
32702 required increases with larger limits.
32703
32704 The uniqueification is not perfect: there is a small probability that Exim
32705 will think a new event has happened before. If the sender's rate is less than
32706 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32707 the measured rate can go above the limit, in which case Exim may under-count
32708 events by a significant margin. Fortunately, if the rate is high enough (2.7
32709 times the limit) that the false positive rate goes above 9%, then Exim will
32710 throw away the over-full event set before the measured rate falls below the
32711 limit. Therefore the only harm should be that exceptionally high sending rates
32712 are logged incorrectly; any countermeasures you configure will be as effective
32713 as intended.
32714
32715
32716 .section "Using rate limiting" "useratlim"
32717 Exim's other ACL facilities are used to define what counter-measures are taken
32718 when the rate limit is exceeded. This might be anything from logging a warning
32719 (for example, while measuring existing sending rates in order to define
32720 policy), through time delays to slow down fast senders, up to rejecting the
32721 message. For example:
32722 .code
32723 # Log all senders' rates
32724 warn ratelimit = 0 / 1h / strict
32725      log_message = Sender rate $sender_rate / $sender_rate_period
32726
32727 # Slow down fast senders; note the need to truncate $sender_rate
32728 # at the decimal point.
32729 warn ratelimit = 100 / 1h / per_rcpt / strict
32730      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32731                    $sender_rate_limit }s
32732
32733 # Keep authenticated users under control
32734 deny authenticated = *
32735      ratelimit = 100 / 1d / strict / $authenticated_id
32736
32737 # System-wide rate limit
32738 defer ratelimit = 10 / 1s / $primary_hostname
32739       message = Sorry, too busy. Try again later.
32740
32741 # Restrict incoming rate from each host, with a default
32742 # set using a macro and special cases looked up in a table.
32743 defer ratelimit = ${lookup {$sender_host_address} \
32744                    cdb {DB/ratelimits.cdb} \
32745                    {$value} {RATELIMIT} }
32746       message = Sender rate exceeds $sender_rate_limit \
32747                messages per $sender_rate_period
32748 .endd
32749 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32750 especially with the &%per_rcpt%& option, you may suffer from a performance
32751 bottleneck caused by locking on the ratelimit hints database. Apart from
32752 making your ACLs less complicated, you can reduce the problem by using a
32753 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32754 this means that Exim will lose its hints data after a reboot (including retry
32755 hints, the callout cache, and ratelimit data).
32756
32757
32758
32759 .section "Address verification" "SECTaddressverification"
32760 .cindex "verifying address" "options for"
32761 .cindex "policy control" "address verification"
32762 Several of the &%verify%& conditions described in section
32763 &<<SECTaclconditions>>& cause addresses to be verified. Section
32764 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32765 The verification conditions can be followed by options that modify the
32766 verification process. The options are separated from the keyword and from each
32767 other by slashes, and some of them contain parameters. For example:
32768 .code
32769 verify = sender/callout
32770 verify = recipient/defer_ok/callout=10s,defer_ok
32771 .endd
32772 The first stage of address verification, which always happens, is to run the
32773 address through the routers, in &"verify mode"&. Routers can detect the
32774 difference between verification and routing for delivery, and their actions can
32775 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32776 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32777 The available options are as follows:
32778
32779 .ilist
32780 If the &%callout%& option is specified, successful routing to one or more
32781 remote hosts is followed by a &"callout"& to those hosts as an additional
32782 check. Callouts and their sub-options are discussed in the next section.
32783 .next
32784 If there is a defer error while doing verification routing, the ACL
32785 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32786 options, the condition is forced to be true instead. Note that this is a main
32787 verification option as well as a suboption for callouts.
32788 .next
32789 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32790 discusses the reporting of sender address verification failures.
32791 .next
32792 The &%success_on_redirect%& option causes verification always to succeed
32793 immediately after a successful redirection. By default, if a redirection
32794 generates just one address, that address is also verified. See further
32795 discussion in section &<<SECTredirwhilveri>>&.
32796 .new
32797 .next
32798 If the &%quota%& option is specified for recipient verify,
32799 successful routing to an appendfile transport is followed by a call into
32800 the transport to evaluate the quota status for the recipient.
32801 No actual delivery is done, but verification will succeed if the quota
32802 is sufficient for the message (if the sender gave a message size) or
32803 not already exceeded (otherwise).
32804 .wen
32805 .endlist
32806
32807 .cindex "verifying address" "differentiating failures"
32808 .vindex "&$recipient_verify_failure$&"
32809 .vindex "&$sender_verify_failure$&"
32810 .vindex "&$acl_verify_message$&"
32811 After an address verification failure, &$acl_verify_message$& contains the
32812 error message that is associated with the failure. It can be preserved by
32813 coding like this:
32814 .code
32815 warn  !verify = sender
32816        set acl_m0 = $acl_verify_message
32817 .endd
32818 If you are writing your own custom rejection message or log message when
32819 denying access, you can use this variable to include information about the
32820 verification failure.
32821
32822 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32823 appropriate) contains one of the following words:
32824
32825 .ilist
32826 &%qualify%&: The address was unqualified (no domain), and the message
32827 was neither local nor came from an exempted host.
32828 .next
32829 &%route%&: Routing failed.
32830 .next
32831 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32832 occurred at or before the MAIL command (that is, on initial
32833 connection, HELO, or MAIL).
32834 .next
32835 &%recipient%&: The RCPT command in a callout was rejected.
32836 .next
32837 &%postmaster%&: The postmaster check in a callout was rejected.
32838 .new
32839 .next
32840 &%quota%&: The quota check for a local recipient did non pass.
32841 .endlist
32842
32843 The main use of these variables is expected to be to distinguish between
32844 rejections of MAIL and rejections of RCPT in callouts.
32845
32846 The above variables may also be set after a &*successful*&
32847 address verification to:
32848
32849 .ilist
32850 &%random%&: A random local-part callout succeeded
32851 .endlist
32852
32853
32854
32855
32856 .section "Callout verification" "SECTcallver"
32857 .cindex "verifying address" "by callout"
32858 .cindex "callout" "verification"
32859 .cindex "SMTP" "callout verification"
32860 For non-local addresses, routing verifies the domain, but is unable to do any
32861 checking of the local part. There are situations where some means of verifying
32862 the local part is desirable. One way this can be done is to make an SMTP
32863 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32864 a subsequent host for a recipient address, to see if the host accepts the
32865 address. We use the term &'callout'& to cover both cases. Note that for a
32866 sender address, the callback is not to the client host that is trying to
32867 deliver the message, but to one of the hosts that accepts incoming mail for the
32868 sender's domain.
32869
32870 Exim does not do callouts by default. If you want them to happen, you must
32871 request them by setting appropriate options on the &%verify%& condition, as
32872 described below. This facility should be used with care, because it can add a
32873 lot of resource usage to the cost of verifying an address. However, Exim does
32874 cache the results of callouts, which helps to reduce the cost. Details of
32875 caching are in section &<<SECTcallvercache>>&.
32876
32877 Recipient callouts are usually used only between hosts that are controlled by
32878 the same administration. For example, a corporate gateway host could use
32879 callouts to check for valid recipients on an internal mailserver. A successful
32880 callout does not guarantee that a real delivery to the address would succeed;
32881 on the other hand, a failing callout does guarantee that a delivery would fail.
32882
32883 If the &%callout%& option is present on a condition that verifies an address, a
32884 second stage of verification occurs if the address is successfully routed to
32885 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32886 &(manualroute)& router, where the router specifies the hosts. However, if a
32887 router that does not set up hosts routes to an &(smtp)& transport with a
32888 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32889 &%hosts_override%& set, its hosts are always used, whether or not the router
32890 supplies a host list.
32891 Callouts are only supported on &(smtp)& transports.
32892
32893 The port that is used is taken from the transport, if it is specified and is a
32894 remote transport. (For routers that do verification only, no transport need be
32895 specified.) Otherwise, the default SMTP port is used. If a remote transport
32896 specifies an outgoing interface, this is used; otherwise the interface is not
32897 specified. Likewise, the text that is used for the HELO command is taken from
32898 the transport's &%helo_data%& option; if there is no transport, the value of
32899 &$smtp_active_hostname$& is used.
32900
32901 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32902 test whether a bounce message could be delivered to the sender address. The
32903 following SMTP commands are sent:
32904 .display
32905 &`HELO `&<&'local host name'&>
32906 &`MAIL FROM:<>`&
32907 &`RCPT TO:`&<&'the address to be tested'&>
32908 &`QUIT`&
32909 .endd
32910 LHLO is used instead of HELO if the transport's &%protocol%& option is
32911 set to &"lmtp"&.
32912
32913 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32914 settings.
32915
32916 A recipient callout check is similar. By default, it also uses an empty address
32917 for the sender. This default is chosen because most hosts do not make use of
32918 the sender address when verifying a recipient. Using the same address means
32919 that a single cache entry can be used for each recipient. Some sites, however,
32920 do make use of the sender address when verifying. These are catered for by the
32921 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32922
32923 If the response to the RCPT command is a 2&'xx'& code, the verification
32924 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32925 Exim tries the next host, if any. If there is a problem with all the remote
32926 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32927 &%callout%& option is given, in which case the condition is forced to succeed.
32928
32929 .cindex "SMTP" "output flushing, disabling for callout"
32930 A callout may take a little time. For this reason, Exim normally flushes SMTP
32931 output before performing a callout in an ACL, to avoid unexpected timeouts in
32932 clients when the SMTP PIPELINING extension is in use. The flushing can be
32933 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32934
32935
32936
32937
32938 .section "Additional parameters for callouts" "CALLaddparcall"
32939 .cindex "callout" "additional parameters for"
32940 The &%callout%& option can be followed by an equals sign and a number of
32941 optional parameters, separated by commas. For example:
32942 .code
32943 verify = recipient/callout=10s,defer_ok
32944 .endd
32945 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32946 separate verify options, is retained for backwards compatibility, but is now
32947 deprecated. The additional parameters for &%callout%& are as follows:
32948
32949
32950 .vlist
32951 .vitem <&'a&~time&~interval'&>
32952 .cindex "callout" "timeout, specifying"
32953 This specifies the timeout that applies for the callout attempt to each host.
32954 For example:
32955 .code
32956 verify = sender/callout=5s
32957 .endd
32958 The default is 30 seconds. The timeout is used for each response from the
32959 remote host. It is also used for the initial connection, unless overridden by
32960 the &%connect%& parameter.
32961
32962
32963 .vitem &*connect&~=&~*&<&'time&~interval'&>
32964 .cindex "callout" "connection timeout, specifying"
32965 This parameter makes it possible to set a different (usually smaller) timeout
32966 for making the SMTP connection. For example:
32967 .code
32968 verify = sender/callout=5s,connect=1s
32969 .endd
32970 If not specified, this timeout defaults to the general timeout value.
32971
32972 .vitem &*defer_ok*&
32973 .cindex "callout" "defer, action on"
32974 When this parameter is present, failure to contact any host, or any other kind
32975 of temporary error, is treated as success by the ACL. However, the cache is not
32976 updated in this circumstance.
32977
32978 .vitem &*fullpostmaster*&
32979 .cindex "callout" "full postmaster check"
32980 This operates like the &%postmaster%& option (see below), but if the check for
32981 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32982 accordance with the specification in RFC 2821. The RFC states that the
32983 unqualified address &'postmaster'& should be accepted.
32984
32985
32986 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32987 .cindex "callout" "sender when verifying header"
32988 When verifying addresses in header lines using the &%header_sender%&
32989 verification option, Exim behaves by default as if the addresses are envelope
32990 sender addresses from a message. Callout verification therefore tests to see
32991 whether a bounce message could be delivered, by using an empty address in the
32992 MAIL command. However, it is arguable that these addresses might never be used
32993 as envelope senders, and could therefore justifiably reject bounce messages
32994 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32995 address to use in the MAIL command. For example:
32996 .code
32997 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32998 .endd
32999 This parameter is available only for the &%header_sender%& verification option.
33000
33001
33002 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33003 .cindex "callout" "overall timeout, specifying"
33004 This parameter sets an overall timeout for performing a callout verification.
33005 For example:
33006 .code
33007 verify = sender/callout=5s,maxwait=30s
33008 .endd
33009 This timeout defaults to four times the callout timeout for individual SMTP
33010 commands. The overall timeout applies when there is more than one host that can
33011 be tried. The timeout is checked before trying the next host. This prevents
33012 very long delays if there are a large number of hosts and all are timing out
33013 (for example, when network connections are timing out).
33014
33015
33016 .vitem &*no_cache*&
33017 .cindex "callout" "cache, suppressing"
33018 .cindex "caching callout, suppressing"
33019 When this parameter is given, the callout cache is neither read nor updated.
33020
33021 .vitem &*postmaster*&
33022 .cindex "callout" "postmaster; checking"
33023 When this parameter is set, a successful callout check is followed by a similar
33024 check for the local part &'postmaster'& at the same domain. If this address is
33025 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33026 the postmaster check is recorded in a cache record; if it is a failure, this is
33027 used to fail subsequent callouts for the domain without a connection being
33028 made, until the cache record expires.
33029
33030 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33031 The postmaster check uses an empty sender in the MAIL command by default.
33032 You can use this parameter to do a postmaster check using a different address.
33033 For example:
33034 .code
33035 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33036 .endd
33037 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33038 one overrides. The &%postmaster%& parameter is equivalent to this example:
33039 .code
33040 require  verify = sender/callout=postmaster_mailfrom=
33041 .endd
33042 &*Warning*&: The caching arrangements for postmaster checking do not take
33043 account of the sender address. It is assumed that either the empty address or
33044 a fixed non-empty address will be used. All that Exim remembers is that the
33045 postmaster check for the domain succeeded or failed.
33046
33047
33048 .vitem &*random*&
33049 .cindex "callout" "&""random""& check"
33050 When this parameter is set, before doing the normal callout check, Exim does a
33051 check for a &"random"& local part at the same domain. The local part is not
33052 really random &-- it is defined by the expansion of the option
33053 &%callout_random_local_part%&, which defaults to
33054 .code
33055 $primary_hostname-$tod_epoch-testing
33056 .endd
33057 The idea here is to try to determine whether the remote host accepts all local
33058 parts without checking. If it does, there is no point in doing callouts for
33059 specific local parts. If the &"random"& check succeeds, the result is saved in
33060 a cache record, and used to force the current and subsequent callout checks to
33061 succeed without a connection being made, until the cache record expires.
33062
33063 .vitem &*use_postmaster*&
33064 .cindex "callout" "sender for recipient check"
33065 This parameter applies to recipient callouts only. For example:
33066 .code
33067 deny  !verify = recipient/callout=use_postmaster
33068 .endd
33069 .vindex "&$qualify_domain$&"
33070 It causes a non-empty postmaster address to be used in the MAIL command when
33071 performing the callout for the recipient, and also for a &"random"& check if
33072 that is configured. The local part of the address is &`postmaster`& and the
33073 domain is the contents of &$qualify_domain$&.
33074
33075 .vitem &*use_sender*&
33076 This option applies to recipient callouts only. For example:
33077 .code
33078 require  verify = recipient/callout=use_sender
33079 .endd
33080 It causes the message's actual sender address to be used in the MAIL
33081 command when performing the callout, instead of an empty address. There is no
33082 need to use this option unless you know that the called hosts make use of the
33083 sender when checking recipients. If used indiscriminately, it reduces the
33084 usefulness of callout caching.
33085
33086 .vitem &*hold*&
33087 This option applies to recipient callouts only. For example:
33088 .code
33089 require  verify = recipient/callout=use_sender,hold
33090 .endd
33091 It causes the connection to be held open and used for any further recipients
33092 and for eventual delivery (should that be done quickly).
33093 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33094 when that is used for the connections.
33095 The advantage is only gained if there are no callout cache hits
33096 (which could be enforced by the no_cache option),
33097 if the use_sender option is used,
33098 if neither the random nor the use_postmaster option is used,
33099 and if no other callouts intervene.
33100 .endlist
33101
33102 If you use any of the parameters that set a non-empty sender for the MAIL
33103 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33104 &%use_sender%&), you should think about possible loops. Recipient checking is
33105 usually done between two hosts that are under the same management, and the host
33106 that receives the callouts is not normally configured to do callouts itself.
33107 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33108 these circumstances.
33109
33110 However, if you use a non-empty sender address for a callout to an arbitrary
33111 host, there is the likelihood that the remote host will itself initiate a
33112 callout check back to your host. As it is checking what appears to be a message
33113 sender, it is likely to use an empty address in MAIL, thus avoiding a
33114 callout loop. However, to be on the safe side it would be best to set up your
33115 own ACLs so that they do not do sender verification checks when the recipient
33116 is the address you use for header sender or postmaster callout checking.
33117
33118 Another issue to think about when using non-empty senders for callouts is
33119 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33120 by the sender/recipient combination; thus, for any given recipient, many more
33121 actual callouts are performed than when an empty sender or postmaster is used.
33122
33123
33124
33125
33126 .section "Callout caching" "SECTcallvercache"
33127 .cindex "hints database" "callout cache"
33128 .cindex "callout" "cache, description of"
33129 .cindex "caching" "callout"
33130 Exim caches the results of callouts in order to reduce the amount of resources
33131 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33132 option. A hints database called &"callout"& is used for the cache. Two
33133 different record types are used: one records the result of a callout check for
33134 a specific address, and the other records information that applies to the
33135 entire domain (for example, that it accepts the local part &'postmaster'&).
33136
33137 When an original callout fails, a detailed SMTP error message is given about
33138 the failure. However, for subsequent failures use the cache data, this message
33139 is not available.
33140
33141 The expiry times for negative and positive address cache records are
33142 independent, and can be set by the global options &%callout_negative_expire%&
33143 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33144
33145 If a host gives a negative response to an SMTP connection, or rejects any
33146 commands up to and including
33147 .code
33148 MAIL FROM:<>
33149 .endd
33150 (but not including the MAIL command with a non-empty address),
33151 any callout attempt is bound to fail. Exim remembers such failures in a
33152 domain cache record, which it uses to fail callouts for the domain without
33153 making new connections, until the domain record times out. There are two
33154 separate expiry times for domain cache records:
33155 &%callout_domain_negative_expire%& (default 3h) and
33156 &%callout_domain_positive_expire%& (default 7d).
33157
33158 Domain records expire when the negative expiry time is reached if callouts
33159 cannot be made for the domain, or if the postmaster check failed.
33160 Otherwise, they expire when the positive expiry time is reached. This
33161 ensures that, for example, a host that stops accepting &"random"& local parts
33162 will eventually be noticed.
33163
33164 The callout caching mechanism is based on the domain of the address that is
33165 being tested. If the domain routes to several hosts, it is assumed that their
33166 behaviour will be the same.
33167
33168
33169
33170 .new
33171 .section "Quota caching" "SECTquotacache"
33172 .cindex "hints database" "quota cache"
33173 .cindex "quota" "cache, description of"
33174 .cindex "caching" "quota"
33175 Exim caches the results of quota verification
33176 in order to reduce the amount of resources used.
33177 The &"callout"& hints database is used.
33178
33179 The default cache periods are five minutes for a positive (good) result
33180 and one hour for a negative result.
33181 To change the periods the &%quota%& option can be followed by an equals sign
33182 and a number of optional paramemters, separated by commas.
33183 For example:
33184 .code
33185 verify = recipient/quota=cachepos=1h,cacheneg=1d
33186 .endd
33187 Possible parameters are:
33188 .vlist
33189 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33190 .cindex "quota cache" "positive entry expiry, specifying"
33191 Set the lifetime for a positive cache entry.
33192 A value of zero seconds is legitimate.
33193
33194 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33195 .cindex "quota cache" "negative entry expiry, specifying"
33196 As above, for a negative entry.
33197
33198 .vitem &*no_cache*&
33199 Set both positive and negative lifetimes to zero.
33200 .wen
33201
33202 .section "Sender address verification reporting" "SECTsenaddver"
33203 .cindex "verifying" "suppressing error details"
33204 See section &<<SECTaddressverification>>& for a general discussion of
33205 verification. When sender verification fails in an ACL, the details of the
33206 failure are given as additional output lines before the 550 response to the
33207 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33208 you might see:
33209 .code
33210 MAIL FROM:<xyz@abc.example>
33211 250 OK
33212 RCPT TO:<pqr@def.example>
33213 550-Verification failed for <xyz@abc.example>
33214 550-Called:   192.168.34.43
33215 550-Sent:     RCPT TO:<xyz@abc.example>
33216 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33217 550 Sender verification failed
33218 .endd
33219 If more than one RCPT command fails in the same way, the details are given
33220 only for the first of them. However, some administrators do not want to send
33221 out this much information. You can suppress the details by adding
33222 &`/no_details`& to the ACL statement that requests sender verification. For
33223 example:
33224 .code
33225 verify = sender/no_details
33226 .endd
33227
33228 .section "Redirection while verifying" "SECTredirwhilveri"
33229 .cindex "verifying" "redirection while"
33230 .cindex "address redirection" "while verifying"
33231 A dilemma arises when a local address is redirected by aliasing or forwarding
33232 during verification: should the generated addresses themselves be verified,
33233 or should the successful expansion of the original address be enough to verify
33234 it? By default, Exim takes the following pragmatic approach:
33235
33236 .ilist
33237 When an incoming address is redirected to just one child address, verification
33238 continues with the child address, and if that fails to verify, the original
33239 verification also fails.
33240 .next
33241 When an incoming address is redirected to more than one child address,
33242 verification does not continue. A success result is returned.
33243 .endlist
33244
33245 This seems the most reasonable behaviour for the common use of aliasing as a
33246 way of redirecting different local parts to the same mailbox. It means, for
33247 example, that a pair of alias entries of the form
33248 .code
33249 A.Wol:   aw123
33250 aw123:   :fail: Gone away, no forwarding address
33251 .endd
33252 work as expected, with both local parts causing verification failure. When a
33253 redirection generates more than one address, the behaviour is more like a
33254 mailing list, where the existence of the alias itself is sufficient for
33255 verification to succeed.
33256
33257 It is possible, however, to change the default behaviour so that all successful
33258 redirections count as successful verifications, however many new addresses are
33259 generated. This is specified by the &%success_on_redirect%& verification
33260 option. For example:
33261 .code
33262 require verify = recipient/success_on_redirect/callout=10s
33263 .endd
33264 In this example, verification succeeds if a router generates a new address, and
33265 the callout does not occur, because no address was routed to a remote host.
33266
33267 When verification is being tested via the &%-bv%& option, the treatment of
33268 redirections is as just described, unless the &%-v%& or any debugging option is
33269 also specified. In that case, full verification is done for every generated
33270 address and a report is output for each of them.
33271
33272
33273
33274 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33275 .cindex "CSA" "verifying"
33276 Client SMTP Authorization is a system that allows a site to advertise
33277 which machines are and are not permitted to send email. This is done by placing
33278 special SRV records in the DNS; these are looked up using the client's HELO
33279 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33280 Authorization checks in Exim are performed by the ACL condition:
33281 .code
33282 verify = csa
33283 .endd
33284 This fails if the client is not authorized. If there is a DNS problem, or if no
33285 valid CSA SRV record is found, or if the client is authorized, the condition
33286 succeeds. These three cases can be distinguished using the expansion variable
33287 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33288 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33289 be likely to cause problems for legitimate email.
33290
33291 The error messages produced by the CSA code include slightly more
33292 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33293 looking up the CSA SRV record, or problems looking up the CSA target
33294 address record. There are four reasons for &$csa_status$& being &"fail"&:
33295
33296 .ilist
33297 The client's host name is explicitly not authorized.
33298 .next
33299 The client's IP address does not match any of the CSA target IP addresses.
33300 .next
33301 The client's host name is authorized but it has no valid target IP addresses
33302 (for example, the target's addresses are IPv6 and the client is using IPv4).
33303 .next
33304 The client's host name has no CSA SRV record but a parent domain has asserted
33305 that all subdomains must be explicitly authorized.
33306 .endlist
33307
33308 The &%csa%& verification condition can take an argument which is the domain to
33309 use for the DNS query. The default is:
33310 .code
33311 verify = csa/$sender_helo_name
33312 .endd
33313 This implementation includes an extension to CSA. If the query domain
33314 is an address literal such as [192.0.2.95], or if it is a bare IP
33315 address, Exim searches for CSA SRV records in the reverse DNS as if
33316 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33317 meaningful to say:
33318 .code
33319 verify = csa/$sender_host_address
33320 .endd
33321 In fact, this is the check that Exim performs if the client does not say HELO.
33322 This extension can be turned off by setting the main configuration option
33323 &%dns_csa_use_reverse%& to be false.
33324
33325 If a CSA SRV record is not found for the domain itself, a search
33326 is performed through its parent domains for a record which might be
33327 making assertions about subdomains. The maximum depth of this search is limited
33328 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33329 default. Exim does not look for CSA SRV records in a top level domain, so the
33330 default settings handle HELO domains as long as seven
33331 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33332 of legitimate HELO domains.
33333
33334 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33335 direct SRV lookups, this is not sufficient because of the extra parent domain
33336 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33337 addresses into lookups in the reverse DNS space. The result of a successful
33338 lookup such as:
33339 .code
33340 ${lookup dnsdb {csa=$sender_helo_name}}
33341 .endd
33342 has two space-separated fields: an authorization code and a target host name.
33343 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33344 authorization required but absent, or &"?"& for unknown.
33345
33346
33347
33348
33349 .section "Bounce address tag validation" "SECTverifyPRVS"
33350 .cindex "BATV, verifying"
33351 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33352 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33353 Genuine incoming bounce messages should therefore always be addressed to
33354 recipients that have a valid tag. This scheme is a way of detecting unwanted
33355 bounce messages caused by sender address forgeries (often called &"collateral
33356 spam"&), because the recipients of such messages do not include valid tags.
33357
33358 There are two expansion items to help with the implementation of the BATV
33359 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33360 the original envelope sender address by using a simple key to add a hash of the
33361 address and some time-based randomizing information. The &%prvs%& expansion
33362 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33363 The syntax of these expansion items is described in section
33364 &<<SECTexpansionitems>>&.
33365 The validity period on signed addresses is seven days.
33366
33367 As an example, suppose the secret per-address keys are stored in an MySQL
33368 database. A query to look up the key for an address could be defined as a macro
33369 like this:
33370 .code
33371 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33372                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33373                 }{$value}}
33374 .endd
33375 Suppose also that the senders who make use of BATV are defined by an address
33376 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33377 use this:
33378 .code
33379 # Bounces: drop unsigned addresses for BATV senders
33380 deny senders = :
33381      recipients = +batv_senders
33382      message = This address does not send an unsigned reverse path
33383
33384 # Bounces: In case of prvs-signed address, check signature.
33385 deny senders = :
33386      condition  = ${prvscheck {$local_part@$domain}\
33387                   {PRVSCHECK_SQL}{1}}
33388      !condition = $prvscheck_result
33389      message = Invalid reverse path signature.
33390 .endd
33391 The first statement rejects recipients for bounce messages that are addressed
33392 to plain BATV sender addresses, because it is known that BATV senders do not
33393 send out messages with plain sender addresses. The second statement rejects
33394 recipients that are prvs-signed, but with invalid signatures (either because
33395 the key is wrong, or the signature has timed out).
33396
33397 A non-prvs-signed address is not rejected by the second statement, because the
33398 &%prvscheck%& expansion yields an empty string if its first argument is not a
33399 prvs-signed address, thus causing the &%condition%& condition to be false. If
33400 the first argument is a syntactically valid prvs-signed address, the yield is
33401 the third string (in this case &"1"&), whether or not the cryptographic and
33402 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33403 of the checks (empty for failure, &"1"& for success).
33404
33405 There is one more issue you must consider when implementing prvs-signing:
33406 you have to ensure that the routers accept prvs-signed addresses and
33407 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33408 router to remove the signature with a configuration along these lines:
33409 .code
33410 batv_redirect:
33411   driver = redirect
33412   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33413 .endd
33414 This works because, if the third argument of &%prvscheck%& is empty, the result
33415 of the expansion of a prvs-signed address is the decoded value of the original
33416 address. This router should probably be the first of your routers that handles
33417 local addresses.
33418
33419 To create BATV-signed addresses in the first place, a transport of this form
33420 can be used:
33421 .code
33422 external_smtp_batv:
33423   driver = smtp
33424   return_path = ${prvs {$return_path} \
33425                        {${lookup mysql{SELECT \
33426                        secret FROM batv_prvs WHERE \
33427                        sender='${quote_mysql:$sender_address}'} \
33428                        {$value}fail}}}
33429 .endd
33430 If no key can be found for the existing return path, no signing takes place.
33431
33432
33433
33434 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33435 .cindex "&ACL;" "relay control"
33436 .cindex "relaying" "control by ACL"
33437 .cindex "policy control" "relay control"
33438 An MTA is said to &'relay'& a message if it receives it from some host and
33439 delivers it directly to another host as a result of a remote address contained
33440 within it. Redirecting a local address via an alias or forward file and then
33441 passing the message on to another host is not relaying,
33442 .cindex "&""percent hack""&"
33443 but a redirection as a result of the &"percent hack"& is.
33444
33445 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33446 A host which is acting as a gateway or an MX backup is concerned with incoming
33447 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33448 a host which is acting as a smart host for a number of clients is concerned
33449 with outgoing relaying from those clients to the Internet at large. Often the
33450 same host is fulfilling both functions,
33451 . ///
33452 . as illustrated in the diagram below,
33453 . ///
33454 but in principle these two kinds of relaying are entirely independent. What is
33455 not wanted is the transmission of mail from arbitrary remote hosts through your
33456 system to arbitrary domains.
33457
33458
33459 You can implement relay control by means of suitable statements in the ACL that
33460 runs for each RCPT command. For convenience, it is often easiest to use
33461 Exim's named list facility to define the domains and hosts involved. For
33462 example, suppose you want to do the following:
33463
33464 .ilist
33465 Deliver a number of domains to mailboxes on the local host (or process them
33466 locally in some other way). Let's say these are &'my.dom1.example'& and
33467 &'my.dom2.example'&.
33468 .next
33469 Relay mail for a number of other domains for which you are the secondary MX.
33470 These might be &'friend1.example'& and &'friend2.example'&.
33471 .next
33472 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33473 Suppose your LAN is 192.168.45.0/24.
33474 .endlist
33475
33476
33477 In the main part of the configuration, you put the following definitions:
33478 .code
33479 domainlist local_domains    = my.dom1.example : my.dom2.example
33480 domainlist relay_to_domains = friend1.example : friend2.example
33481 hostlist   relay_from_hosts = 192.168.45.0/24
33482 .endd
33483 Now you can use these definitions in the ACL that is run for every RCPT
33484 command:
33485 .code
33486 acl_check_rcpt:
33487   accept domains = +local_domains : +relay_to_domains
33488   accept hosts   = +relay_from_hosts
33489 .endd
33490 The first statement accepts any RCPT command that contains an address in
33491 the local or relay domains. For any other domain, control passes to the second
33492 statement, which accepts the command only if it comes from one of the relay
33493 hosts. In practice, you will probably want to make your ACL more sophisticated
33494 than this, for example, by including sender and recipient verification. The
33495 default configuration includes a more comprehensive example, which is described
33496 in chapter &<<CHAPdefconfil>>&.
33497
33498
33499
33500 .section "Checking a relay configuration" "SECTcheralcon"
33501 .cindex "relaying" "checking control of"
33502 You can check the relay characteristics of your configuration in the same way
33503 that you can test any ACL behaviour for an incoming SMTP connection, by using
33504 the &%-bh%& option to run a fake SMTP session with which you interact.
33505 .ecindex IIDacl
33506
33507
33508
33509 . ////////////////////////////////////////////////////////////////////////////
33510 . ////////////////////////////////////////////////////////////////////////////
33511
33512 .chapter "Content scanning at ACL time" "CHAPexiscan"
33513 .scindex IIDcosca "content scanning" "at ACL time"
33514 The extension of Exim to include content scanning at ACL time, formerly known
33515 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33516 was integrated into the main source for Exim release 4.50, and Tom continues to
33517 maintain it. Most of the wording of this chapter is taken from Tom's
33518 specification.
33519
33520 It is also possible to scan the content of messages at other times. The
33521 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33522 scanning after all the ACLs have run. A transport filter can be used to scan
33523 messages at delivery time (see the &%transport_filter%& option, described in
33524 chapter &<<CHAPtransportgeneric>>&).
33525
33526 If you want to include the ACL-time content-scanning features when you compile
33527 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33528 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33529
33530 .ilist
33531 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33532 for all MIME parts for SMTP and non-SMTP messages, respectively.
33533 .next
33534 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33535 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33536 run at the end of message reception (the &%acl_smtp_data%& ACL).
33537 .next
33538 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33539 of messages, or parts of messages, for debugging purposes.
33540 .next
33541 Additional expansion variables that are set in the new ACL and by the new
33542 conditions.
33543 .next
33544 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33545 .endlist
33546
33547 Content-scanning is continually evolving, and new features are still being
33548 added. While such features are still unstable and liable to incompatible
33549 changes, they are made available in Exim by setting options whose names begin
33550 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33551 this manual. You can find out about them by reading the file called
33552 &_doc/experimental.txt_&.
33553
33554 All the content-scanning facilities work on a MBOX copy of the message that is
33555 temporarily created in a file called:
33556 .display
33557 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33558 .endd
33559 The &_.eml_& extension is a friendly hint to virus scanners that they can
33560 expect an MBOX-like structure inside that file. The file is created when the
33561 first content scanning facility is called. Subsequent calls to content
33562 scanning conditions open the same file again. The directory is recursively
33563 removed when the &%acl_smtp_data%& ACL has finished running, unless
33564 .code
33565 control = no_mbox_unspool
33566 .endd
33567 has been encountered. When the MIME ACL decodes files, they are put into the
33568 same directory by default.
33569
33570
33571
33572 .section "Scanning for viruses" "SECTscanvirus"
33573 .cindex "virus scanning"
33574 .cindex "content scanning" "for viruses"
33575 .cindex "content scanning" "the &%malware%& condition"
33576 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33577 It supports a &"generic"& interface to scanners called via the shell, and
33578 specialized interfaces for &"daemon"& type virus scanners, which are resident
33579 in memory and thus are much faster.
33580
33581 Since message data needs to have arrived,
33582 the condition may be only called in ACL defined by
33583 &%acl_smtp_data%&,
33584 &%acl_smtp_data_prdr%&,
33585 &%acl_smtp_mime%& or
33586 &%acl_smtp_dkim%&
33587
33588 A timeout of 2 minutes is applied to a scanner call (by default);
33589 if it expires then a defer action is taken.
33590
33591 .oindex "&%av_scanner%&"
33592 You can set the &%av_scanner%& option in the main part of the configuration
33593 to specify which scanner to use, together with any additional options that
33594 are needed. The basic syntax is as follows:
33595 .display
33596 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33597 .endd
33598 If you do not set &%av_scanner%&, it defaults to
33599 .code
33600 av_scanner = sophie:/var/run/sophie
33601 .endd
33602 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33603 before use.
33604 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33605 The following scanner types are supported in this release,
33606 though individual ones can be included or not at build time:
33607
33608 .vlist
33609 .vitem &%avast%&
33610 .cindex "virus scanners" "avast"
33611 This is the scanner daemon of Avast. It has been tested with Avast Core
33612 Security (currently at version 2.2.0).
33613 You can get a trial version at &url(https://www.avast.com) or for Linux
33614 at &url(https://www.avast.com/linux-server-antivirus).
33615 This scanner type takes one option,
33616 which can be either a full path to a UNIX socket,
33617 or host and port specifiers separated by white space.
33618 The host may be a name or an IP address; the port is either a
33619 single number or a pair of numbers with a dash between.
33620 A list of options may follow. These options are interpreted on the
33621 Exim's side of the malware scanner, or are given on separate lines to
33622 the daemon as options before the main scan command.
33623
33624 .cindex &`pass_unscanned`& "avast"
33625 If &`pass_unscanned`&
33626 is set, any files the Avast scanner can't scan (e.g.
33627 decompression bombs, or invalid archives) are considered clean. Use with
33628 care.
33629
33630 For example:
33631 .code
33632 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33633 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33634 av_scanner = avast:192.168.2.22 5036
33635 .endd
33636 If you omit the argument, the default path
33637 &_/var/run/avast/scan.sock_&
33638 is used.
33639 If you use a remote host,
33640 you need to make Exim's spool directory available to it,
33641 as the scanner is passed a file path, not file contents.
33642 For information about available commands and their options you may use
33643 .code
33644 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33645     FLAGS
33646     SENSITIVITY
33647     PACK
33648 .endd
33649
33650 If the scanner returns a temporary failure (e.g. license issues, or
33651 permission problems), the message is deferred and a paniclog entry is
33652 written.  The usual &`defer_ok`& option is available.
33653
33654 .vitem &%aveserver%&
33655 .cindex "virus scanners" "Kaspersky"
33656 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33657 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33658 which is the path to the daemon's UNIX socket. The default is shown in this
33659 example:
33660 .code
33661 av_scanner = aveserver:/var/run/aveserver
33662 .endd
33663
33664
33665 .vitem &%clamd%&
33666 .cindex "virus scanners" "clamd"
33667 This daemon-type scanner is GPL and free. You can get it at
33668 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33669 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33670 in the MIME ACL. This is no longer believed to be necessary.
33671
33672 The options are a list of server specifiers, which may be
33673 a UNIX socket specification,
33674 a TCP socket specification,
33675 or a (global) option.
33676
33677 A socket specification consists of a space-separated list.
33678 For a Unix socket the first element is a full path for the socket,
33679 for a TCP socket the first element is the IP address
33680 and the second a port number,
33681 Any further elements are per-server (non-global) options.
33682 These per-server options are supported:
33683 .code
33684 retry=<timespec>        Retry on connect fail
33685 .endd
33686
33687 The &`retry`& option specifies a time after which a single retry for
33688 a failed connect is made.  The default is to not retry.
33689
33690 If a Unix socket file is specified, only one server is supported.
33691
33692 Examples:
33693 .code
33694 av_scanner = clamd:/opt/clamd/socket
33695 av_scanner = clamd:192.0.2.3 1234
33696 av_scanner = clamd:192.0.2.3 1234:local
33697 av_scanner = clamd:192.0.2.3 1234 retry=10s
33698 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33699 .endd
33700 If the value of av_scanner points to a UNIX socket file or contains the
33701 &`local`&
33702 option, then the ClamAV interface will pass a filename containing the data
33703 to be scanned, which should normally result in less I/O happening and be
33704 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33705 Exim does not assume that there is a common filesystem with the remote host.
33706
33707 The final example shows that multiple TCP targets can be specified.  Exim will
33708 randomly use one for each incoming email (i.e. it load balances them).  Note
33709 that only TCP targets may be used if specifying a list of scanners; a UNIX
33710 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33711 unavailable, Exim will try the remaining one(s) until it finds one that works.
33712 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33713 not keep track of scanner state between multiple messages, and the scanner
33714 selection is random, so the message will get logged in the mainlog for each
33715 email that the down scanner gets chosen first (message wrapped to be readable):
33716 .code
33717 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33718    clamd: connection to localhost, port 3310 failed
33719    (Connection refused)
33720 .endd
33721
33722 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33723 contributing the code for this scanner.
33724
33725 .vitem &%cmdline%&
33726 .cindex "virus scanners" "command line interface"
33727 This is the keyword for the generic command line scanner interface. It can be
33728 used to attach virus scanners that are invoked from the shell. This scanner
33729 type takes 3 mandatory options:
33730
33731 .olist
33732 The full path and name of the scanner binary, with all command line options,
33733 and a placeholder (&`%s`&) for the directory to scan.
33734
33735 .next
33736 A regular expression to match against the STDOUT and STDERR output of the
33737 virus scanner. If the expression matches, a virus was found. You must make
33738 absolutely sure that this expression matches on &"virus found"&. This is called
33739 the &"trigger"& expression.
33740
33741 .next
33742 Another regular expression, containing exactly one pair of parentheses, to
33743 match the name of the virus found in the scanners output. This is called the
33744 &"name"& expression.
33745 .endlist olist
33746
33747 For example, Sophos Sweep reports a virus on a line like this:
33748 .code
33749 Virus 'W32/Magistr-B' found in file ./those.bat
33750 .endd
33751 For the trigger expression, we can match the phrase &"found in file"&. For the
33752 name expression, we want to extract the W32/Magistr-B string, so we can match
33753 for the single quotes left and right of it. Altogether, this makes the
33754 configuration setting:
33755 .code
33756 av_scanner = cmdline:\
33757              /path/to/sweep -ss -all -rec -archive %s:\
33758              found in file:'(.+)'
33759 .endd
33760 .vitem &%drweb%&
33761 .cindex "virus scanners" "DrWeb"
33762 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33763 takes one option,
33764 either a full path to a UNIX socket,
33765 or host and port specifiers separated by white space.
33766 The host may be a name or an IP address; the port is either a
33767 single number or a pair of numbers with a dash between.
33768 For example:
33769 .code
33770 av_scanner = drweb:/var/run/drwebd.sock
33771 av_scanner = drweb:192.168.2.20 31337
33772 .endd
33773 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33774 is used. Thanks to Alex Miller for contributing the code for this scanner.
33775
33776 .vitem &%f-protd%&
33777 .cindex "virus scanners" "f-protd"
33778 The f-protd scanner is accessed via HTTP over TCP.
33779 One argument is taken, being a space-separated hostname and port number
33780 (or port-range).
33781 For example:
33782 .code
33783 av_scanner = f-protd:localhost 10200-10204
33784 .endd
33785 If you omit the argument, the default values shown above are used.
33786
33787 .vitem &%f-prot6d%&
33788 .cindex "virus scanners" "f-prot6d"
33789 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33790 One argument is taken, being a space-separated hostname and port number.
33791 For example:
33792 .code
33793 av_scanner = f-prot6d:localhost 10200
33794 .endd
33795 If you omit the argument, the default values show above are used.
33796
33797 .vitem &%fsecure%&
33798 .cindex "virus scanners" "F-Secure"
33799 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33800 argument which is the path to a UNIX socket. For example:
33801 .code
33802 av_scanner = fsecure:/path/to/.fsav
33803 .endd
33804 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33805 Thelmen for contributing the code for this scanner.
33806
33807 .vitem &%kavdaemon%&
33808 .cindex "virus scanners" "Kaspersky"
33809 This is the scanner daemon of Kaspersky Version 4. This version of the
33810 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33811 scanner type takes one option, which is the path to the daemon's UNIX socket.
33812 For example:
33813 .code
33814 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33815 .endd
33816 The default path is &_/var/run/AvpCtl_&.
33817
33818 .vitem &%mksd%&
33819 .cindex "virus scanners" "mksd"
33820 This was a daemon type scanner that is aimed mainly at Polish users,
33821 though some documentation was available in English.
33822 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33823 and this appears to be a candidate for removal from Exim, unless
33824 we are informed of other virus scanners which use the same protocol
33825 to integrate.
33826 The only option for this scanner type is
33827 the maximum number of processes used simultaneously to scan the attachments,
33828 provided that mksd has
33829 been run with at least the same number of child processes. For example:
33830 .code
33831 av_scanner = mksd:2
33832 .endd
33833 You can safely omit this option (the default value is 1).
33834
33835 .vitem &%sock%&
33836 .cindex "virus scanners" "simple socket-connected"
33837 This is a general-purpose way of talking to simple scanner daemons
33838 running on the local machine.
33839 There are four options:
33840 an address (which may be an IP address and port, or the path of a Unix socket),
33841 a commandline to send (may include a single %s which will be replaced with
33842 the path to the mail file to be scanned),
33843 an RE to trigger on from the returned data,
33844 and an RE to extract malware_name from the returned data.
33845 For example:
33846 .code
33847 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33848 .endd
33849 Note that surrounding whitespace is stripped from each option, meaning
33850 there is no way to specify a trailing newline.
33851 The socket specifier and both regular-expressions are required.
33852 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33853 specify an empty element to get this.
33854
33855 .vitem &%sophie%&
33856 .cindex "virus scanners" "Sophos and Sophie"
33857 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33858 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33859 for this scanner type is the path to the UNIX socket that Sophie uses for
33860 client communication. For example:
33861 .code
33862 av_scanner = sophie:/tmp/sophie
33863 .endd
33864 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33865 the option.
33866 .endlist
33867
33868 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33869 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33870 ACL.
33871
33872 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33873 makes it possible to use different scanners. See further below for an example.
33874 The &%malware%& condition caches its results, so when you use it multiple times
33875 for the same message, the actual scanning process is only carried out once.
33876 However, using expandable items in &%av_scanner%& disables this caching, in
33877 which case each use of the &%malware%& condition causes a new scan of the
33878 message.
33879
33880 The &%malware%& condition takes a right-hand argument that is expanded before
33881 use and taken as a list, slash-separated by default.
33882 The first element can then be one of
33883
33884 .ilist
33885 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33886 The condition succeeds if a virus was found, and fail otherwise. This is the
33887 recommended usage.
33888 .next
33889 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33890 the condition fails immediately.
33891 .next
33892 A regular expression, in which case the message is scanned for viruses. The
33893 condition succeeds if a virus is found and its name matches the regular
33894 expression. This allows you to take special actions on certain types of virus.
33895 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33896 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33897 .endlist
33898
33899 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33900 messages even if there is a problem with the virus scanner.
33901 Otherwise, such a problem causes the ACL to defer.
33902
33903 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33904 specify a non-default timeout.  The default is two minutes.
33905 For example:
33906 .code
33907 malware = * / defer_ok / tmo=10s
33908 .endd
33909 A timeout causes the ACL to defer.
33910
33911 .vindex "&$callout_address$&"
33912 When a connection is made to the scanner the expansion variable &$callout_address$&
33913 is set to record the actual address used.
33914
33915 .vindex "&$malware_name$&"
33916 When a virus is found, the condition sets up an expansion variable called
33917 &$malware_name$& that contains the name of the virus. You can use it in a
33918 &%message%& modifier that specifies the error returned to the sender, and/or in
33919 logging data.
33920
33921 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33922 imposed by your anti-virus scanner.
33923
33924 Here is a very simple scanning example:
33925 .code
33926 deny malware = *
33927      message = This message contains malware ($malware_name)
33928 .endd
33929 The next example accepts messages when there is a problem with the scanner:
33930 .code
33931 deny malware = */defer_ok
33932      message = This message contains malware ($malware_name)
33933 .endd
33934 The next example shows how to use an ACL variable to scan with both sophie and
33935 aveserver. It assumes you have set:
33936 .code
33937 av_scanner = $acl_m0
33938 .endd
33939 in the main Exim configuration.
33940 .code
33941 deny set acl_m0 = sophie
33942      malware = *
33943      message = This message contains malware ($malware_name)
33944
33945 deny set acl_m0 = aveserver
33946      malware = *
33947      message = This message contains malware ($malware_name)
33948 .endd
33949
33950
33951 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33952 .cindex "content scanning" "for spam"
33953 .cindex "spam scanning"
33954 .cindex "SpamAssassin"
33955 .cindex "Rspamd"
33956 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33957 score and a report for the message.
33958 Support is also provided for Rspamd.
33959
33960 For more information about installation and configuration of SpamAssassin or
33961 Rspamd refer to their respective websites at
33962 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33963
33964 SpamAssassin can be installed with CPAN by running:
33965 .code
33966 perl -MCPAN -e 'install Mail::SpamAssassin'
33967 .endd
33968 SpamAssassin has its own set of configuration files. Please review its
33969 documentation to see how you can tweak it. The default installation should work
33970 nicely, however.
33971
33972 .oindex "&%spamd_address%&"
33973 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33974 intend to use an instance running on the local host you do not need to set
33975 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33976 you must set the &%spamd_address%& option in the global part of the Exim
33977 configuration as follows (example):
33978 .code
33979 spamd_address = 192.168.99.45 783
33980 .endd
33981 The SpamAssassin protocol relies on a TCP half-close from the client.
33982 If your SpamAssassin client side is running a Linux system with an
33983 iptables firewall, consider setting
33984 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33985 timeout, Exim uses when waiting for a response from the SpamAssassin
33986 server (currently defaulting to 120s).  With a lower value the Linux
33987 connection tracking may consider your half-closed connection as dead too
33988 soon.
33989
33990
33991 To use Rspamd (which by default listens on all local addresses
33992 on TCP port 11333)
33993 you should add &%variant=rspamd%& after the address/port pair, for example:
33994 .code
33995 spamd_address = 127.0.0.1 11333 variant=rspamd
33996 .endd
33997
33998 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33999 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34000 filename instead of an address/port pair:
34001 .code
34002 spamd_address = /var/run/spamd_socket
34003 .endd
34004 You can have multiple &%spamd%& servers to improve scalability. These can
34005 reside on other hardware reachable over the network. To specify multiple
34006 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34007 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34008 .code
34009 spamd_address = 192.168.2.10 783 : \
34010                 192.168.2.11 783 : \
34011                 192.168.2.12 783
34012 .endd
34013 Up to 32 &%spamd%& servers are supported.
34014 When a server fails to respond to the connection attempt, all other
34015 servers are tried until one succeeds. If no server responds, the &%spam%&
34016 condition defers.
34017
34018 Unix and TCP socket specifications may be mixed in any order.
34019 Each element of the list is a list itself, space-separated by default
34020 and changeable in the usual way (&<<SECTlistsepchange>>&);
34021 take care to not double the separator.
34022
34023 For TCP socket specifications a host name or IP (v4 or v6, but
34024 subject to list-separator quoting rules) address can be used,
34025 and the port can be one or a dash-separated pair.
34026 In the latter case, the range is tried in strict order.
34027
34028 Elements after the first for Unix sockets, or second for TCP socket,
34029 are options.
34030 The supported options are:
34031 .code
34032 pri=<priority>      Selection priority
34033 weight=<value>      Selection bias
34034 time=<start>-<end>  Use only between these times of day
34035 retry=<timespec>    Retry on connect fail
34036 tmo=<timespec>      Connection time limit
34037 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34038 .endd
34039
34040 The &`pri`& option specifies a priority for the server within the list,
34041 higher values being tried first.
34042 The default priority is 1.
34043
34044 The &`weight`& option specifies a selection bias.
34045 Within a priority set
34046 servers are queried in a random fashion, weighted by this value.
34047 The default value for selection bias is 1.
34048
34049 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34050 in the local time zone; each element being one or more digits.
34051 Either the seconds or both minutes and seconds, plus the leading &`.`&
34052 characters, may be omitted and will be taken as zero.
34053
34054 Timeout specifications for the &`retry`& and &`tmo`& options
34055 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34056
34057 The &`tmo`& option specifies an overall timeout for communication.
34058 The default value is two minutes.
34059
34060 The &`retry`& option specifies a time after which a single retry for
34061 a failed connect is made.
34062 The default is to not retry.
34063
34064 The &%spamd_address%& variable is expanded before use if it starts with
34065 a dollar sign. In this case, the expansion may return a string that is
34066 used as the list so that multiple spamd servers can be the result of an
34067 expansion.
34068
34069 .vindex "&$callout_address$&"
34070 When a connection is made to the server the expansion variable &$callout_address$&
34071 is set to record the actual address used.
34072
34073 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34074 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34075 .code
34076 deny spam = joe
34077      message = This message was classified as SPAM
34078 .endd
34079 The right-hand side of the &%spam%& condition specifies a name. This is
34080 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34081 to scan using a specific profile, but rather use the SpamAssassin system-wide
34082 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34083 Rspamd does not use this setting. However, you must put something on the
34084 right-hand side.
34085
34086 The name allows you to use per-domain or per-user antispam profiles in
34087 principle, but this is not straightforward in practice, because a message may
34088 have multiple recipients, not necessarily all in the same domain. Because the
34089 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34090 read the contents of the message, the variables &$local_part$& and &$domain$&
34091 are not set.
34092 Careful enforcement of single-recipient messages
34093 (e.g. by responding with defer in the recipient ACL for all recipients
34094 after the first),
34095 or the use of PRDR,
34096 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34097 are needed to use this feature.
34098
34099 The right-hand side of the &%spam%& condition is expanded before being used, so
34100 you can put lookups or conditions there. When the right-hand side evaluates to
34101 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34102
34103
34104 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34105 large ones may cause significant performance degradation. As most spam messages
34106 are quite small, it is recommended that you do not scan the big ones. For
34107 example:
34108 .code
34109 deny condition = ${if < {$message_size}{10K}}
34110      spam = nobody
34111      message = This message was classified as SPAM
34112 .endd
34113
34114 The &%spam%& condition returns true if the threshold specified in the user's
34115 SpamAssassin profile has been matched or exceeded. If you want to use the
34116 &%spam%& condition for its side effects (see the variables below), you can make
34117 it always return &"true"& by appending &`:true`& to the username.
34118
34119 .cindex "spam scanning" "returned variables"
34120 When the &%spam%& condition is run, it sets up a number of expansion
34121 variables.
34122 Except for &$spam_report$&,
34123 these variables are saved with the received message so are
34124 available for use at delivery time.
34125
34126 .vlist
34127 .vitem &$spam_score$&
34128 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34129 for inclusion in log or reject messages.
34130
34131 .vitem &$spam_score_int$&
34132 The spam score of the message, multiplied by ten, as an integer value. For
34133 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34134 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34135 The integer value is useful for numeric comparisons in conditions.
34136
34137 .vitem &$spam_bar$&
34138 A string consisting of a number of &"+"& or &"-"& characters, representing the
34139 integer part of the spam score value. A spam score of 4.4 would have a
34140 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34141 headers, since MUAs can match on such strings. The maximum length of the
34142 spam bar is 50 characters.
34143
34144 .vitem &$spam_report$&
34145 A multiline text table, containing the full SpamAssassin report for the
34146 message. Useful for inclusion in headers or reject messages.
34147 This variable is only usable in a DATA-time ACL.
34148 Beware that SpamAssassin may return non-ASCII characters, especially
34149 when running in country-specific locales, which are not legal
34150 unencoded in headers.
34151
34152 .vitem &$spam_action$&
34153 For SpamAssassin either 'reject' or 'no action' depending on the
34154 spam score versus threshold.
34155 For Rspamd, the recommended action.
34156
34157 .endlist
34158
34159 The &%spam%& condition caches its results unless expansion in
34160 spamd_address was used. If you call it again with the same user name, it
34161 does not scan again, but rather returns the same values as before.
34162
34163 The &%spam%& condition returns DEFER if there is any error while running
34164 the message through SpamAssassin or if the expansion of spamd_address
34165 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34166 statement block), append &`/defer_ok`& to the right-hand side of the
34167 spam condition, like this:
34168 .code
34169 deny spam    = joe/defer_ok
34170      message = This message was classified as SPAM
34171 .endd
34172 This causes messages to be accepted even if there is a problem with &%spamd%&.
34173
34174 Here is a longer, commented example of the use of the &%spam%&
34175 condition:
34176 .code
34177 # put headers in all messages (no matter if spam or not)
34178 warn  spam = nobody:true
34179       add_header = X-Spam-Score: $spam_score ($spam_bar)
34180       add_header = X-Spam-Report: $spam_report
34181
34182 # add second subject line with *SPAM* marker when message
34183 # is over threshold
34184 warn  spam = nobody
34185       add_header = Subject: *SPAM* $h_Subject:
34186
34187 # reject spam at high scores (> 12)
34188 deny  spam = nobody:true
34189       condition = ${if >{$spam_score_int}{120}{1}{0}}
34190       message = This message scored $spam_score spam points.
34191 .endd
34192
34193
34194
34195 .section "Scanning MIME parts" "SECTscanmimepart"
34196 .cindex "content scanning" "MIME parts"
34197 .cindex "MIME content scanning"
34198 .oindex "&%acl_smtp_mime%&"
34199 .oindex "&%acl_not_smtp_mime%&"
34200 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34201 each MIME part of an SMTP message, including multipart types, in the sequence
34202 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34203 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34204 options may both refer to the same ACL if you want the same processing in both
34205 cases.
34206
34207 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34208 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34209 the case of a non-SMTP message. However, a MIME ACL is called only if the
34210 message contains a &'Content-Type:'& header line. When a call to a MIME
34211 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34212 result code is sent to the client. In the case of an SMTP message, the
34213 &%acl_smtp_data%& ACL is not called when this happens.
34214
34215 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34216 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34217 condition to match against the raw MIME part. You can also use the
34218 &%mime_regex%& condition to match against the decoded MIME part (see section
34219 &<<SECTscanregex>>&).
34220
34221 At the start of a MIME ACL, a number of variables are set from the header
34222 information for the relevant MIME part. These are described below. The contents
34223 of the MIME part are not by default decoded into a disk file except for MIME
34224 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34225 part into a disk file, you can use the &%decode%& condition. The general
34226 syntax is:
34227 .display
34228 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34229 .endd
34230 The right hand side is expanded before use. After expansion,
34231 the value can be:
34232
34233 .olist
34234 &"0"& or &"false"&, in which case no decoding is done.
34235 .next
34236 The string &"default"&. In that case, the file is put in the temporary
34237 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34238 a sequential filename consisting of the message id and a sequence number. The
34239 full path and name is available in &$mime_decoded_filename$& after decoding.
34240 .next
34241 A full path name starting with a slash. If the full name is an existing
34242 directory, it is used as a replacement for the default directory. The filename
34243 is then sequentially assigned. If the path does not exist, it is used as
34244 the full path and filename.
34245 .next
34246 If the string does not start with a slash, it is used as the
34247 filename, and the default path is then used.
34248 .endlist
34249 The &%decode%& condition normally succeeds. It is only false for syntax
34250 errors or unusual circumstances such as memory shortages. You can easily decode
34251 a file with its original, proposed filename using
34252 .code
34253 decode = $mime_filename
34254 .endd
34255 However, you should keep in mind that &$mime_filename$& might contain
34256 anything. If you place files outside of the default path, they are not
34257 automatically unlinked.
34258
34259 For RFC822 attachments (these are messages attached to messages, with a
34260 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34261 as for the primary message, only that the &$mime_is_rfc822$& expansion
34262 variable is set (see below). Attached messages are always decoded to disk
34263 before being checked, and the files are unlinked once the check is done.
34264
34265 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34266 used to match regular expressions against raw and decoded MIME parts,
34267 respectively. They are described in section &<<SECTscanregex>>&.
34268
34269 .cindex "MIME content scanning" "returned variables"
34270 The following list describes all expansion variables that are
34271 available in the MIME ACL:
34272
34273 .vlist
34274 .vitem &$mime_anomaly_level$& &&&
34275        &$mime_anomaly_text$&
34276 .vindex &$mime_anomaly_level$&
34277 .vindex &$mime_anomaly_text$&
34278 If there are problems decoding, these variables contain information on
34279 the detected issue.
34280
34281 .vitem &$mime_boundary$&
34282 .vindex &$mime_boundary$&
34283 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34284 have a boundary string, which is stored in this variable. If the current part
34285 has no boundary parameter in the &'Content-Type:'& header, this variable
34286 contains the empty string.
34287
34288 .vitem &$mime_charset$&
34289 .vindex &$mime_charset$&
34290 This variable contains the character set identifier, if one was found in the
34291 &'Content-Type:'& header. Examples for charset identifiers are:
34292 .code
34293 us-ascii
34294 gb2312 (Chinese)
34295 iso-8859-1
34296 .endd
34297 Please note that this value is not normalized, so you should do matches
34298 case-insensitively.
34299
34300 .vitem &$mime_content_description$&
34301 .vindex &$mime_content_description$&
34302 This variable contains the normalized content of the &'Content-Description:'&
34303 header. It can contain a human-readable description of the parts content. Some
34304 implementations repeat the filename for attachments here, but they are usually
34305 only used for display purposes.
34306
34307 .vitem &$mime_content_disposition$&
34308 .vindex &$mime_content_disposition$&
34309 This variable contains the normalized content of the &'Content-Disposition:'&
34310 header. You can expect strings like &"attachment"& or &"inline"& here.
34311
34312 .vitem &$mime_content_id$&
34313 .vindex &$mime_content_id$&
34314 This variable contains the normalized content of the &'Content-ID:'& header.
34315 This is a unique ID that can be used to reference a part from another part.
34316
34317 .vitem &$mime_content_size$&
34318 .vindex &$mime_content_size$&
34319 This variable is set only after the &%decode%& modifier (see above) has been
34320 successfully run. It contains the size of the decoded part in kilobytes. The
34321 size is always rounded up to full kilobytes, so only a completely empty part
34322 has a &$mime_content_size$& of zero.
34323
34324 .vitem &$mime_content_transfer_encoding$&
34325 .vindex &$mime_content_transfer_encoding$&
34326 This variable contains the normalized content of the
34327 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34328 type. Typical values are &"base64"& and &"quoted-printable"&.
34329
34330 .vitem &$mime_content_type$&
34331 .vindex &$mime_content_type$&
34332 If the MIME part has a &'Content-Type:'& header, this variable contains its
34333 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34334 are some examples of popular MIME types, as they may appear in this variable:
34335 .code
34336 text/plain
34337 text/html
34338 application/octet-stream
34339 image/jpeg
34340 audio/midi
34341 .endd
34342 If the MIME part has no &'Content-Type:'& header, this variable contains the
34343 empty string.
34344
34345 .vitem &$mime_decoded_filename$&
34346 .vindex &$mime_decoded_filename$&
34347 This variable is set only after the &%decode%& modifier (see above) has been
34348 successfully run. It contains the full path and filename of the file
34349 containing the decoded data.
34350 .endlist
34351
34352 .cindex "RFC 2047"
34353 .vlist
34354 .vitem &$mime_filename$&
34355 .vindex &$mime_filename$&
34356 This is perhaps the most important of the MIME variables. It contains a
34357 proposed filename for an attachment, if one was found in either the
34358 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34359 RFC2047
34360 or RFC2231
34361 decoded, but no additional sanity checks are done.
34362  If no filename was
34363 found, this variable contains the empty string.
34364
34365 .vitem &$mime_is_coverletter$&
34366 .vindex &$mime_is_coverletter$&
34367 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34368 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34369 content in the cover letter, while not restricting attachments at all.
34370
34371 The variable contains 1 (true) for a MIME part believed to be part of the
34372 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34373 follows:
34374
34375 .olist
34376 The outermost MIME part of a message is always a cover letter.
34377
34378 .next
34379 If a multipart/alternative or multipart/related MIME part is a cover letter,
34380 so are all MIME subparts within that multipart.
34381
34382 .next
34383 If any other multipart is a cover letter, the first subpart is a cover letter,
34384 and the rest are attachments.
34385
34386 .next
34387 All parts contained within an attachment multipart are attachments.
34388 .endlist olist
34389
34390 As an example, the following will ban &"HTML mail"& (including that sent with
34391 alternative plain text), while allowing HTML files to be attached. HTML
34392 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34393 .code
34394 deny !condition = $mime_is_rfc822
34395      condition = $mime_is_coverletter
34396      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34397      message = HTML mail is not accepted here
34398 .endd
34399
34400 .vitem &$mime_is_multipart$&
34401 .vindex &$mime_is_multipart$&
34402 This variable has the value 1 (true) when the current part has the main type
34403 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34404 Since multipart entities only serve as containers for other parts, you may not
34405 want to carry out specific actions on them.
34406
34407 .vitem &$mime_is_rfc822$&
34408 .vindex &$mime_is_rfc822$&
34409 This variable has the value 1 (true) if the current part is not a part of the
34410 checked message itself, but part of an attached message. Attached message
34411 decoding is fully recursive.
34412
34413 .vitem &$mime_part_count$&
34414 .vindex &$mime_part_count$&
34415 This variable is a counter that is raised for each processed MIME part. It
34416 starts at zero for the very first part (which is usually a multipart). The
34417 counter is per-message, so it is reset when processing RFC822 attachments (see
34418 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34419 complete, so you can use it in the DATA ACL to determine the number of MIME
34420 parts of a message. For non-MIME messages, this variable contains the value -1.
34421 .endlist
34422
34423
34424
34425 .section "Scanning with regular expressions" "SECTscanregex"
34426 .cindex "content scanning" "with regular expressions"
34427 .cindex "regular expressions" "content scanning with"
34428 You can specify your own custom regular expression matches on the full body of
34429 the message, or on individual MIME parts.
34430
34431 The &%regex%& condition takes one or more regular expressions as arguments and
34432 matches them against the full message (when called in the DATA ACL) or a raw
34433 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34434 linewise, with a maximum line length of 32K characters. That means you cannot
34435 have multiline matches with the &%regex%& condition.
34436
34437 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34438 to 32K of decoded content (the whole content at once, not linewise). If the
34439 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34440 is decoded automatically when &%mime_regex%& is executed (using default path
34441 and filename values). If the decoded data is larger than  32K, only the first
34442 32K characters are checked.
34443
34444 The regular expressions are passed as a colon-separated list. To include a
34445 literal colon, you must double it. Since the whole right-hand side string is
34446 expanded before being used, you must also escape dollar signs and backslashes
34447 with more backslashes, or use the &`\N`& facility to disable expansion.
34448 Here is a simple example that contains two regular expressions:
34449 .code
34450 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34451      message = contains blacklisted regex ($regex_match_string)
34452 .endd
34453 The conditions returns true if any one of the regular expressions matches. The
34454 &$regex_match_string$& expansion variable is then set up and contains the
34455 matching regular expression.
34456 The expansion variables &$regex1$& &$regex2$& etc
34457 are set to any substrings captured by the regular expression.
34458
34459 &*Warning*&: With large messages, these conditions can be fairly
34460 CPU-intensive.
34461
34462 .ecindex IIDcosca
34463
34464
34465
34466
34467 . ////////////////////////////////////////////////////////////////////////////
34468 . ////////////////////////////////////////////////////////////////////////////
34469
34470 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34471          "Local scan function"
34472 .scindex IIDlosca "&[local_scan()]& function" "description of"
34473 .cindex "customizing" "input scan using C function"
34474 .cindex "policy control" "by local scan function"
34475 In these days of email worms, viruses, and ever-increasing spam, some sites
34476 want to apply a lot of checking to messages before accepting them.
34477
34478 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34479 passing messages to external virus and spam scanning software. You can also do
34480 a certain amount in Exim itself through string expansions and the &%condition%&
34481 condition in the ACL that runs after the SMTP DATA command or the ACL for
34482 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34483
34484 To allow for further customization to a site's own requirements, there is the
34485 possibility of linking Exim with a private message scanning function, written
34486 in C. If you want to run code that is written in something other than C, you
34487 can of course use a little C stub to call it.
34488
34489 The local scan function is run once for every incoming message, at the point
34490 when Exim is just about to accept the message.
34491 It can therefore be used to control non-SMTP messages from local processes as
34492 well as messages arriving via SMTP.
34493
34494 Exim applies a timeout to calls of the local scan function, and there is an
34495 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34496 Zero means &"no timeout"&.
34497 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34498 before calling the local scan function, so that the most common types of crash
34499 are caught. If the timeout is exceeded or one of those signals is caught, the
34500 incoming message is rejected with a temporary error if it is an SMTP message.
34501 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34502 code. The incident is logged on the main and reject logs.
34503
34504
34505
34506 .section "Building Exim to use a local scan function" "SECID207"
34507 .cindex "&[local_scan()]& function" "building Exim to use"
34508 To make use of the local scan function feature, you must tell Exim where your
34509 function is before building Exim, by setting
34510 both HAVE_LOCAL_SCAN and
34511 LOCAL_SCAN_SOURCE in your
34512 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34513 directory, so you might set
34514 .code
34515 HAVE_LOCAL_SCAN=yes
34516 LOCAL_SCAN_SOURCE=Local/local_scan.c
34517 .endd
34518 for example. The function must be called &[local_scan()]&;
34519 the source file(s) for it should first #define LOCAL_SCAN
34520 and then #include "local_scan.h".
34521 It is called by
34522 Exim after it has received a message, when the success return code is about to
34523 be sent. This is after all the ACLs have been run. The return code from your
34524 function controls whether the message is actually accepted or not. There is a
34525 commented template function (that just accepts the message) in the file
34526 _src/local_scan.c_.
34527
34528 If you want to make use of Exim's runtime configuration file to set options
34529 for your &[local_scan()]& function, you must also set
34530 .code
34531 LOCAL_SCAN_HAS_OPTIONS=yes
34532 .endd
34533 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34534
34535
34536
34537
34538 .section "API for local_scan()" "SECTapiforloc"
34539 .cindex "&[local_scan()]& function" "API description"
34540 .cindex &%dlfunc%& "API description"
34541 You must include this line near the start of your code:
34542 .code
34543 #define LOCAL_SCAN
34544 #include "local_scan.h"
34545 .endd
34546 This header file defines a number of variables and other values, and the
34547 prototype for the function itself. Exim is coded to use unsigned char values
34548 almost exclusively, and one of the things this header defines is a shorthand
34549 for &`unsigned char`& called &`uschar`&.
34550 It also makes available the following macro definitions, to simplify casting character
34551 strings and pointers to character strings:
34552 .code
34553 #define CS   (char *)
34554 #define CCS  (const char *)
34555 #define CSS  (char **)
34556 #define US   (unsigned char *)
34557 #define CUS  (const unsigned char *)
34558 #define USS  (unsigned char **)
34559 .endd
34560 The function prototype for &[local_scan()]& is:
34561 .code
34562 extern int local_scan(int fd, uschar **return_text);
34563 .endd
34564 The arguments are as follows:
34565
34566 .ilist
34567 &%fd%& is a file descriptor for the file that contains the body of the message
34568 (the -D file). The file is open for reading and writing, but updating it is not
34569 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34570
34571 The descriptor is positioned at character 19 of the file, which is the first
34572 character of the body itself, because the first 19 characters are the message
34573 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34574 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34575 case this changes in some future version.
34576 .next
34577 &%return_text%& is an address which you can use to return a pointer to a text
34578 string at the end of the function. The value it points to on entry is NULL.
34579 .endlist
34580
34581 The function must return an &%int%& value which is one of the following macros:
34582
34583 .vlist
34584 .vitem &`LOCAL_SCAN_ACCEPT`&
34585 .vindex "&$local_scan_data$&"
34586 The message is accepted. If you pass back a string of text, it is saved with
34587 the message, and made available in the variable &$local_scan_data$&. No
34588 newlines are permitted (if there are any, they are turned into spaces) and the
34589 maximum length of text is 1000 characters.
34590
34591 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34592 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34593 queued without immediate delivery, and is frozen.
34594
34595 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34596 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34597 queued without immediate delivery.
34598
34599 .vitem &`LOCAL_SCAN_REJECT`&
34600 The message is rejected; the returned text is used as an error message which is
34601 passed back to the sender and which is also logged. Newlines are permitted &--
34602 they cause a multiline response for SMTP rejections, but are converted to
34603 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34604 used.
34605
34606 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34607 The message is temporarily rejected; the returned text is used as an error
34608 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34609 problem"& is used.
34610
34611 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34612 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34613 message is not written to the reject log. It has the effect of unsetting the
34614 &%rejected_header%& log selector for just this rejection. If
34615 &%rejected_header%& is already unset (see the discussion of the
34616 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34617 same as LOCAL_SCAN_REJECT.
34618
34619 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34620 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34621 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34622 .endlist
34623
34624 If the message is not being received by interactive SMTP, rejections are
34625 reported by writing to &%stderr%& or by sending an email, as configured by the
34626 &%-oe%& command line options.
34627
34628
34629
34630 .section "Configuration options for local_scan()" "SECTconoptloc"
34631 .cindex "&[local_scan()]& function" "configuration options"
34632 It is possible to have option settings in the main configuration file
34633 that set values in static variables in the &[local_scan()]& module. If you
34634 want to do this, you must have the line
34635 .code
34636 LOCAL_SCAN_HAS_OPTIONS=yes
34637 .endd
34638 in your &_Local/Makefile_& when you build Exim. (This line is in
34639 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34640 file, you must define static variables to hold the option values, and a table
34641 to define them.
34642
34643 The table must be a vector called &%local_scan_options%&, of type
34644 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34645 and a pointer to the variable that holds the value. The entries must appear in
34646 alphabetical order. Following &%local_scan_options%& you must also define a
34647 variable called &%local_scan_options_count%& that contains the number of
34648 entries in the table. Here is a short example, showing two kinds of option:
34649 .code
34650 static int my_integer_option = 42;
34651 static uschar *my_string_option = US"a default string";
34652
34653 optionlist local_scan_options[] = {
34654   { "my_integer", opt_int,       &my_integer_option },
34655   { "my_string",  opt_stringptr, &my_string_option }
34656 };
34657
34658 int local_scan_options_count =
34659   sizeof(local_scan_options)/sizeof(optionlist);
34660 .endd
34661 The values of the variables can now be changed from Exim's runtime
34662 configuration file by including a local scan section as in this example:
34663 .code
34664 begin local_scan
34665 my_integer = 99
34666 my_string = some string of text...
34667 .endd
34668 The available types of option data are as follows:
34669
34670 .vlist
34671 .vitem &*opt_bool*&
34672 This specifies a boolean (true/false) option. The address should point to a
34673 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34674 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34675 whether such a variable has been set at all, you can initialize it to
34676 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34677 values.)
34678
34679 .vitem &*opt_fixed*&
34680 This specifies a fixed point number, such as is used for load averages.
34681 The address should point to a variable of type &`int`&. The value is stored
34682 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34683
34684 .vitem &*opt_int*&
34685 This specifies an integer; the address should point to a variable of type
34686 &`int`&. The value may be specified in any of the integer formats accepted by
34687 Exim.
34688
34689 .vitem &*opt_mkint*&
34690 This is the same as &%opt_int%&, except that when such a value is output in a
34691 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34692 printed with the suffix K or M.
34693
34694 .vitem &*opt_octint*&
34695 This also specifies an integer, but the value is always interpreted as an
34696 octal integer, whether or not it starts with the digit zero, and it is
34697 always output in octal.
34698
34699 .vitem &*opt_stringptr*&
34700 This specifies a string value; the address must be a pointer to a
34701 variable that points to a string (for example, of type &`uschar *`&).
34702
34703 .vitem &*opt_time*&
34704 This specifies a time interval value. The address must point to a variable of
34705 type &`int`&. The value that is placed there is a number of seconds.
34706 .endlist
34707
34708 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34709 out the values of all the &[local_scan()]& options.
34710
34711
34712
34713 .section "Available Exim variables" "SECID208"
34714 .cindex "&[local_scan()]& function" "available Exim variables"
34715 The header &_local_scan.h_& gives you access to a number of C variables. These
34716 are the only ones that are guaranteed to be maintained from release to release.
34717 Note, however, that you can obtain the value of any Exim expansion variable,
34718 including &$recipients$&, by calling &'expand_string()'&. The exported
34719 C variables are as follows:
34720
34721 .vlist
34722 .vitem &*int&~body_linecount*&
34723 This variable contains the number of lines in the message's body.
34724 It is not valid if the &%spool_files_wireformat%& option is used.
34725
34726 .vitem &*int&~body_zerocount*&
34727 This variable contains the number of binary zero bytes in the message's body.
34728 It is not valid if the &%spool_files_wireformat%& option is used.
34729
34730 .vitem &*unsigned&~int&~debug_selector*&
34731 This variable is set to zero when no debugging is taking place. Otherwise, it
34732 is a bitmap of debugging selectors. Two bits are identified for use in
34733 &[local_scan()]&; they are defined as macros:
34734
34735 .ilist
34736 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34737 testing option that is not privileged &-- any caller may set it. All the
34738 other selector bits can be set only by admin users.
34739
34740 .next
34741 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34742 by the &`+local_scan`& debug selector. It is not included in the default set
34743 of debugging bits.
34744 .endlist ilist
34745
34746 Thus, to write to the debugging output only when &`+local_scan`& has been
34747 selected, you should use code like this:
34748 .code
34749 if ((debug_selector & D_local_scan) != 0)
34750   debug_printf("xxx", ...);
34751 .endd
34752 .vitem &*uschar&~*expand_string_message*&
34753 After a failing call to &'expand_string()'& (returned value NULL), the
34754 variable &%expand_string_message%& contains the error message, zero-terminated.
34755
34756 .vitem &*header_line&~*header_list*&
34757 A pointer to a chain of header lines. The &%header_line%& structure is
34758 discussed below.
34759
34760 .vitem &*header_line&~*header_last*&
34761 A pointer to the last of the header lines.
34762
34763 .vitem &*uschar&~*headers_charset*&
34764 The value of the &%headers_charset%& configuration option.
34765
34766 .vitem &*BOOL&~host_checking*&
34767 This variable is TRUE during a host checking session that is initiated by the
34768 &%-bh%& command line option.
34769
34770 .vitem &*uschar&~*interface_address*&
34771 The IP address of the interface that received the message, as a string. This
34772 is NULL for locally submitted messages.
34773
34774 .vitem &*int&~interface_port*&
34775 The port on which this message was received. When testing with the &%-bh%&
34776 command line option, the value of this variable is -1 unless a port has been
34777 specified via the &%-oMi%& option.
34778
34779 .vitem &*uschar&~*message_id*&
34780 This variable contains Exim's message id for the incoming message (the value of
34781 &$message_exim_id$&) as a zero-terminated string.
34782
34783 .vitem &*uschar&~*received_protocol*&
34784 The name of the protocol by which the message was received.
34785
34786 .vitem &*int&~recipients_count*&
34787 The number of accepted recipients.
34788
34789 .vitem &*recipient_item&~*recipients_list*&
34790 .cindex "recipient" "adding in local scan"
34791 .cindex "recipient" "removing in local scan"
34792 The list of accepted recipients, held in a vector of length
34793 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34794 can add additional recipients by calling &'receive_add_recipient()'& (see
34795 below). You can delete recipients by removing them from the vector and
34796 adjusting the value in &%recipients_count%&. In particular, by setting
34797 &%recipients_count%& to zero you remove all recipients. If you then return the
34798 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34799 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34800 and then call &'receive_add_recipient()'& as often as needed.
34801
34802 .vitem &*uschar&~*sender_address*&
34803 The envelope sender address. For bounce messages this is the empty string.
34804
34805 .vitem &*uschar&~*sender_host_address*&
34806 The IP address of the sending host, as a string. This is NULL for
34807 locally-submitted messages.
34808
34809 .vitem &*uschar&~*sender_host_authenticated*&
34810 The name of the authentication mechanism that was used, or NULL if the message
34811 was not received over an authenticated SMTP connection.
34812
34813 .vitem &*uschar&~*sender_host_name*&
34814 The name of the sending host, if known.
34815
34816 .vitem &*int&~sender_host_port*&
34817 The port on the sending host.
34818
34819 .vitem &*BOOL&~smtp_input*&
34820 This variable is TRUE for all SMTP input, including BSMTP.
34821
34822 .vitem &*BOOL&~smtp_batched_input*&
34823 This variable is TRUE for BSMTP input.
34824
34825 .vitem &*int&~store_pool*&
34826 The contents of this variable control which pool of memory is used for new
34827 requests. See section &<<SECTmemhanloc>>& for details.
34828 .endlist
34829
34830
34831 .section "Structure of header lines" "SECID209"
34832 The &%header_line%& structure contains the members listed below.
34833 You can add additional header lines by calling the &'header_add()'& function
34834 (see below). You can cause header lines to be ignored (deleted) by setting
34835 their type to *.
34836
34837
34838 .vlist
34839 .vitem &*struct&~header_line&~*next*&
34840 A pointer to the next header line, or NULL for the last line.
34841
34842 .vitem &*int&~type*&
34843 A code identifying certain headers that Exim recognizes. The codes are printing
34844 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34845 Notice in particular that any header line whose type is * is not transmitted
34846 with the message. This flagging is used for header lines that have been
34847 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34848 lines.) Effectively, * means &"deleted"&.
34849
34850 .vitem &*int&~slen*&
34851 The number of characters in the header line, including the terminating and any
34852 internal newlines.
34853
34854 .vitem &*uschar&~*text*&
34855 A pointer to the text of the header. It always ends with a newline, followed by
34856 a zero byte. Internal newlines are preserved.
34857 .endlist
34858
34859
34860
34861 .section "Structure of recipient items" "SECID210"
34862 The &%recipient_item%& structure contains these members:
34863
34864 .vlist
34865 .vitem &*uschar&~*address*&
34866 This is a pointer to the recipient address as it was received.
34867
34868 .vitem &*int&~pno*&
34869 This is used in later Exim processing when top level addresses are created by
34870 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34871 and must always contain -1 at this stage.
34872
34873 .vitem &*uschar&~*errors_to*&
34874 If this value is not NULL, bounce messages caused by failing to deliver to the
34875 recipient are sent to the address it contains. In other words, it overrides the
34876 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34877 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34878 an unqualified address, Exim qualifies it using the domain from
34879 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34880 is NULL for all recipients.
34881 .endlist
34882
34883
34884
34885 .section "Available Exim functions" "SECID211"
34886 .cindex "&[local_scan()]& function" "available Exim functions"
34887 The header &_local_scan.h_& gives you access to a number of Exim functions.
34888 These are the only ones that are guaranteed to be maintained from release to
34889 release:
34890
34891 .vlist
34892 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34893        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34894
34895 This function creates a child process that runs the command specified by
34896 &%argv%&. The environment for the process is specified by &%envp%&, which can
34897 be NULL if no environment variables are to be passed. A new umask is supplied
34898 for the process in &%newumask%&.
34899
34900 Pipes to the standard input and output of the new process are set up
34901 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34902 standard error is cloned to the standard output. If there are any file
34903 descriptors &"in the way"& in the new process, they are closed. If the final
34904 argument is TRUE, the new process is made into a process group leader.
34905
34906 The function returns the pid of the new process, or -1 if things go wrong.
34907
34908 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34909 This function waits for a child process to terminate, or for a timeout (in
34910 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34911 return value is as follows:
34912
34913 .ilist
34914 >= 0
34915
34916 The process terminated by a normal exit and the value is the process
34917 ending status.
34918
34919 .next
34920 < 0 and > &--256
34921
34922 The process was terminated by a signal and the value is the negation of the
34923 signal number.
34924
34925 .next
34926 &--256
34927
34928 The process timed out.
34929 .next
34930 &--257
34931
34932 The was some other error in wait(); &%errno%& is still set.
34933 .endlist
34934
34935 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34936 This function provide you with a means of submitting a new message to
34937 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34938 want, but this packages it all up for you.) The function creates a pipe,
34939 forks a subprocess that is running
34940 .code
34941 exim -t -oem -oi -f <>
34942 .endd
34943 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34944 that is connected to the standard input. The yield of the function is the PID
34945 of the subprocess. You can then write a message to the file descriptor, with
34946 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34947
34948 When you have finished, call &'child_close()'& to wait for the process to
34949 finish and to collect its ending status. A timeout value of zero is usually
34950 fine in this circumstance. Unless you have made a mistake with the recipient
34951 addresses, you should get a return code of zero.
34952
34953
34954 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34955        *sender_authentication)*&
34956 This function is a more sophisticated version of &'child_open()'&. The command
34957 that it runs is:
34958 .display
34959 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34960 .endd
34961 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34962
34963
34964 .vitem &*void&~debug_printf(char&~*,&~...)*&
34965 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34966 output is written to the standard error stream. If no debugging is selected,
34967 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34968 conditional on the &`local_scan`& debug selector by coding like this:
34969 .code
34970 if ((debug_selector & D_local_scan) != 0)
34971   debug_printf("xxx", ...);
34972 .endd
34973
34974 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34975 This is an interface to Exim's string expansion code. The return value is the
34976 expanded string, or NULL if there was an expansion failure.
34977 The C variable &%expand_string_message%& contains an error message after an
34978 expansion failure. If expansion does not change the string, the return value is
34979 the pointer to the input string. Otherwise, the return value points to a new
34980 block of memory that was obtained by a call to &'store_get()'&. See section
34981 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34982
34983 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34984 This function allows you to an add additional header line at the end of the
34985 existing ones. The first argument is the type, and should normally be a space
34986 character. The second argument is a format string and any number of
34987 substitution arguments as for &[sprintf()]&. You may include internal newlines
34988 if you want, and you must ensure that the string ends with a newline.
34989
34990 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34991         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34992 This function adds a new header line at a specified point in the header
34993 chain. The header itself is specified as for &'header_add()'&.
34994
34995 If &%name%& is NULL, the new header is added at the end of the chain if
34996 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34997 NULL, the header lines are searched for the first non-deleted header that
34998 matches the name. If one is found, the new header is added before it if
34999 &%after%& is false. If &%after%& is true, the new header is added after the
35000 found header and any adjacent subsequent ones with the same name (even if
35001 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35002 option controls where the header is added. If it is true, addition is at the
35003 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35004 headers, or at the top if there are no &'Received:'& headers, you could use
35005 .code
35006 header_add_at_position(TRUE, US"Received", TRUE,
35007   ' ', "X-xxx: ...");
35008 .endd
35009 Normally, there is always at least one non-deleted &'Received:'& header, but
35010 there may not be if &%received_header_text%& expands to an empty string.
35011
35012
35013 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35014 This function removes header lines. If &%occurrence%& is zero or negative, all
35015 occurrences of the header are removed. If occurrence is greater than zero, that
35016 particular instance of the header is removed. If no header(s) can be found that
35017 match the specification, the function does nothing.
35018
35019
35020 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35021         int&~length,&~BOOL&~notdel)*&"
35022 This function tests whether the given header has the given name. It is not just
35023 a string comparison, because white space is permitted between the name and the
35024 colon. If the &%notdel%& argument is true, a false return is forced for all
35025 &"deleted"& headers; otherwise they are not treated specially. For example:
35026 .code
35027 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35028 .endd
35029 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35030 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35031 This function base64-encodes a string, which is passed by address and length.
35032 The text may contain bytes of any value, including zero. The result is passed
35033 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35034 zero-terminated.
35035
35036 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35037 This function decodes a base64-encoded string. Its arguments are a
35038 zero-terminated base64-encoded string and the address of a variable that is set
35039 to point to the result, which is in dynamic memory. The length of the decoded
35040 string is the yield of the function. If the input is invalid base64 data, the
35041 yield is -1. A zero byte is added to the end of the output string to make it
35042 easy to interpret as a C string (assuming it contains no zeros of its own). The
35043 added zero byte is not included in the returned count.
35044
35045 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35046 This function checks for a match in a domain list. Domains are always
35047 matched caselessly. The return value is one of the following:
35048 .display
35049 &`OK     `& match succeeded
35050 &`FAIL   `& match failed
35051 &`DEFER  `& match deferred
35052 .endd
35053 DEFER is usually caused by some kind of lookup defer, such as the
35054 inability to contact a database.
35055
35056 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35057         BOOL&~caseless)*&"
35058 This function checks for a match in a local part list. The third argument
35059 controls case-sensitivity. The return values are as for
35060 &'lss_match_domain()'&.
35061
35062 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35063         BOOL&~caseless)*&"
35064 This function checks for a match in an address list. The third argument
35065 controls the case-sensitivity of the local part match. The domain is always
35066 matched caselessly. The return values are as for &'lss_match_domain()'&.
35067
35068 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35069         uschar&~*list)*&"
35070 This function checks for a match in a host list. The most common usage is
35071 expected to be
35072 .code
35073 lss_match_host(sender_host_name, sender_host_address, ...)
35074 .endd
35075 .vindex "&$sender_host_address$&"
35076 An empty address field matches an empty item in the host list. If the host name
35077 is NULL, the name corresponding to &$sender_host_address$& is automatically
35078 looked up if a host name is required to match an item in the list. The return
35079 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35080 returns ERROR in the case when it had to look up a host name, but the lookup
35081 failed.
35082
35083 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35084         *format,&~...)*&"
35085 This function writes to Exim's log files. The first argument should be zero (it
35086 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35087 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35088 them. It specifies to which log or logs the message is written. The remaining
35089 arguments are a format and relevant insertion arguments. The string should not
35090 contain any newlines, not even at the end.
35091
35092
35093 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35094 This function adds an additional recipient to the message. The first argument
35095 is the recipient address. If it is unqualified (has no domain), it is qualified
35096 with the &%qualify_recipient%& domain. The second argument must always be -1.
35097
35098 This function does not allow you to specify a private &%errors_to%& address (as
35099 described with the structure of &%recipient_item%& above), because it pre-dates
35100 the addition of that field to the structure. However, it is easy to add such a
35101 value afterwards. For example:
35102 .code
35103  receive_add_recipient(US"monitor@mydom.example", -1);
35104  recipients_list[recipients_count-1].errors_to =
35105    US"postmaster@mydom.example";
35106 .endd
35107
35108 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35109 This is a convenience function to remove a named recipient from the list of
35110 recipients. It returns true if a recipient was removed, and false if no
35111 matching recipient could be found. The argument must be a complete email
35112 address.
35113 .endlist
35114
35115
35116 .cindex "RFC 2047"
35117 .vlist
35118 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35119   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35120 This function decodes strings that are encoded according to RFC 2047. Typically
35121 these are the contents of header lines. First, each &"encoded word"& is decoded
35122 from the Q or B encoding into a byte-string. Then, if provided with the name of
35123 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35124 made  to translate the result to the named character set. If this fails, the
35125 binary string is returned with an error message.
35126
35127 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35128 maximum MIME word length is enforced. The third argument is the target
35129 encoding, or NULL if no translation is wanted.
35130
35131 .cindex "binary zero" "in RFC 2047 decoding"
35132 .cindex "RFC 2047" "binary zero in"
35133 If a binary zero is encountered in the decoded string, it is replaced by the
35134 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35135 not be 0 because header lines are handled as zero-terminated strings.
35136
35137 The function returns the result of processing the string, zero-terminated; if
35138 &%lenptr%& is not NULL, the length of the result is set in the variable to
35139 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35140
35141 If an error is encountered, the function returns NULL and uses the &%error%&
35142 argument to return an error message. The variable pointed to by &%error%& is
35143 set to NULL if there is no error; it may be set non-NULL even when the function
35144 returns a non-NULL value if decoding was successful, but there was a problem
35145 with translation.
35146
35147
35148 .vitem &*int&~smtp_fflush(void)*&
35149 This function is used in conjunction with &'smtp_printf()'&, as described
35150 below.
35151
35152 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35153 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35154 output stream. You should use this function only when there is an SMTP output
35155 stream, that is, when the incoming message is being received via interactive
35156 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35157 is FALSE. If you want to test for an incoming message from another host (as
35158 opposed to a local process that used the &%-bs%& command line option), you can
35159 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35160 is involved.
35161
35162 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35163 output function, so it can be used for all forms of SMTP connection.
35164
35165 The second argument is used to request that the data be buffered
35166 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35167 This is advisory only, but likely to save on system-calls and packets
35168 sent when a sequence of calls to the function are made.
35169
35170 The argument was added in Exim version 4.90 - changing the API/ABI.
35171 Nobody noticed until 4.93 was imminent, at which point the
35172 ABI version number was incremented.
35173
35174 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35175 must start with an appropriate response code: 550 if you are going to return
35176 LOCAL_SCAN_REJECT, 451 if you are going to return
35177 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35178 initial lines of a multi-line response, the code must be followed by a hyphen
35179 to indicate that the line is not the final response line. You must also ensure
35180 that the lines you write terminate with CRLF. For example:
35181 .code
35182 smtp_printf("550-this is some extra info\r\n");
35183 return LOCAL_SCAN_REJECT;
35184 .endd
35185 Note that you can also create multi-line responses by including newlines in
35186 the data returned via the &%return_text%& argument. The added value of using
35187 &'smtp_printf()'& is that, for instance, you could introduce delays between
35188 multiple output lines.
35189
35190 The &'smtp_printf()'& function does not return any error indication, because it
35191 does not
35192 guarantee a flush of
35193 pending output, and therefore does not test
35194 the state of the stream. (In the main code of Exim, flushing and error
35195 detection is done when Exim is ready for the next SMTP input command.) If
35196 you want to flush the output and check for an error (for example, the
35197 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35198 arguments. It flushes the output stream, and returns a non-zero value if there
35199 is an error.
35200
35201 .vitem &*void&~*store_get(int,BOOL)*&
35202 This function accesses Exim's internal store (memory) manager. It gets a new
35203 chunk of memory whose size is given by the first argument.
35204 The second argument should be given as TRUE if the memory will be used for
35205 data possibly coming from an attacker (eg. the message content),
35206 FALSE if it is locally-sourced.
35207 Exim bombs out if it ever
35208 runs out of memory. See the next section for a discussion of memory handling.
35209
35210 .vitem &*void&~*store_get_perm(int,BOOL)*&
35211 This function is like &'store_get()'&, but it always gets memory from the
35212 permanent pool. See the next section for a discussion of memory handling.
35213
35214 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35215 See below.
35216
35217 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35218 See below.
35219
35220 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35221 These three functions create strings using Exim's dynamic memory facilities.
35222 The first makes a copy of an entire string. The second copies up to a maximum
35223 number of characters, indicated by the second argument. The third uses a format
35224 and insertion arguments to create a new string. In each case, the result is a
35225 pointer to a new string in the current memory pool. See the next section for
35226 more discussion.
35227 .endlist
35228
35229
35230
35231 .section "More about Exim's memory handling" "SECTmemhanloc"
35232 .cindex "&[local_scan()]& function" "memory handling"
35233 No function is provided for freeing memory, because that is never needed.
35234 The dynamic memory that Exim uses when receiving a message is automatically
35235 recycled if another message is received by the same process (this applies only
35236 to incoming SMTP connections &-- other input methods can supply only one
35237 message at a time). After receiving the last message, a reception process
35238 terminates.
35239
35240 Because it is recycled, the normal dynamic memory cannot be used for holding
35241 data that must be preserved over a number of incoming messages on the same SMTP
35242 connection. However, Exim in fact uses two pools of dynamic memory; the second
35243 one is not recycled, and can be used for this purpose.
35244
35245 If you want to allocate memory that remains available for subsequent messages
35246 in the same SMTP connection, you should set
35247 .code
35248 store_pool = POOL_PERM
35249 .endd
35250 before calling the function that does the allocation. There is no need to
35251 restore the value if you do not need to; however, if you do want to revert to
35252 the normal pool, you can either restore the previous value of &%store_pool%& or
35253 set it explicitly to POOL_MAIN.
35254
35255 The pool setting applies to all functions that get dynamic memory, including
35256 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35257 There is also a convenience function called &'store_get_perm()'& that gets a
35258 block of memory from the permanent pool while preserving the value of
35259 &%store_pool%&.
35260 .ecindex IIDlosca
35261
35262
35263
35264
35265 . ////////////////////////////////////////////////////////////////////////////
35266 . ////////////////////////////////////////////////////////////////////////////
35267
35268 .chapter "System-wide message filtering" "CHAPsystemfilter"
35269 .scindex IIDsysfil1 "filter" "system filter"
35270 .scindex IIDsysfil2 "filtering all mail"
35271 .scindex IIDsysfil3 "system filter"
35272 The previous chapters (on ACLs and the local scan function) describe checks
35273 that can be applied to messages before they are accepted by a host. There is
35274 also a mechanism for checking messages once they have been received, but before
35275 they are delivered. This is called the &'system filter'&.
35276
35277 The system filter operates in a similar manner to users' filter files, but it
35278 is run just once per message (however many recipients the message has).
35279 It should not normally be used as a substitute for routing, because &%deliver%&
35280 commands in a system router provide new envelope recipient addresses.
35281 The system filter must be an Exim filter. It cannot be a Sieve filter.
35282
35283 The system filter is run at the start of a delivery attempt, before any routing
35284 is done. If a message fails to be completely delivered at the first attempt,
35285 the system filter is run again at the start of every retry.
35286 If you want your filter to do something only once per message, you can make use
35287 of the &%first_delivery%& condition in an &%if%& command in the filter to
35288 prevent it happening on retries.
35289
35290 .vindex "&$domain$&"
35291 .vindex "&$local_part$&"
35292 &*Warning*&: Because the system filter runs just once, variables that are
35293 specific to individual recipient addresses, such as &$local_part$& and
35294 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35295 you want to run a centrally-specified filter for each recipient address
35296 independently, you can do so by setting up a suitable &(redirect)& router, as
35297 described in section &<<SECTperaddfil>>& below.
35298
35299
35300 .section "Specifying a system filter" "SECID212"
35301 .cindex "uid (user id)" "system filter"
35302 .cindex "gid (group id)" "system filter"
35303 The name of the file that contains the system filter must be specified by
35304 setting &%system_filter%&. If you want the filter to run under a uid and gid
35305 other than root, you must also set &%system_filter_user%& and
35306 &%system_filter_group%& as appropriate. For example:
35307 .code
35308 system_filter = /etc/mail/exim.filter
35309 system_filter_user = exim
35310 .endd
35311 If a system filter generates any deliveries directly to files or pipes (via the
35312 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35313 specified by setting &%system_filter_file_transport%& and
35314 &%system_filter_pipe_transport%&, respectively. Similarly,
35315 &%system_filter_reply_transport%& must be set to handle any messages generated
35316 by the &%reply%& command.
35317
35318
35319 .section "Testing a system filter" "SECID213"
35320 You can run simple tests of a system filter in the same way as for a user
35321 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35322 are permitted only in system filters are recognized.
35323
35324 If you want to test the combined effect of a system filter and a user filter,
35325 you can use both &%-bF%& and &%-bf%& on the same command line.
35326
35327
35328
35329 .section "Contents of a system filter" "SECID214"
35330 The language used to specify system filters is the same as for users' filter
35331 files. It is described in the separate end-user document &'Exim's interface to
35332 mail filtering'&. However, there are some additional features that are
35333 available only in system filters; these are described in subsequent sections.
35334 If they are encountered in a user's filter file or when testing with &%-bf%&,
35335 they cause errors.
35336
35337 .cindex "frozen messages" "manual thaw; testing in filter"
35338 There are two special conditions which, though available in users' filter
35339 files, are designed for use in system filters. The condition &%first_delivery%&
35340 is true only for the first attempt at delivering a message, and
35341 &%manually_thawed%& is true only if the message has been frozen, and
35342 subsequently thawed by an admin user. An explicit forced delivery counts as a
35343 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35344
35345 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35346 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35347 succeed, it will not be tried again.
35348 If you want Exim to retry an unseen delivery until it succeeds, you should
35349 arrange to set it up every time the filter runs.
35350
35351 When a system filter finishes running, the values of the variables &$n0$& &--
35352 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35353 users' filter files. Thus a system filter can, for example, set up &"scores"&
35354 to which users' filter files can refer.
35355
35356
35357
35358 .section "Additional variable for system filters" "SECID215"
35359 .vindex "&$recipients$&"
35360 The expansion variable &$recipients$&, containing a list of all the recipients
35361 of the message (separated by commas and white space), is available in system
35362 filters. It is not available in users' filters for privacy reasons.
35363
35364
35365
35366 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35367 .cindex "freezing messages"
35368 .cindex "message" "freezing"
35369 .cindex "message" "forced failure"
35370 .cindex "&%fail%&" "in system filter"
35371 .cindex "&%freeze%& in system filter"
35372 .cindex "&%defer%& in system filter"
35373 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35374 always available in system filters, but are not normally enabled in users'
35375 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35376 for the &(redirect)& router.) These commands can optionally be followed by the
35377 word &%text%& and a string containing an error message, for example:
35378 .code
35379 fail text "this message looks like spam to me"
35380 .endd
35381 The keyword &%text%& is optional if the next character is a double quote.
35382
35383 The &%defer%& command defers delivery of the original recipients of the
35384 message. The &%fail%& command causes all the original recipients to be failed,
35385 and a bounce message to be created. The &%freeze%& command suspends all
35386 delivery attempts for the original recipients. In all cases, any new deliveries
35387 that are specified by the filter are attempted as normal after the filter has
35388 run.
35389
35390 The &%freeze%& command is ignored if the message has been manually unfrozen and
35391 not manually frozen since. This means that automatic freezing by a system
35392 filter can be used as a way of checking out suspicious messages. If a message
35393 is found to be all right, manually unfreezing it allows it to be delivered.
35394
35395 .cindex "log" "&%fail%& command log line"
35396 .cindex "&%fail%&" "log line; reducing"
35397 The text given with a fail command is used as part of the bounce message as
35398 well as being written to the log. If the message is quite long, this can fill
35399 up a lot of log space when such failures are common. To reduce the size of the
35400 log message, Exim interprets the text in a special way if it starts with the
35401 two characters &`<<`& and contains &`>>`& later. The text between these two
35402 strings is written to the log, and the rest of the text is used in the bounce
35403 message. For example:
35404 .code
35405 fail "<<filter test 1>>Your message is rejected \
35406      because it contains attachments that we are \
35407      not prepared to receive."
35408 .endd
35409
35410 .cindex "loop" "caused by &%fail%&"
35411 Take great care with the &%fail%& command when basing the decision to fail on
35412 the contents of the message, because the bounce message will of course include
35413 the contents of the original message and will therefore trigger the &%fail%&
35414 command again (causing a mail loop) unless steps are taken to prevent this.
35415 Testing the &%error_message%& condition is one way to prevent this. You could
35416 use, for example
35417 .code
35418 if $message_body contains "this is spam" and not error_message
35419 then fail text "spam is not wanted here" endif
35420 .endd
35421 though of course that might let through unwanted bounce messages. The
35422 alternative is clever checking of the body and/or headers to detect bounces
35423 generated by the filter.
35424
35425 The interpretation of a system filter file ceases after a
35426 &%defer%&,
35427 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35428 set up earlier in the filter file are honoured, so you can use a sequence such
35429 as
35430 .code
35431 mail ...
35432 freeze
35433 .endd
35434 to send a specified message when the system filter is freezing (or deferring or
35435 failing) a message. The normal deliveries for the message do not, of course,
35436 take place.
35437
35438
35439
35440 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35441 .cindex "header lines" "adding; in system filter"
35442 .cindex "header lines" "removing; in system filter"
35443 .cindex "filter" "header lines; adding/removing"
35444 Two filter commands that are available only in system filters are:
35445 .code
35446 headers add <string>
35447 headers remove <string>
35448 .endd
35449 The argument for the &%headers add%& is a string that is expanded and then
35450 added to the end of the message's headers. It is the responsibility of the
35451 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35452 space is ignored, and if the string is otherwise empty, or if the expansion is
35453 forced to fail, the command has no effect.
35454
35455 You can use &"\n"& within the string, followed by white space, to specify
35456 continued header lines. More than one header may be added in one command by
35457 including &"\n"& within the string without any following white space. For
35458 example:
35459 .code
35460 headers add "X-header-1: ....\n  \
35461              continuation of X-header-1 ...\n\
35462              X-header-2: ...."
35463 .endd
35464 Note that the header line continuation white space after the first newline must
35465 be placed before the backslash that continues the input string, because white
35466 space after input continuations is ignored.
35467
35468 The argument for &%headers remove%& is a colon-separated list of header names.
35469 This command applies only to those headers that are stored with the message;
35470 those that are added at delivery time (such as &'Envelope-To:'& and
35471 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35472 header with the same name, they are all removed.
35473
35474 The &%headers%& command in a system filter makes an immediate change to the set
35475 of header lines that was received with the message (with possible additions
35476 from ACL processing). Subsequent commands in the system filter operate on the
35477 modified set, which also forms the basis for subsequent message delivery.
35478 Unless further modified during routing or transporting, this set of headers is
35479 used for all recipients of the message.
35480
35481 During routing and transporting, the variables that refer to the contents of
35482 header lines refer only to those lines that are in this set. Thus, header lines
35483 that are added by a system filter are visible to users' filter files and to all
35484 routers and transports. This contrasts with the manipulation of header lines by
35485 routers and transports, which is not immediate, but which instead is saved up
35486 until the message is actually being written (see section
35487 &<<SECTheadersaddrem>>&).
35488
35489 If the message is not delivered at the first attempt, header lines that were
35490 added by the system filter are stored with the message, and so are still
35491 present at the next delivery attempt. Header lines that were removed are still
35492 present, but marked &"deleted"& so that they are not transported with the
35493 message. For this reason, it is usual to make the &%headers%& command
35494 conditional on &%first_delivery%& so that the set of header lines is not
35495 modified more than once.
35496
35497 Because header modification in a system filter acts immediately, you have to
35498 use an indirect approach if you want to modify the contents of a header line.
35499 For example:
35500 .code
35501 headers add "Old-Subject: $h_subject:"
35502 headers remove "Subject"
35503 headers add "Subject: new subject (was: $h_old-subject:)"
35504 headers remove "Old-Subject"
35505 .endd
35506
35507
35508
35509 .section "Setting an errors address in a system filter" "SECID217"
35510 .cindex "envelope from"
35511 .cindex "envelope sender"
35512 In a system filter, if a &%deliver%& command is followed by
35513 .code
35514 errors_to <some address>
35515 .endd
35516 in order to change the envelope sender (and hence the error reporting) for that
35517 delivery, any address may be specified. (In a user filter, only the current
35518 user's address can be set.) For example, if some mail is being monitored, you
35519 might use
35520 .code
35521 unseen deliver monitor@spying.example errors_to root@local.example
35522 .endd
35523 to take a copy which would not be sent back to the normal error reporting
35524 address if its delivery failed.
35525
35526
35527
35528 .section "Per-address filtering" "SECTperaddfil"
35529 .vindex "&$domain_data$&"
35530 .vindex "&$local_part_data$&"
35531 In contrast to the system filter, which is run just once per message for each
35532 delivery attempt, it is also possible to set up a system-wide filtering
35533 operation that runs once for each recipient address. In this case, variables
35534 such as &$local_part_data$& and &$domain_data$& can be used,
35535 and indeed, the choice of filter file could be made dependent on them.
35536 This is an example of a router which implements such a filter:
35537 .code
35538 central_filter:
35539   check_local_user
35540   driver = redirect
35541   domains = +local_domains
35542   file = /central/filters/$local_part_data
35543   no_verify
35544   allow_filter
35545   allow_freeze
35546 .endd
35547 The filter is run in a separate process under its own uid. Therefore, either
35548 &%check_local_user%& must be set (as above), in which case the filter is run as
35549 the local user, or the &%user%& option must be used to specify which user to
35550 use. If both are set, &%user%& overrides.
35551
35552 Care should be taken to ensure that none of the commands in the filter file
35553 specify a significant delivery if the message is to go on to be delivered to
35554 its intended recipient. The router will not then claim to have dealt with the
35555 address, so it will be passed on to subsequent routers to be delivered in the
35556 normal way.
35557 .ecindex IIDsysfil1
35558 .ecindex IIDsysfil2
35559 .ecindex IIDsysfil3
35560
35561
35562
35563
35564
35565
35566 . ////////////////////////////////////////////////////////////////////////////
35567 . ////////////////////////////////////////////////////////////////////////////
35568
35569 .chapter "Message processing" "CHAPmsgproc"
35570 .scindex IIDmesproc "message" "general processing"
35571 Exim performs various transformations on the sender and recipient addresses of
35572 all messages that it handles, and also on the messages' header lines. Some of
35573 these are optional and configurable, while others always take place. All of
35574 this processing, except rewriting as a result of routing, and the addition or
35575 removal of header lines while delivering, happens when a message is received,
35576 before it is placed on Exim's queue.
35577
35578 Some of the automatic processing takes place by default only for
35579 &"locally-originated"& messages. This adjective is used to describe messages
35580 that are not received over TCP/IP, but instead are passed to an Exim process on
35581 its standard input. This includes the interactive &"local SMTP"& case that is
35582 set up by the &%-bs%& command line option.
35583
35584 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35585 or ::1) are not considered to be locally-originated. Exim does not treat the
35586 loopback interface specially in any way.
35587
35588 If you want the loopback interface to be treated specially, you must ensure
35589 that there are appropriate entries in your ACLs.
35590
35591
35592
35593
35594 .section "Submission mode for non-local messages" "SECTsubmodnon"
35595 .cindex "message" "submission"
35596 .cindex "submission mode"
35597 Processing that happens automatically for locally-originated messages (unless
35598 &%suppress_local_fixups%& is set) can also be requested for messages that are
35599 received over TCP/IP. The term &"submission mode"& is used to describe this
35600 state. Submission mode is set by the modifier
35601 .code
35602 control = submission
35603 .endd
35604 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35605 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35606 a local submission, and is normally used when the source of the message is
35607 known to be an MUA running on a client host (as opposed to an MTA). For
35608 example, to set submission mode for messages originating on the IPv4 loopback
35609 interface, you could include the following in the MAIL ACL:
35610 .code
35611 warn  hosts = 127.0.0.1
35612       control = submission
35613 .endd
35614 .cindex "&%sender_retain%& submission option"
35615 There are some options that can be used when setting submission mode. A slash
35616 is used to separate options. For example:
35617 .code
35618 control = submission/sender_retain
35619 .endd
35620 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35621 true and &%local_from_check%& false for the current incoming message. The first
35622 of these allows an existing &'Sender:'& header in the message to remain, and
35623 the second suppresses the check to ensure that &'From:'& matches the
35624 authenticated sender. With this setting, Exim still fixes up messages by adding
35625 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35626 attempt to check sender authenticity in header lines.
35627
35628 When &%sender_retain%& is not set, a submission mode setting may specify a
35629 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35630 example:
35631 .code
35632 control = submission/domain=some.domain
35633 .endd
35634 The domain may be empty. How this value is used is described in sections
35635 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35636 that allows you to specify the user's full name for inclusion in a created
35637 &'Sender:'& or &'From:'& header line. For example:
35638 .code
35639 accept authenticated = *
35640        control = submission/domain=wonderland.example/\
35641                             name=${lookup {$authenticated_id} \
35642                                    lsearch {/etc/exim/namelist}}
35643 .endd
35644 Because the name may contain any characters, including slashes, the &%name%&
35645 option must be given last. The remainder of the string is used as the name. For
35646 the example above, if &_/etc/exim/namelist_& contains:
35647 .code
35648 bigegg:  Humpty Dumpty
35649 .endd
35650 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35651 line would be:
35652 .code
35653 Sender: Humpty Dumpty <bigegg@wonderland.example>
35654 .endd
35655 .cindex "return path" "in submission mode"
35656 By default, submission mode forces the return path to the same address as is
35657 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35658 specified, the return path is also left unchanged.
35659
35660 &*Note*&: The changes caused by submission mode take effect after the predata
35661 ACL. This means that any sender checks performed before the fix-ups use the
35662 untrusted sender address specified by the user, not the trusted sender address
35663 specified by submission mode. Although this might be slightly unexpected, it
35664 does mean that you can configure ACL checks to spot that a user is trying to
35665 spoof another's address.
35666
35667 .section "Line endings" "SECTlineendings"
35668 .cindex "line endings"
35669 .cindex "carriage return"
35670 .cindex "linefeed"
35671 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35672 linefeed) is the line ending for messages transmitted over the Internet using
35673 SMTP over TCP/IP. However, within individual operating systems, different
35674 conventions are used. For example, Unix-like systems use just LF, but others
35675 use CRLF or just CR.
35676
35677 Exim was designed for Unix-like systems, and internally, it stores messages
35678 using the system's convention of a single LF as a line terminator. When
35679 receiving a message, all line endings are translated to this standard format.
35680 Originally, it was thought that programs that passed messages directly to an
35681 MTA within an operating system would use that system's convention. Experience
35682 has shown that this is not the case; for example, there are Unix applications
35683 that use CRLF in this circumstance. For this reason, and for compatibility with
35684 other MTAs, the way Exim handles line endings for all messages is now as
35685 follows:
35686
35687 .ilist
35688 LF not preceded by CR is treated as a line ending.
35689 .next
35690 CR is treated as a line ending; if it is immediately followed by LF, the LF
35691 is ignored.
35692 .next
35693 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35694 nor a local message in the state where a line containing only a dot is a
35695 terminator.
35696 .next
35697 If a bare CR is encountered within a header line, an extra space is added after
35698 the line terminator so as not to end the header line. The reasoning behind this
35699 is that bare CRs in header lines are most likely either to be mistakes, or
35700 people trying to play silly games.
35701 .next
35702 If the first header line received in a message ends with CRLF, a subsequent
35703 bare LF in a header line is treated in the same way as a bare CR in a header
35704 line.
35705 .endlist
35706
35707
35708
35709
35710
35711 .section "Unqualified addresses" "SECID218"
35712 .cindex "unqualified addresses"
35713 .cindex "address" "qualification"
35714 By default, Exim expects every envelope address it receives from an external
35715 host to be fully qualified. Unqualified addresses cause negative responses to
35716 SMTP commands. However, because SMTP is used as a means of transporting
35717 messages from MUAs running on personal workstations, there is sometimes a
35718 requirement to accept unqualified addresses from specific hosts or IP networks.
35719
35720 Exim has two options that separately control which hosts may send unqualified
35721 sender or recipient addresses in SMTP commands, namely
35722 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35723 cases, if an unqualified address is accepted, it is qualified by adding the
35724 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35725
35726 .oindex "&%qualify_domain%&"
35727 .oindex "&%qualify_recipient%&"
35728 Unqualified addresses in header lines are automatically qualified for messages
35729 that are locally originated, unless the &%-bnq%& option is given on the command
35730 line. For messages received over SMTP, unqualified addresses in header lines
35731 are qualified only if unqualified addresses are permitted in SMTP commands. In
35732 other words, such qualification is also controlled by
35733 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35734
35735
35736
35737
35738 .section "The UUCP From line" "SECID219"
35739 .cindex "&""From""& line"
35740 .cindex "UUCP" "&""From""& line"
35741 .cindex "sender" "address"
35742 .oindex "&%uucp_from_pattern%&"
35743 .oindex "&%uucp_from_sender%&"
35744 .cindex "envelope from"
35745 .cindex "envelope sender"
35746 .cindex "Sendmail compatibility" "&""From""& line"
35747 Messages that have come from UUCP (and some other applications) often begin
35748 with a line containing the envelope sender and a timestamp, following the word
35749 &"From"&. Examples of two common formats are:
35750 .code
35751 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35752 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35753 .endd
35754 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35755 Exim recognizes such lines at the start of messages that are submitted to it
35756 via the command line (that is, on the standard input). It does not recognize
35757 such lines in incoming SMTP messages, unless the sending host matches
35758 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35759 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35760 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35761 default value matches the two common cases shown above and puts the address
35762 that follows &"From"& into &$1$&.
35763
35764 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35765 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35766 a trusted user, the message's sender address is constructed by expanding the
35767 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35768 then parsed as an RFC 2822 address. If there is no domain, the local part is
35769 qualified with &%qualify_domain%& unless it is the empty string. However, if
35770 the command line &%-f%& option is used, it overrides the &"From"& line.
35771
35772 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35773 sender address is not changed. This is also the case for incoming SMTP messages
35774 that are permitted to contain &"From"& lines.
35775
35776 Only one &"From"& line is recognized. If there is more than one, the second is
35777 treated as a data line that starts the body of the message, as it is not valid
35778 as a header line. This also happens if a &"From"& line is present in an
35779 incoming SMTP message from a source that is not permitted to send them.
35780
35781
35782
35783 .section "Resent- header lines" "SECID220"
35784 .cindex "&%Resent-%& header lines"
35785 .cindex "header lines" "Resent-"
35786 RFC 2822 makes provision for sets of header lines starting with the string
35787 &`Resent-`& to be added to a message when it is resent by the original
35788 recipient to somebody else. These headers are &'Resent-Date:'&,
35789 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35790 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35791
35792 .blockquote
35793 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35794 processing of replies or other such automatic actions on messages.'&
35795 .endblockquote
35796
35797 This leaves things a bit vague as far as other processing actions such as
35798 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35799 follows:
35800
35801 .ilist
35802 A &'Resent-From:'& line that just contains the login id of the submitting user
35803 is automatically rewritten in the same way as &'From:'& (see below).
35804 .next
35805 If there's a rewriting rule for a particular header line, it is also applied to
35806 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35807 &'From:'& also rewrites &'Resent-From:'&.
35808 .next
35809 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35810 also removed.
35811 .next
35812 For a locally-submitted message,
35813 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35814 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35815 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35816 included in log lines in this case.
35817 .next
35818 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35819 &%Resent-%& header lines are present.
35820 .endlist
35821
35822
35823
35824
35825 .section "The Auto-Submitted: header line" "SECID221"
35826 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35827 includes the header line:
35828 .code
35829 Auto-Submitted: auto-replied
35830 .endd
35831
35832 .section "The Bcc: header line" "SECID222"
35833 .cindex "&'Bcc:'& header line"
35834 If Exim is called with the &%-t%& option, to take recipient addresses from a
35835 message's header, it removes any &'Bcc:'& header line that may exist (after
35836 extracting its addresses). If &%-t%& is not present on the command line, any
35837 existing &'Bcc:'& is not removed.
35838
35839
35840 .section "The Date: header line" "SECID223"
35841 .cindex "&'Date:'& header line"
35842 .cindex "header lines" "Date:"
35843 If a locally-generated or submission-mode message has no &'Date:'& header line,
35844 Exim adds one, using the current date and time, unless the
35845 &%suppress_local_fixups%& control has been specified.
35846
35847 .section "The Delivery-date: header line" "SECID224"
35848 .cindex "&'Delivery-date:'& header line"
35849 .oindex "&%delivery_date_remove%&"
35850 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35851 set. Exim can be configured to add them to the final delivery of messages. (See
35852 the generic &%delivery_date_add%& transport option.) They should not be present
35853 in messages in transit. If the &%delivery_date_remove%& configuration option is
35854 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35855 messages.
35856
35857
35858 .section "The Envelope-to: header line" "SECID225"
35859 .cindex "&'Envelope-to:'& header line"
35860 .cindex "header lines" "Envelope-to:"
35861 .oindex "&%envelope_to_remove%&"
35862 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35863 Exim can be configured to add them to the final delivery of messages. (See the
35864 generic &%envelope_to_add%& transport option.) They should not be present in
35865 messages in transit. If the &%envelope_to_remove%& configuration option is set
35866 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35867 messages.
35868
35869
35870 .section "The From: header line" "SECTthefrohea"
35871 .cindex "&'From:'& header line"
35872 .cindex "header lines" "From:"
35873 .cindex "Sendmail compatibility" "&""From""& line"
35874 .cindex "message" "submission"
35875 .cindex "submission mode"
35876 If a submission-mode message does not contain a &'From:'& header line, Exim
35877 adds one if either of the following conditions is true:
35878
35879 .ilist
35880 The envelope sender address is not empty (that is, this is not a bounce
35881 message). The added header line copies the envelope sender address.
35882 .next
35883 .vindex "&$authenticated_id$&"
35884 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35885 .olist
35886 .vindex "&$qualify_domain$&"
35887 If no domain is specified by the submission control, the local part is
35888 &$authenticated_id$& and the domain is &$qualify_domain$&.
35889 .next
35890 If a non-empty domain is specified by the submission control, the local
35891 part is &$authenticated_id$&, and the domain is the specified domain.
35892 .next
35893 If an empty domain is specified by the submission control,
35894 &$authenticated_id$& is assumed to be the complete address.
35895 .endlist
35896 .endlist
35897
35898 A non-empty envelope sender takes precedence.
35899
35900 If a locally-generated incoming message does not contain a &'From:'& header
35901 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35902 containing the sender's address. The calling user's login name and full name
35903 are used to construct the address, as described in section &<<SECTconstr>>&.
35904 They are obtained from the password data by calling &[getpwuid()]& (but see the
35905 &%unknown_login%& configuration option). The address is qualified with
35906 &%qualify_domain%&.
35907
35908 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35909 &'From:'& header line containing just the unqualified login name of the calling
35910 user, this is replaced by an address containing the user's login name and full
35911 name as described in section &<<SECTconstr>>&.
35912
35913
35914 .section "The Message-ID: header line" "SECID226"
35915 .cindex "&'Message-ID:'& header line"
35916 .cindex "header lines" "Message-ID:"
35917 .cindex "message" "submission"
35918 .oindex "&%message_id_header_text%&"
35919 If a locally-generated or submission-mode incoming message does not contain a
35920 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35921 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35922 to the message. If there are any &'Resent-:'& headers in the message, it
35923 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35924 message id, preceded by the letter E to ensure it starts with a letter, and
35925 followed by @ and the primary host name. Additional information can be included
35926 in this header line by setting the &%message_id_header_text%& and/or
35927 &%message_id_header_domain%& options.
35928
35929
35930 .section "The Received: header line" "SECID227"
35931 .cindex "&'Received:'& header line"
35932 .cindex "header lines" "Received:"
35933 A &'Received:'& header line is added at the start of every message. The
35934 contents are defined by the &%received_header_text%& configuration option, and
35935 Exim automatically adds a semicolon and a timestamp to the configured string.
35936
35937 The &'Received:'& header is generated as soon as the message's header lines
35938 have been received. At this stage, the timestamp in the &'Received:'& header
35939 line is the time that the message started to be received. This is the value
35940 that is seen by the DATA ACL and by the &[local_scan()]& function.
35941
35942 Once a message is accepted, the timestamp in the &'Received:'& header line is
35943 changed to the time of acceptance, which is (apart from a small delay while the
35944 -H spool file is written) the earliest time at which delivery could start.
35945
35946
35947 .section "The References: header line" "SECID228"
35948 .cindex "&'References:'& header line"
35949 .cindex "header lines" "References:"
35950 Messages created by the &(autoreply)& transport include a &'References:'&
35951 header line. This is constructed according to the rules that are described in
35952 section 3.64 of RFC 2822 (which states that replies should contain such a
35953 header line), and section 3.14 of RFC 3834 (which states that automatic
35954 responses are not different in this respect). However, because some mail
35955 processing software does not cope well with very long header lines, no more
35956 than 12 message IDs are copied from the &'References:'& header line in the
35957 incoming message. If there are more than 12, the first one and then the final
35958 11 are copied, before adding the message ID of the incoming message.
35959
35960
35961
35962 .section "The Return-path: header line" "SECID229"
35963 .cindex "&'Return-path:'& header line"
35964 .cindex "header lines" "Return-path:"
35965 .oindex "&%return_path_remove%&"
35966 &'Return-path:'& header lines are defined as something an MTA may insert when
35967 it does the final delivery of messages. (See the generic &%return_path_add%&
35968 transport option.) Therefore, they should not be present in messages in
35969 transit. If the &%return_path_remove%& configuration option is set (the
35970 default), Exim removes &'Return-path:'& header lines from incoming messages.
35971
35972
35973
35974 .section "The Sender: header line" "SECTthesenhea"
35975 .cindex "&'Sender:'& header line"
35976 .cindex "message" "submission"
35977 .cindex "header lines" "Sender:"
35978 For a locally-originated message from an untrusted user, Exim may remove an
35979 existing &'Sender:'& header line, and it may add a new one. You can modify
35980 these actions by setting the &%local_sender_retain%& option true, the
35981 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35982 control setting.
35983
35984 When a local message is received from an untrusted user and
35985 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35986 control has not been set, a check is made to see if the address given in the
35987 &'From:'& header line is the correct (local) sender of the message. The address
35988 that is expected has the login name as the local part and the value of
35989 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35990 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35991 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35992 line is added to the message.
35993
35994 If you set &%local_from_check%& false, this checking does not occur. However,
35995 the removal of an existing &'Sender:'& line still happens, unless you also set
35996 &%local_sender_retain%& to be true. It is not possible to set both of these
35997 options true at the same time.
35998
35999 .cindex "submission mode"
36000 By default, no processing of &'Sender:'& header lines is done for messages
36001 received over TCP/IP or for messages submitted by trusted users. However, when
36002 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36003 not specified on the submission control, the following processing takes place:
36004
36005 .vindex "&$authenticated_id$&"
36006 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36007 authenticated, and &$authenticated_id$& is not empty, a sender address is
36008 created as follows:
36009
36010 .ilist
36011 .vindex "&$qualify_domain$&"
36012 If no domain is specified by the submission control, the local part is
36013 &$authenticated_id$& and the domain is &$qualify_domain$&.
36014 .next
36015 If a non-empty domain is specified by the submission control, the local part
36016 is &$authenticated_id$&, and the domain is the specified domain.
36017 .next
36018 If an empty domain is specified by the submission control,
36019 &$authenticated_id$& is assumed to be the complete address.
36020 .endlist
36021
36022 This address is compared with the address in the &'From:'& header line. If they
36023 are different, a &'Sender:'& header line containing the created address is
36024 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36025 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36026
36027 .cindex "return path" "created from &'Sender:'&"
36028 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36029 the message (the envelope sender address) is changed to be the same address,
36030 except in the case of submission mode when &%sender_retain%& is specified.
36031
36032
36033
36034 .section "Adding and removing header lines in routers and transports" &&&
36035          "SECTheadersaddrem"
36036 .cindex "header lines" "adding; in router or transport"
36037 .cindex "header lines" "removing; in router or transport"
36038 When a message is delivered, the addition and removal of header lines can be
36039 specified in a system filter, or on any of the routers and transports that
36040 process the message. Section &<<SECTaddremheasys>>& contains details about
36041 modifying headers in a system filter. Header lines can also be added in an ACL
36042 as a message is received (see section &<<SECTaddheadacl>>&).
36043
36044 In contrast to what happens in a system filter, header modifications that are
36045 specified on routers and transports apply only to the particular recipient
36046 addresses that are being processed by those routers and transports. These
36047 changes do not actually take place until a copy of the message is being
36048 transported. Therefore, they do not affect the basic set of header lines, and
36049 they do not affect the values of the variables that refer to header lines.
36050
36051 &*Note*&: In particular, this means that any expansions in the configuration of
36052 the transport cannot refer to the modified header lines, because such
36053 expansions all occur before the message is actually transported.
36054
36055 For both routers and transports, the argument of a &%headers_add%&
36056 option must be in the form of one or more RFC 2822 header lines, separated by
36057 newlines (coded as &"\n"&). For example:
36058 .code
36059 headers_add = X-added-header: added by $primary_hostname\n\
36060               X-added-second: another added header line
36061 .endd
36062 Exim does not check the syntax of these added header lines.
36063
36064 Multiple &%headers_add%& options for a single router or transport can be
36065 specified; the values will append to a single list of header lines.
36066 Each header-line is separately expanded.
36067
36068 The argument of a &%headers_remove%& option must consist of a colon-separated
36069 list of header names. This is confusing, because header names themselves are
36070 often terminated by colons. In this case, the colons are the list separators,
36071 not part of the names. For example:
36072 .code
36073 headers_remove = return-receipt-to:acknowledge-to
36074 .endd
36075
36076 Multiple &%headers_remove%& options for a single router or transport can be
36077 specified; the arguments will append to a single header-names list.
36078 Each item is separately expanded.
36079 Note that colons in complex expansions which are used to
36080 form all or part of a &%headers_remove%& list
36081 will act as list separators.
36082
36083 When &%headers_add%& or &%headers_remove%& is specified on a router,
36084 items are expanded at routing time,
36085 and then associated with all addresses that are
36086 accepted by that router, and also with any new addresses that it generates. If
36087 an address passes through several routers as a result of aliasing or
36088 forwarding, the changes are cumulative.
36089
36090 .oindex "&%unseen%&"
36091 However, this does not apply to multiple routers that result from the use of
36092 the &%unseen%& option. Any header modifications that were specified by the
36093 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36094
36095 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36096 settings cannot be delivered together in a batch, so a transport is always
36097 dealing with a set of addresses that have the same header-processing
36098 requirements.
36099
36100 The transport starts by writing the original set of header lines that arrived
36101 with the message, possibly modified by the system filter. As it writes out
36102 these lines, it consults the list of header names that were attached to the
36103 recipient address(es) by &%headers_remove%& options in routers, and it also
36104 consults the transport's own &%headers_remove%& option. Header lines whose
36105 names are on either of these lists are not written out. If there are multiple
36106 instances of any listed header, they are all skipped.
36107
36108 After the remaining original header lines have been written, new header
36109 lines that were specified by routers' &%headers_add%& options are written, in
36110 the order in which they were attached to the address. These are followed by any
36111 header lines specified by the transport's &%headers_add%& option.
36112
36113 This way of handling header line modifications in routers and transports has
36114 the following consequences:
36115
36116 .ilist
36117 The original set of header lines, possibly modified by the system filter,
36118 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36119 to it, at all times.
36120 .next
36121 Header lines that are added by a router's
36122 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36123 expansion syntax in subsequent routers or the transport.
36124 .next
36125 Conversely, header lines that are specified for removal by &%headers_remove%&
36126 in a router remain visible to subsequent routers and the transport.
36127 .next
36128 Headers added to an address by &%headers_add%& in a router cannot be removed by
36129 a later router or by a transport.
36130 .next
36131 An added header can refer to the contents of an original header that is to be
36132 removed, even it has the same name as the added header. For example:
36133 .code
36134 headers_remove = subject
36135 headers_add = Subject: new subject (was: $h_subject:)
36136 .endd
36137 .endlist
36138
36139 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36140 for a &(redirect)& router that has the &%one_time%& option set.
36141
36142
36143
36144
36145
36146 .section "Constructed addresses" "SECTconstr"
36147 .cindex "address" "constructed"
36148 .cindex "constructed address"
36149 When Exim constructs a sender address for a locally-generated message, it uses
36150 the form
36151 .display
36152 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36153 .endd
36154 For example:
36155 .code
36156 Zaphod Beeblebrox <zaphod@end.univ.example>
36157 .endd
36158 The user name is obtained from the &%-F%& command line option if set, or
36159 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36160 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36161 ampersand character, this is replaced by the login name with the first letter
36162 upper cased, as is conventional in a number of operating systems. See the
36163 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36164 The &%unknown_username%& option can be used to specify user names in cases when
36165 there is no password file entry.
36166
36167 .cindex "RFC 2047"
36168 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36169 parts of it if necessary. In addition, if it contains any non-printing
36170 characters, it is encoded as described in RFC 2047, which defines a way of
36171 including non-ASCII characters in header lines. The value of the
36172 &%headers_charset%& option specifies the name of the encoding that is used (the
36173 characters are assumed to be in this encoding). The setting of
36174 &%print_topbitchars%& controls whether characters with the top bit set (that
36175 is, with codes greater than 127) count as printing characters or not.
36176
36177
36178
36179 .section "Case of local parts" "SECID230"
36180 .cindex "case of local parts"
36181 .cindex "local part" "case of"
36182 RFC 2822 states that the case of letters in the local parts of addresses cannot
36183 be assumed to be non-significant. Exim preserves the case of local parts of
36184 addresses, but by default it uses a lower-cased form when it is routing,
36185 because on most Unix systems, usernames are in lower case and case-insensitive
36186 routing is required. However, any particular router can be made to use the
36187 original case for local parts by setting the &%caseful_local_part%& generic
36188 router option.
36189
36190 .cindex "mixed-case login names"
36191 If you must have mixed-case user names on your system, the best way to proceed,
36192 assuming you want case-independent handling of incoming email, is to set up
36193 your first router to convert incoming local parts in your domains to the
36194 correct case by means of a file lookup. For example:
36195 .code
36196 correct_case:
36197   driver = redirect
36198   domains = +local_domains
36199   data = ${lookup{$local_part}cdb\
36200               {/etc/usercased.cdb}{$value}fail}\
36201               @$domain
36202 .endd
36203 For this router, the local part is forced to lower case by the default action
36204 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36205 up a new local part in the correct case. If you then set &%caseful_local_part%&
36206 on any subsequent routers which process your domains, they will operate on
36207 local parts with the correct case in a case-sensitive manner.
36208
36209
36210
36211 .section "Dots in local parts" "SECID231"
36212 .cindex "dot" "in local part"
36213 .cindex "local part" "dots in"
36214 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36215 part may not begin or end with a dot, nor have two consecutive dots in the
36216 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36217 empty components for compatibility.
36218
36219
36220
36221 .section "Rewriting addresses" "SECID232"
36222 .cindex "rewriting" "addresses"
36223 Rewriting of sender and recipient addresses, and addresses in headers, can
36224 happen automatically, or as the result of configuration options, as described
36225 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36226 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36227
36228 Automatic rewriting includes qualification, as mentioned above. The other case
36229 in which it can happen is when an incomplete non-local domain is given. The
36230 routing process may cause this to be expanded into the full domain name. For
36231 example, a header such as
36232 .code
36233 To: hare@teaparty
36234 .endd
36235 might get rewritten as
36236 .code
36237 To: hare@teaparty.wonderland.fict.example
36238 .endd
36239 Rewriting as a result of routing is the one kind of message processing that
36240 does not happen at input time, as it cannot be done until the address has
36241 been routed.
36242
36243 Strictly, one should not do &'any'& deliveries of a message until all its
36244 addresses have been routed, in case any of the headers get changed as a
36245 result of routing. However, doing this in practice would hold up many
36246 deliveries for unreasonable amounts of time, just because one address could not
36247 immediately be routed. Exim therefore does not delay other deliveries when
36248 routing of one or more addresses is deferred.
36249 .ecindex IIDmesproc
36250
36251
36252
36253 . ////////////////////////////////////////////////////////////////////////////
36254 . ////////////////////////////////////////////////////////////////////////////
36255
36256 .chapter "SMTP processing" "CHAPSMTP"
36257 .scindex IIDsmtpproc1 "SMTP" "processing details"
36258 .scindex IIDsmtpproc2 "LMTP" "processing details"
36259 Exim supports a number of different ways of using the SMTP protocol, and its
36260 LMTP variant, which is an interactive protocol for transferring messages into a
36261 closed mail store application. This chapter contains details of how SMTP is
36262 processed. For incoming mail, the following are available:
36263
36264 .ilist
36265 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36266 .next
36267 SMTP over the standard input and output (the &%-bs%& option);
36268 .next
36269 Batched SMTP on the standard input (the &%-bS%& option).
36270 .endlist
36271
36272 For mail delivery, the following are available:
36273
36274 .ilist
36275 SMTP over TCP/IP (the &(smtp)& transport);
36276 .next
36277 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36278 &"lmtp"&);
36279 .next
36280 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36281 transport);
36282 .next
36283 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36284 the &%use_bsmtp%& option set).
36285 .endlist
36286
36287 &'Batched SMTP'& is the name for a process in which batches of messages are
36288 stored in or read from files (or pipes), in a format in which SMTP commands are
36289 used to contain the envelope information.
36290
36291
36292
36293 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36294 .cindex "SMTP" "outgoing over TCP/IP"
36295 .cindex "outgoing SMTP over TCP/IP"
36296 .cindex "LMTP" "over TCP/IP"
36297 .cindex "outgoing LMTP over TCP/IP"
36298 .cindex "EHLO"
36299 .cindex "HELO"
36300 .cindex "SIZE" "option on MAIL command"
36301 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36302 The &%protocol%& option selects which protocol is to be used, but the actual
36303 processing is the same in both cases.
36304
36305 .cindex "ESMTP extensions" SIZE
36306 If, in response to its EHLO command, Exim is told that the SIZE
36307 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36308 command. The value of <&'n'&> is the message size plus the value of the
36309 &%size_addition%& option (default 1024) to allow for additions to the message
36310 such as per-transport header lines, or changes made in a
36311 .cindex "transport" "filter"
36312 .cindex "filter" "transport filter"
36313 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36314 suppressed.
36315
36316 If the remote server advertises support for PIPELINING, Exim uses the
36317 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36318 required for the transaction.
36319
36320 If the remote server advertises support for the STARTTLS command, and Exim
36321 was built to support TLS encryption, it tries to start a TLS session unless the
36322 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36323 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36324 is called for verification.
36325
36326 If the remote server advertises support for the AUTH command, Exim scans
36327 the authenticators configuration for any suitable client settings, as described
36328 in chapter &<<CHAPSMTPAUTH>>&.
36329
36330 .cindex "carriage return"
36331 .cindex "linefeed"
36332 Responses from the remote host are supposed to be terminated by CR followed by
36333 LF. However, there are known to be hosts that do not send CR characters, so in
36334 order to be able to interwork with such hosts, Exim treats LF on its own as a
36335 line terminator.
36336
36337 If a message contains a number of different addresses, all those with the same
36338 characteristics (for example, the same envelope sender) that resolve to the
36339 same set of hosts, in the same order, are sent in a single SMTP transaction,
36340 even if they are for different domains, unless there are more than the setting
36341 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36342 they are split into groups containing no more than &%max_rcpt%&s addresses
36343 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36344 in parallel sessions. The order of hosts with identical MX values is not
36345 significant when checking whether addresses can be batched in this way.
36346
36347 When the &(smtp)& transport suffers a temporary failure that is not
36348 message-related, Exim updates its transport-specific database, which contains
36349 records indexed by host name that remember which messages are waiting for each
36350 particular host. It also updates the retry database with new retry times.
36351
36352 .cindex "hints database" "retry keys"
36353 Exim's retry hints are based on host name plus IP address, so if one address of
36354 a multi-homed host is broken, it will soon be skipped most of the time.
36355 See the next section for more detail about error handling.
36356
36357 .cindex "SMTP" "passed connection"
36358 .cindex "SMTP" "batching over TCP/IP"
36359 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36360 looks in the hints database for the transport to see if there are any queued
36361 messages waiting for the host to which it is connected. If it finds one, it
36362 creates a new Exim process using the &%-MC%& option (which can only be used by
36363 a process running as root or the Exim user) and passes the TCP/IP socket to it
36364 so that it can deliver another message using the same socket. The new process
36365 does only those deliveries that are routed to the connected host, and may in
36366 turn pass the socket on to a third process, and so on.
36367
36368 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36369 limit the number of messages sent down a single TCP/IP connection.
36370
36371 .cindex "asterisk" "after IP address"
36372 The second and subsequent messages delivered down an existing connection are
36373 identified in the main log by the addition of an asterisk after the closing
36374 square bracket of the IP address.
36375
36376
36377
36378
36379 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36380 .cindex "error" "in outgoing SMTP"
36381 .cindex "SMTP" "errors in outgoing"
36382 .cindex "host" "error"
36383 Three different kinds of error are recognized for outgoing SMTP: host errors,
36384 message errors, and recipient errors.
36385
36386 .vlist
36387 .vitem "&*Host errors*&"
36388 A host error is not associated with a particular message or with a
36389 particular recipient of a message. The host errors are:
36390
36391 .ilist
36392 Connection refused or timed out,
36393 .next
36394 Any error response code on connection,
36395 .next
36396 Any error response code to EHLO or HELO,
36397 .next
36398 Loss of connection at any time, except after &"."&,
36399 .next
36400 I/O errors at any time,
36401 .next
36402 Timeouts during the session, other than in response to MAIL, RCPT or
36403 the &"."& at the end of the data.
36404 .endlist ilist
36405
36406 For a host error, a permanent error response on connection, or in response to
36407 EHLO, causes all addresses routed to the host to be failed. Any other host
36408 error causes all addresses to be deferred, and retry data to be created for the
36409 host. It is not tried again, for any message, until its retry time arrives. If
36410 the current set of addresses are not all delivered in this run (to some
36411 alternative host), the message is added to the list of those waiting for this
36412 host, so if it is still undelivered when a subsequent successful delivery is
36413 made to the host, it will be sent down the same SMTP connection.
36414
36415 .vitem "&*Message errors*&"
36416 .cindex "message" "error"
36417 A message error is associated with a particular message when sent to a
36418 particular host, but not with a particular recipient of the message. The
36419 message errors are:
36420
36421 .ilist
36422 Any error response code to MAIL, DATA, or the &"."& that terminates
36423 the data,
36424 .next
36425 Timeout after MAIL,
36426 .next
36427 Timeout or loss of connection after the &"."& that terminates the data. A
36428 timeout after the DATA command itself is treated as a host error, as is loss of
36429 connection at any other time.
36430 .endlist ilist
36431
36432 For a message error, a permanent error response (5&'xx'&) causes all addresses
36433 to be failed, and a delivery error report to be returned to the sender. A
36434 temporary error response (4&'xx'&), or one of the timeouts, causes all
36435 addresses to be deferred. Retry data is not created for the host, but instead,
36436 a retry record for the combination of host plus message id is created. The
36437 message is not added to the list of those waiting for this host. This ensures
36438 that the failing message will not be sent to this host again until the retry
36439 time arrives. However, other messages that are routed to the host are not
36440 affected, so if it is some property of the message that is causing the error,
36441 it will not stop the delivery of other mail.
36442
36443 If the remote host specified support for the SIZE parameter in its response
36444 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36445 over-large message will cause a message error because the error arrives as a
36446 response to MAIL.
36447
36448 .vitem "&*Recipient errors*&"
36449 .cindex "recipient" "error"
36450 A recipient error is associated with a particular recipient of a message. The
36451 recipient errors are:
36452
36453 .ilist
36454 Any error response to RCPT,
36455 .next
36456 Timeout after RCPT.
36457 .endlist
36458
36459 For a recipient error, a permanent error response (5&'xx'&) causes the
36460 recipient address to be failed, and a bounce message to be returned to the
36461 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36462 address to be deferred, and routing retry data to be created for it. This is
36463 used to delay processing of the address in subsequent queue runs, until its
36464 routing retry time arrives. This applies to all messages, but because it
36465 operates only in queue runs, one attempt will be made to deliver a new message
36466 to the failing address before the delay starts to operate. This ensures that,
36467 if the failure is really related to the message rather than the recipient
36468 (&"message too big for this recipient"& is a possible example), other messages
36469 have a chance of getting delivered. If a delivery to the address does succeed,
36470 the retry information gets cleared, so all stuck messages get tried again, and
36471 the retry clock is reset.
36472
36473 The message is not added to the list of those waiting for this host. Use of the
36474 host for other messages is unaffected, and except in the case of a timeout,
36475 other recipients are processed independently, and may be successfully delivered
36476 in the current SMTP session. After a timeout it is of course impossible to
36477 proceed with the session, so all addresses get deferred. However, those other
36478 than the one that failed do not suffer any subsequent retry delays. Therefore,
36479 if one recipient is causing trouble, the others have a chance of getting
36480 through when a subsequent delivery attempt occurs before the failing
36481 recipient's retry time.
36482 .endlist
36483
36484 In all cases, if there are other hosts (or IP addresses) available for the
36485 current set of addresses (for example, from multiple MX records), they are
36486 tried in this run for any undelivered addresses, subject of course to their
36487 own retry data. In other words, recipient error retry data does not take effect
36488 until the next delivery attempt.
36489
36490 Some hosts have been observed to give temporary error responses to every
36491 MAIL command at certain times (&"insufficient space"& has been seen). It
36492 would be nice if such circumstances could be recognized, and defer data for the
36493 host itself created, but this is not possible within the current Exim design.
36494 What actually happens is that retry data for every (host, message) combination
36495 is created.
36496
36497 The reason that timeouts after MAIL and RCPT are treated specially is that
36498 these can sometimes arise as a result of the remote host's verification
36499 procedures. Exim makes this assumption, and treats them as if a temporary error
36500 response had been received. A timeout after &"."& is treated specially because
36501 it is known that some broken implementations fail to recognize the end of the
36502 message if the last character of the last line is a binary zero. Thus, it is
36503 helpful to treat this case as a message error.
36504
36505 Timeouts at other times are treated as host errors, assuming a problem with the
36506 host, or the connection to it. If a timeout after MAIL, RCPT,
36507 or &"."& is really a connection problem, the assumption is that at the next try
36508 the timeout is likely to occur at some other point in the dialogue, causing it
36509 then to be treated as a host error.
36510
36511 There is experimental evidence that some MTAs drop the connection after the
36512 terminating &"."& if they do not like the contents of the message for some
36513 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36514 should be given. That is why Exim treats this case as a message rather than a
36515 host error, in order not to delay other messages to the same host.
36516
36517
36518
36519
36520 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36521 .cindex "SMTP" "incoming over TCP/IP"
36522 .cindex "incoming SMTP over TCP/IP"
36523 .cindex "inetd"
36524 .cindex "daemon"
36525 Incoming SMTP messages can be accepted in one of two ways: by running a
36526 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36527 &_/etc/inetd.conf_& should be like this:
36528 .code
36529 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36530 .endd
36531 Exim distinguishes between this case and the case of a locally running user
36532 agent using the &%-bs%& option by checking whether or not the standard input is
36533 a socket. When it is, either the port must be privileged (less than 1024), or
36534 the caller must be root or the Exim user. If any other user passes a socket
36535 with an unprivileged port number, Exim prints a message on the standard error
36536 stream and exits with an error code.
36537
36538 By default, Exim does not make a log entry when a remote host connects or
36539 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36540 unexpected. It can be made to write such log entries by setting the
36541 &%smtp_connection%& log selector.
36542
36543 .cindex "carriage return"
36544 .cindex "linefeed"
36545 Commands from the remote host are supposed to be terminated by CR followed by
36546 LF. However, there are known to be hosts that do not send CR characters. In
36547 order to be able to interwork with such hosts, Exim treats LF on its own as a
36548 line terminator.
36549 Furthermore, because common code is used for receiving messages from all
36550 sources, a CR on its own is also interpreted as a line terminator. However, the
36551 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36552
36553 .cindex "EHLO" "invalid data"
36554 .cindex "HELO" "invalid data"
36555 One area that sometimes gives rise to problems concerns the EHLO or
36556 HELO commands. Some clients send syntactically invalid versions of these
36557 commands, which Exim rejects by default. (This is nothing to do with verifying
36558 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36559 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36560 match the broken hosts that send invalid commands.
36561
36562 .cindex "SIZE option on MAIL command"
36563 .cindex "MAIL" "SIZE option"
36564 The amount of disk space available is checked whenever SIZE is received on
36565 a MAIL command, independently of whether &%message_size_limit%& or
36566 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36567 false. A temporary error is given if there is not enough space. If
36568 &%check_spool_space%& is set, the check is for that amount of space plus the
36569 value given with SIZE, that is, it checks that the addition of the incoming
36570 message will not reduce the space below the threshold.
36571
36572 When a message is successfully received, Exim includes the local message id in
36573 its response to the final &"."& that terminates the data. If the remote host
36574 logs this text it can help with tracing what has happened to a message.
36575
36576 The Exim daemon can limit the number of simultaneous incoming connections it is
36577 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36578 number of simultaneous incoming connections from a single remote host (see the
36579 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36580 rejected using the SMTP temporary error code 421.
36581
36582 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36583 subprocess has finished, as this can get lost at busy times. Instead, it looks
36584 for completed subprocesses every time it wakes up. Provided there are other
36585 things happening (new incoming calls, starts of queue runs), completed
36586 processes will be noticed and tidied away. On very quiet systems you may
36587 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36588 it will be noticed when the daemon next wakes up.
36589
36590 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36591 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36592 high system load &-- for details see the &%smtp_accept_reserve%&,
36593 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36594 applies in both the daemon and &'inetd'& cases.
36595
36596 Exim normally starts a delivery process for each message received, though this
36597 can be varied by means of the &%-odq%& command line option and the
36598 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36599 number of simultaneously running delivery processes started in this way from
36600 SMTP input can be limited by the &%smtp_accept_queue%& and
36601 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36602 subsequently received messages are just put on the input queue without starting
36603 a delivery process.
36604
36605 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36606 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36607 started up from the &'inetd'& daemon, because in that case each connection is
36608 handled by an entirely independent Exim process. Control by load average is,
36609 however, available with &'inetd'&.
36610
36611 Exim can be configured to verify addresses in incoming SMTP commands as they
36612 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36613 to rewrite addresses at this time &-- before any syntax checking is done. See
36614 section &<<SECTrewriteS>>&.
36615
36616 Exim can also be configured to limit the rate at which a client host submits
36617 MAIL and RCPT commands in a single SMTP session. See the
36618 &%smtp_ratelimit_hosts%& option.
36619
36620
36621
36622 .section "Unrecognized SMTP commands" "SECID234"
36623 .cindex "SMTP" "unrecognized commands"
36624 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36625 commands during a single SMTP connection, it drops the connection after sending
36626 the error response to the last command. The default value for
36627 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36628 abuse that subvert web servers into making connections to SMTP ports; in these
36629 circumstances, a number of non-SMTP lines are sent first.
36630
36631
36632 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36633 .cindex "SMTP" "syntax errors"
36634 .cindex "SMTP" "protocol errors"
36635 A syntax error is detected if an SMTP command is recognized, but there is
36636 something syntactically wrong with its data, for example, a malformed email
36637 address in a RCPT command. Protocol errors include invalid command
36638 sequencing such as RCPT before MAIL. If Exim receives more than
36639 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36640 drops the connection after sending the error response to the last command. The
36641 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36642 broken clients that loop sending bad commands (yes, it has been seen).
36643
36644
36645
36646 .section "Use of non-mail SMTP commands" "SECID236"
36647 .cindex "SMTP" "non-mail commands"
36648 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36649 DATA. Exim counts such commands, and drops the connection if there are too
36650 many of them in a single SMTP session. This action catches some
36651 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36652 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36653 defines what &"too many"& means. Its default value is 10.
36654
36655 When a new message is expected, one occurrence of RSET is not counted. This
36656 allows a client to send one RSET between messages (this is not necessary,
36657 but some clients do it). Exim also allows one uncounted occurrence of HELO
36658 or EHLO, and one occurrence of STARTTLS between messages. After
36659 starting up a TLS session, another EHLO is expected, and so it too is not
36660 counted.
36661
36662 The first occurrence of AUTH in a connection, or immediately following
36663 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36664 RCPT, DATA, and QUIT are counted.
36665
36666 You can control which hosts are subject to the limit set by
36667 &%smtp_accept_max_nonmail%& by setting
36668 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36669 the limit apply to all hosts. This option means that you can exclude any
36670 specific badly-behaved hosts that you have to live with.
36671
36672
36673
36674
36675 .section "The VRFY and EXPN commands" "SECID237"
36676 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36677 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36678 appropriate) in order to decide whether the command should be accepted or not.
36679
36680 .cindex "VRFY" "processing"
36681 When no ACL is defined for VRFY, or if it rejects without
36682 setting an explicit response code, the command is accepted
36683 (with a 252 SMTP response code)
36684 in order to support awkward clients that do a VRFY before every RCPT.
36685 When VRFY is accepted, it runs exactly the same code as when Exim is
36686 called with the &%-bv%& option, and returns 250/451/550
36687 SMTP response codes.
36688
36689 .cindex "EXPN" "processing"
36690 If no ACL for EXPN is defined, the command is rejected.
36691 When EXPN is accepted, a single-level expansion of the address is done.
36692 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36693 than a verification (the &%-bv%& option). If an unqualified local part is given
36694 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36695 of VRFY and EXPN commands are logged on the main and reject logs, and
36696 VRFY verification failures are logged on the main log for consistency with
36697 RCPT failures.
36698
36699
36700
36701 .section "The ETRN command" "SECTETRN"
36702 .cindex "ETRN" "processing"
36703 .cindex "ESMTP extensions" ETRN
36704 RFC 1985 describes an ESMTP command called ETRN that is designed to
36705 overcome the security problems of the TURN command (which has fallen into
36706 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36707 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36708 should be accepted or not. If no ACL is defined, the command is rejected.
36709
36710 The ETRN command is concerned with &"releasing"& messages that are awaiting
36711 delivery to certain hosts. As Exim does not organize its message queue by host,
36712 the only form of ETRN that is supported by default is the one where the
36713 text starts with the &"#"& prefix, in which case the remainder of the text is
36714 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36715 the &%-R%& option to happen, with the remainder of the ETRN text as its
36716 argument. For example,
36717 .code
36718 ETRN #brigadoon
36719 .endd
36720 runs the command
36721 .code
36722 exim -R brigadoon
36723 .endd
36724 which causes a delivery attempt on all messages with undelivered addresses
36725 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36726 default), Exim prevents the simultaneous execution of more than one queue run
36727 for the same argument string as a result of an ETRN command. This stops
36728 a misbehaving client from starting more than one queue runner at once.
36729
36730 .cindex "hints database" "ETRN serialization"
36731 Exim implements the serialization by means of a hints database in which a
36732 record is written whenever a process is started by ETRN, and deleted when
36733 the process completes. However, Exim does not keep the SMTP session waiting for
36734 the ETRN process to complete. Once ETRN is accepted, the client is sent
36735 a &"success"& return code. Obviously there is scope for hints records to get
36736 left lying around if there is a system or program crash. To guard against this,
36737 Exim ignores any records that are more than six hours old.
36738
36739 .oindex "&%smtp_etrn_command%&"
36740 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36741 used. This specifies a command that is run whenever ETRN is received,
36742 whatever the form of its argument. For
36743 example:
36744 .code
36745 smtp_etrn_command = /etc/etrn_command $domain \
36746                     $sender_host_address
36747 .endd
36748 .vindex "&$domain$&"
36749 The string is split up into arguments which are independently expanded. The
36750 expansion variable &$domain$& is set to the argument of the ETRN command,
36751 and no syntax checking is done on the contents of this argument. Exim does not
36752 wait for the command to complete, so its status code is not checked. Exim runs
36753 under its own uid and gid when receiving incoming SMTP, so it is not possible
36754 for it to change them before running the command.
36755
36756
36757
36758 .section "Incoming local SMTP" "SECID238"
36759 .cindex "SMTP" "local incoming"
36760 Some user agents use SMTP to pass messages to their local MTA using the
36761 standard input and output, as opposed to passing the envelope on the command
36762 line and writing the message to the standard input. This is supported by the
36763 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36764 messages over TCP/IP (including the use of ACLs), except that the envelope
36765 sender given in a MAIL command is ignored unless the caller is trusted. In
36766 an ACL you can detect this form of SMTP input by testing for an empty host
36767 identification. It is common to have this as the first line in the ACL that
36768 runs for RCPT commands:
36769 .code
36770 accept hosts = :
36771 .endd
36772 This accepts SMTP messages from local processes without doing any other tests.
36773
36774
36775
36776 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36777 .cindex "SMTP" "batched outgoing"
36778 .cindex "batched SMTP output"
36779 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36780 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36781 be output in BSMTP format. No SMTP responses are possible for this form of
36782 delivery. All it is doing is using SMTP commands as a way of transmitting the
36783 envelope along with the message.
36784
36785 The message is written to the file or pipe preceded by the SMTP commands
36786 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36787 the message that start with a dot have an extra dot added. The SMTP command
36788 HELO is not normally used. If it is required, the &%message_prefix%& option
36789 can be used to specify it.
36790
36791 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36792 one recipient address at a time by default. However, you can arrange for them
36793 to handle several addresses at once by setting the &%batch_max%& option. When
36794 this is done for BSMTP, messages may contain multiple RCPT commands. See
36795 chapter &<<CHAPbatching>>& for more details.
36796
36797 .vindex "&$host$&"
36798 When one or more addresses are routed to a BSMTP transport by a router that
36799 sets up a host list, the name of the first host on the list is available to the
36800 transport in the variable &$host$&. Here is an example of such a transport and
36801 router:
36802 .code
36803 begin routers
36804 route_append:
36805   driver = manualroute
36806   transport = smtp_appendfile
36807   route_list = domain.example  batch.host.example
36808
36809 begin transports
36810 smtp_appendfile:
36811   driver = appendfile
36812   directory = /var/bsmtp/$host
36813   batch_max = 1000
36814   use_bsmtp
36815   user = exim
36816 .endd
36817 This causes messages addressed to &'domain.example'& to be written in BSMTP
36818 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36819 message (unless there are more than 1000 recipients).
36820
36821
36822
36823 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36824 .cindex "SMTP" "batched incoming"
36825 .cindex "batched SMTP input"
36826 The &%-bS%& command line option causes Exim to accept one or more messages by
36827 reading SMTP on the standard input, but to generate no responses. If the caller
36828 is trusted, the senders in the MAIL commands are believed; otherwise the
36829 sender is always the caller of Exim. Unqualified senders and receivers are not
36830 rejected (there seems little point) but instead just get qualified. HELO
36831 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36832 as NOOP; QUIT quits.
36833
36834 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36835 ACL is run in the same way as for non-SMTP local input.
36836
36837 If an error is detected while reading a message, including a missing &"."& at
36838 the end, Exim gives up immediately. It writes details of the error to the
36839 standard output in a stylized way that the calling program should be able to
36840 make some use of automatically, for example:
36841 .code
36842 554 Unexpected end of file
36843 Transaction started in line 10
36844 Error detected in line 14
36845 .endd
36846 It writes a more verbose version, for human consumption, to the standard error
36847 file, for example:
36848 .code
36849 An error was detected while processing a file of BSMTP input.
36850 The error message was:
36851
36852 501 '>' missing at end of address
36853
36854 The SMTP transaction started in line 10.
36855 The error was detected in line 12.
36856 The SMTP command at fault was:
36857
36858 rcpt to:<malformed@in.com.plete
36859
36860 1 previous message was successfully processed.
36861 The rest of the batch was abandoned.
36862 .endd
36863 The return code from Exim is zero only if there were no errors. It is 1 if some
36864 messages were accepted before an error was detected, and 2 if no messages were
36865 accepted.
36866 .ecindex IIDsmtpproc1
36867 .ecindex IIDsmtpproc2
36868
36869
36870
36871 . ////////////////////////////////////////////////////////////////////////////
36872 . ////////////////////////////////////////////////////////////////////////////
36873
36874 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36875          "Customizing messages"
36876 When a message fails to be delivered, or remains in the queue for more than a
36877 configured amount of time, Exim sends a message to the original sender, or
36878 to an alternative configured address. The text of these messages is built into
36879 the code of Exim, but it is possible to change it, either by adding a single
36880 string, or by replacing each of the paragraphs by text supplied in a file.
36881
36882 The &'From:'& and &'To:'& header lines are automatically generated; you can
36883 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36884 option. Exim also adds the line
36885 .code
36886 Auto-Submitted: auto-generated
36887 .endd
36888 to all warning and bounce messages,
36889
36890
36891 .section "Customizing bounce messages" "SECID239"
36892 .cindex "customizing" "bounce message"
36893 .cindex "bounce message" "customizing"
36894 If &%bounce_message_text%& is set, its contents are included in the default
36895 message immediately after &"This message was created automatically by mail
36896 delivery software."& The string is not expanded. It is not used if
36897 &%bounce_message_file%& is set.
36898
36899 When &%bounce_message_file%& is set, it must point to a template file for
36900 constructing error messages. The file consists of a series of text items,
36901 separated by lines consisting of exactly four asterisks. If the file cannot be
36902 opened, default text is used and a message is written to the main and panic
36903 logs. If any text item in the file is empty, default text is used for that
36904 item.
36905
36906 .vindex "&$bounce_recipient$&"
36907 .vindex "&$bounce_return_size_limit$&"
36908 Each item of text that is read from the file is expanded, and there are two
36909 expansion variables which can be of use here: &$bounce_recipient$& is set to
36910 the recipient of an error message while it is being created, and
36911 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36912 option, rounded to a whole number.
36913
36914 The items must appear in the file in the following order:
36915
36916 .ilist
36917 The first item is included in the headers, and should include at least a
36918 &'Subject:'& header. Exim does not check the syntax of these headers.
36919 .next
36920 The second item forms the start of the error message. After it, Exim lists the
36921 failing addresses with their error messages.
36922 .next
36923 The third item is used to introduce any text from pipe transports that is to be
36924 returned to the sender. It is omitted if there is no such text.
36925 .next
36926 The fourth, fifth and sixth items will be ignored and may be empty.
36927 The fields exist for back-compatibility
36928 .endlist
36929
36930 The default state (&%bounce_message_file%& unset) is equivalent to the
36931 following file, in which the sixth item is empty. The &'Subject:'& and some
36932 other lines have been split in order to fit them on the page:
36933 .code
36934 Subject: Mail delivery failed
36935   ${if eq{$sender_address}{$bounce_recipient}
36936   {: returning message to sender}}
36937 ****
36938 This message was created automatically by mail delivery software.
36939
36940 A message ${if eq{$sender_address}{$bounce_recipient}
36941   {that you sent }{sent by
36942
36943 <$sender_address>
36944
36945 }}could not be delivered to all of its recipients.
36946 This is a permanent error. The following address(es) failed:
36947 ****
36948 The following text was generated during the delivery attempt(s):
36949 ****
36950 ------ This is a copy of the message, including all the headers.
36951   ------
36952 ****
36953 ------ The body of the message is $message_size characters long;
36954   only the first
36955 ------ $bounce_return_size_limit or so are included here.
36956 ****
36957 .endd
36958 .section "Customizing warning messages" "SECTcustwarn"
36959 .cindex "customizing" "warning message"
36960 .cindex "warning of delay" "customizing the message"
36961 The option &%warn_message_file%& can be pointed at a template file for use when
36962 warnings about message delays are created. In this case there are only three
36963 text sections:
36964
36965 .ilist
36966 The first item is included in the headers, and should include at least a
36967 &'Subject:'& header. Exim does not check the syntax of these headers.
36968 .next
36969 The second item forms the start of the warning message. After it, Exim lists
36970 the delayed addresses.
36971 .next
36972 The third item then ends the message.
36973 .endlist
36974
36975 The default state is equivalent to the following file, except that some lines
36976 have been split here, in order to fit them on the page:
36977 .code
36978 Subject: Warning: message $message_exim_id delayed
36979   $warn_message_delay
36980 ****
36981 This message was created automatically by mail delivery software.
36982
36983 A message ${if eq{$sender_address}{$warn_message_recipients}
36984 {that you sent }{sent by
36985
36986 <$sender_address>
36987
36988 }}has not been delivered to all of its recipients after
36989 more than $warn_message_delay in the queue on $primary_hostname.
36990
36991 The message identifier is:     $message_exim_id
36992 The subject of the message is: $h_subject
36993 The date of the message is:    $h_date
36994
36995 The following address(es) have not yet been delivered:
36996 ****
36997 No action is required on your part. Delivery attempts will
36998 continue for some time, and this warning may be repeated at
36999 intervals if the message remains undelivered. Eventually the
37000 mail delivery software will give up, and when that happens,
37001 the message will be returned to you.
37002 .endd
37003 .vindex "&$warn_message_delay$&"
37004 .vindex "&$warn_message_recipients$&"
37005 However, in the default state the subject and date lines are omitted if no
37006 appropriate headers exist. During the expansion of this file,
37007 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37008 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37009 of recipients for the warning message. There may be more than one if there are
37010 multiple addresses with different &%errors_to%& settings on the routers that
37011 handled them.
37012
37013
37014
37015
37016 . ////////////////////////////////////////////////////////////////////////////
37017 . ////////////////////////////////////////////////////////////////////////////
37018
37019 .chapter "Some common configuration settings" "CHAPcomconreq"
37020 This chapter discusses some configuration settings that seem to be fairly
37021 common. More examples and discussion can be found in the Exim book.
37022
37023
37024
37025 .section "Sending mail to a smart host" "SECID240"
37026 .cindex "smart host" "example router"
37027 If you want to send all mail for non-local domains to a &"smart host"&, you
37028 should replace the default &(dnslookup)& router with a router which does the
37029 routing explicitly:
37030 .code
37031 send_to_smart_host:
37032   driver = manualroute
37033   route_list = !+local_domains smart.host.name
37034   transport = remote_smtp
37035 .endd
37036 You can use the smart host's IP address instead of the name if you wish.
37037 If you are using Exim only to submit messages to a smart host, and not for
37038 receiving incoming messages, you can arrange for it to do the submission
37039 synchronously by setting the &%mua_wrapper%& option (see chapter
37040 &<<CHAPnonqueueing>>&).
37041
37042
37043
37044
37045 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37046 .cindex "mailing lists"
37047 Exim can be used to run simple mailing lists, but for large and/or complicated
37048 requirements, the use of additional specialized mailing list software such as
37049 Majordomo or Mailman is recommended.
37050
37051 The &(redirect)& router can be used to handle mailing lists where each list
37052 is maintained in a separate file, which can therefore be managed by an
37053 independent manager. The &%domains%& router option can be used to run these
37054 lists in a separate domain from normal mail. For example:
37055 .code
37056 lists:
37057   driver = redirect
37058   domains = lists.example
37059   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37060   forbid_pipe
37061   forbid_file
37062   errors_to = ${quote_local_part:$local_part-request}@lists.example
37063   no_more
37064 .endd
37065 This router is skipped for domains other than &'lists.example'&. For addresses
37066 in that domain, it looks for a file that matches the local part. If there is no
37067 such file, the router declines, but because &%no_more%& is set, no subsequent
37068 routers are tried, and so the whole delivery fails.
37069
37070 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37071 expanded into a filename or a pipe delivery, which is usually inappropriate in
37072 a mailing list.
37073
37074 .oindex "&%errors_to%&"
37075 The &%errors_to%& option specifies that any delivery errors caused by addresses
37076 taken from a mailing list are to be sent to the given address rather than the
37077 original sender of the message. However, before acting on this, Exim verifies
37078 the error address, and ignores it if verification fails.
37079
37080 For example, using the configuration above, mail sent to
37081 &'dicts@lists.example'& is passed on to those addresses contained in
37082 &_/usr/lists/dicts_&, with error reports directed to
37083 &'dicts-request@lists.example'&, provided that this address can be verified.
37084 There could be a file called &_/usr/lists/dicts-request_& containing
37085 the address(es) of this particular list's manager(s), but other approaches,
37086 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37087 or &%local_part_suffix%& options) to handle addresses of the form
37088 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37089
37090
37091
37092 .section "Syntax errors in mailing lists" "SECID241"
37093 .cindex "mailing lists" "syntax errors in"
37094 If an entry in redirection data contains a syntax error, Exim normally defers
37095 delivery of the original address. That means that a syntax error in a mailing
37096 list holds up all deliveries to the list. This may not be appropriate when a
37097 list is being maintained automatically from data supplied by users, and the
37098 addresses are not rigorously checked.
37099
37100 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37101 entries that fail to parse, noting the incident in the log. If in addition
37102 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37103 whenever a broken address is skipped. It is usually appropriate to set
37104 &%syntax_errors_to%& to the same address as &%errors_to%&.
37105
37106
37107
37108 .section "Re-expansion of mailing lists" "SECID242"
37109 .cindex "mailing lists" "re-expansion of"
37110 Exim remembers every individual address to which a message has been delivered,
37111 in order to avoid duplication, but it normally stores only the original
37112 recipient addresses with a message. If all the deliveries to a mailing list
37113 cannot be done at the first attempt, the mailing list is re-expanded when the
37114 delivery is next tried. This means that alterations to the list are taken into
37115 account at each delivery attempt, so addresses that have been added to
37116 the list since the message arrived will therefore receive a copy of the
37117 message, even though it pre-dates their subscription.
37118
37119 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37120 on the &(redirect)& router. If this is done, any addresses generated by the
37121 router that fail to deliver at the first attempt are added to the message as
37122 &"top level"& addresses, and the parent address that generated them is marked
37123 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37124 subsequent delivery attempts. The disadvantage of this is that if any of the
37125 failing addresses are incorrect, correcting them in the file has no effect on
37126 pre-existing messages.
37127
37128 The original top-level address is remembered with each of the generated
37129 addresses, and is output in any log messages. However, any intermediate parent
37130 addresses are not recorded. This makes a difference to the log only if the
37131 &%all_parents%& selector is set, but for mailing lists there is normally only
37132 one level of expansion anyway.
37133
37134
37135
37136 .section "Closed mailing lists" "SECID243"
37137 .cindex "mailing lists" "closed"
37138 The examples so far have assumed open mailing lists, to which anybody may
37139 send mail. It is also possible to set up closed lists, where mail is accepted
37140 from specified senders only. This is done by making use of the generic
37141 &%senders%& option to restrict the router that handles the list.
37142
37143 The following example uses the same file as a list of recipients and as a list
37144 of permitted senders. It requires three routers:
37145 .code
37146 lists_request:
37147   driver = redirect
37148   domains = lists.example
37149   local_part_suffix = -request
37150   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37151   file = /usr/lists/${local_part_data}-request
37152   no_more
37153
37154 lists_post:
37155   driver = redirect
37156   domains = lists.example
37157   senders = ${if exists {/usr/lists/$local_part}\
37158              {lsearch;/usr/lists/$local_part}{*}}
37159   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37160   forbid_pipe
37161   forbid_file
37162   errors_to = ${quote_local_part:$local_part-request}@lists.example
37163   no_more
37164
37165 lists_closed:
37166   driver = redirect
37167   domains = lists.example
37168   allow_fail
37169   data = :fail: $local_part@lists.example is a closed mailing list
37170 .endd
37171 All three routers have the same &%domains%& setting, so for any other domains,
37172 they are all skipped. The first router runs only if the local part ends in
37173 &%-request%&. It handles messages to the list manager(s) by means of an open
37174 mailing list.
37175
37176 The second router runs only if the &%senders%& precondition is satisfied. It
37177 checks for the existence of a list that corresponds to the local part, and then
37178 checks that the sender is on the list by means of a linear search. It is
37179 necessary to check for the existence of the file before trying to search it,
37180 because otherwise Exim thinks there is a configuration error. If the file does
37181 not exist, the expansion of &%senders%& is *, which matches all senders. This
37182 means that the router runs, but because there is no list, declines, and
37183 &%no_more%& ensures that no further routers are run. The address fails with an
37184 &"unrouteable address"& error.
37185
37186 The third router runs only if the second router is skipped, which happens when
37187 a mailing list exists, but the sender is not on it. This router forcibly fails
37188 the address, giving a suitable error message.
37189
37190
37191
37192
37193 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37194 .cindex "VERP"
37195 .cindex "Variable Envelope Return Paths"
37196 .cindex "envelope from"
37197 .cindex "envelope sender"
37198 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37199 are a way of helping mailing list administrators discover which subscription
37200 address is the cause of a particular delivery failure. The idea is to encode
37201 the original recipient address in the outgoing envelope sender address, so that
37202 if the message is forwarded by another host and then subsequently bounces, the
37203 original recipient can be extracted from the recipient address of the bounce.
37204
37205 .oindex &%errors_to%&
37206 .oindex &%return_path%&
37207 Envelope sender addresses can be modified by Exim using two different
37208 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37209 list examples), or the &%return_path%& option on a transport. The second of
37210 these is effective only if the message is successfully delivered to another
37211 host; it is not used for errors detected on the local host (see the description
37212 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37213 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37214 .code
37215 verp_smtp:
37216   driver = smtp
37217   max_rcpt = 1
37218   return_path = \
37219     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37220       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37221 .endd
37222 This has the effect of rewriting the return path (envelope sender) on outgoing
37223 SMTP messages, if the local part of the original return path ends in
37224 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37225 local part and domain of the recipient into the return path. Suppose, for
37226 example, that a message whose return path has been set to
37227 &'somelist-request@your.dom.example'& is sent to
37228 &'subscriber@other.dom.example'&. In the transport, the return path is
37229 rewritten as
37230 .code
37231 somelist-request+subscriber=other.dom.example@your.dom.example
37232 .endd
37233 .vindex "&$local_part$&"
37234 For this to work, you must tell Exim to send multiple copies of messages that
37235 have more than one recipient, so that each copy has just one recipient. This is
37236 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37237 might be sent to several different recipients in the same domain, in which case
37238 &$local_part$& is not available in the transport, because it is not unique.
37239
37240 Unless your host is doing nothing but mailing list deliveries, you should
37241 probably use a separate transport for the VERP deliveries, so as not to use
37242 extra resources in making one-per-recipient copies for other deliveries. This
37243 can easily be done by expanding the &%transport%& option in the router:
37244 .code
37245 dnslookup:
37246   driver = dnslookup
37247   domains = ! +local_domains
37248   transport = \
37249     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37250       {verp_smtp}{remote_smtp}}
37251   no_more
37252 .endd
37253 If you want to change the return path using &%errors_to%& in a router instead
37254 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37255 routers that handle mailing list addresses. This will ensure that all delivery
37256 errors, including those detected on the local host, are sent to the VERP
37257 address.
37258
37259 On a host that does no local deliveries and has no manual routing, only the
37260 &(dnslookup)& router needs to be changed. A special transport is not needed for
37261 SMTP deliveries. Every mailing list recipient has its own return path value,
37262 and so Exim must hand them to the transport one at a time. Here is an example
37263 of a &(dnslookup)& router that implements VERP:
37264 .code
37265 verp_dnslookup:
37266   driver = dnslookup
37267   domains = ! +local_domains
37268   transport = remote_smtp
37269   errors_to = \
37270     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37271      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37272   no_more
37273 .endd
37274 Before you start sending out messages with VERPed return paths, you must also
37275 configure Exim to accept the bounce messages that come back to those paths.
37276 Typically this is done by setting a &%local_part_suffix%& option for a
37277 router, and using this to route the messages to wherever you want to handle
37278 them.
37279
37280 The overhead incurred in using VERP depends very much on the size of the
37281 message, the number of recipient addresses that resolve to the same remote
37282 host, and the speed of the connection over which the message is being sent. If
37283 a lot of addresses resolve to the same host and the connection is slow, sending
37284 a separate copy of the message for each address may take substantially longer
37285 than sending a single copy with many recipients (for which VERP cannot be
37286 used).
37287
37288
37289
37290
37291
37292
37293 .section "Virtual domains" "SECTvirtualdomains"
37294 .cindex "virtual domains"
37295 .cindex "domain" "virtual"
37296 The phrase &'virtual domain'& is unfortunately used with two rather different
37297 meanings:
37298
37299 .ilist
37300 A domain for which there are no real mailboxes; all valid local parts are
37301 aliases for other email addresses. Common examples are organizational
37302 top-level domains and &"vanity"& domains.
37303 .next
37304 One of a number of independent domains that are all handled by the same host,
37305 with mailboxes on that host, but where the mailbox owners do not necessarily
37306 have login accounts on that host.
37307 .endlist
37308
37309 The first usage is probably more common, and does seem more &"virtual"& than
37310 the second. This kind of domain can be handled in Exim with a straightforward
37311 aliasing router. One approach is to create a separate alias file for each
37312 virtual domain. Exim can test for the existence of the alias file to determine
37313 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37314 to a router of this form:
37315 .code
37316 virtual:
37317   driver = redirect
37318   domains = dsearch;/etc/mail/virtual
37319   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37320   no_more
37321 .endd
37322 The &%domains%& option specifies that the router is to be skipped, unless there
37323 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37324 domain that is being processed.
37325 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37326 being placed into the &$domain_data$& variable.
37327
37328 When the router runs, it looks up the local
37329 part in the file to find a new address (or list of addresses). The &%no_more%&
37330 setting ensures that if the lookup fails (leading to &%data%& being an empty
37331 string), Exim gives up on the address without trying any subsequent routers.
37332
37333 This one router can handle all the virtual domains because the alias filenames
37334 follow a fixed pattern. Permissions can be arranged so that appropriate people
37335 can edit the different alias files. A successful aliasing operation results in
37336 a new envelope recipient address, which is then routed from scratch.
37337
37338 The other kind of &"virtual"& domain can also be handled in a straightforward
37339 way. One approach is to create a file for each domain containing a list of
37340 valid local parts, and use it in a router like this:
37341 .code
37342 my_domains:
37343   driver = accept
37344   domains = dsearch;/etc/mail/domains
37345   local_parts = lsearch;/etc/mail/domains/$domain
37346   transport = my_mailboxes
37347 .endd
37348 The address is accepted if there is a file for the domain, and the local part
37349 can be found in the file. The &%domains%& option is used to check for the
37350 file's existence because &%domains%& is tested before the &%local_parts%&
37351 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37352 because that option is tested after &%local_parts%&. The transport is as
37353 follows:
37354 .code
37355 my_mailboxes:
37356   driver = appendfile
37357   file = /var/mail/$domain_data/$local_part_data
37358   user = mail
37359 .endd
37360 This uses a directory of mailboxes for each domain. The &%user%& setting is
37361 required, to specify which uid is to be used for writing to the mailboxes.
37362
37363 The configuration shown here is just one example of how you might support this
37364 requirement. There are many other ways this kind of configuration can be set
37365 up, for example, by using a database instead of separate files to hold all the
37366 information about the domains.
37367
37368
37369
37370 .section "Multiple user mailboxes" "SECTmulbox"
37371 .cindex "multiple mailboxes"
37372 .cindex "mailbox" "multiple"
37373 .cindex "local part" "prefix"
37374 .cindex "local part" "suffix"
37375 Heavy email users often want to operate with multiple mailboxes, into which
37376 incoming mail is automatically sorted. A popular way of handling this is to
37377 allow users to use multiple sender addresses, so that replies can easily be
37378 identified. Users are permitted to add prefixes or suffixes to their local
37379 parts for this purpose. The wildcard facility of the generic router options
37380 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37381 example, consider this router:
37382 .code
37383 userforward:
37384   driver = redirect
37385   check_local_user
37386   file = $home/.forward
37387   local_part_suffix = -*
37388   local_part_suffix_optional
37389   allow_filter
37390 .endd
37391 .vindex "&$local_part_suffix$&"
37392 It runs a user's &_.forward_& file for all local parts of the form
37393 &'username-*'&. Within the filter file the user can distinguish different
37394 cases by testing the variable &$local_part_suffix$&. For example:
37395 .code
37396 if $local_part_suffix contains -special then
37397 save /home/$local_part_data/Mail/special
37398 endif
37399 .endd
37400 If the filter file does not exist, or does not deal with such addresses, they
37401 fall through to subsequent routers, and, assuming no subsequent use of the
37402 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37403 control over which suffixes are valid.
37404
37405 Alternatively, a suffix can be used to trigger the use of a different
37406 &_.forward_& file &-- which is the way a similar facility is implemented in
37407 another MTA:
37408 .code
37409 userforward:
37410   driver = redirect
37411   check_local_user
37412   local_part_suffix = -*
37413   local_part_suffix_optional
37414   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37415   allow_filter
37416 .endd
37417 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37418 example, &_.forward-special_& is used. Once again, if the appropriate file
37419 does not exist, or does not deal with the address, it is passed on to
37420 subsequent routers, which could, if required, look for an unqualified
37421 &_.forward_& file to use as a default.
37422
37423
37424
37425 .section "Simplified vacation processing" "SECID244"
37426 .cindex "vacation processing"
37427 The traditional way of running the &'vacation'& program is for a user to set up
37428 a pipe command in a &_.forward_& file
37429 (see section &<<SECTspecitredli>>& for syntax details).
37430 This is prone to error by inexperienced users. There are two features of Exim
37431 that can be used to make this process simpler for users:
37432
37433 .ilist
37434 A local part prefix such as &"vacation-"& can be specified on a router which
37435 can cause the message to be delivered directly to the &'vacation'& program, or
37436 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37437 &_.forward_& file are then much simpler. For example:
37438 .code
37439 spqr, vacation-spqr
37440 .endd
37441 .next
37442 The &%require_files%& generic router option can be used to trigger a
37443 vacation delivery by checking for the existence of a certain file in the
37444 user's home directory. The &%unseen%& generic option should also be used, to
37445 ensure that the original delivery also proceeds. In this case, all the user has
37446 to do is to create a file called, say, &_.vacation_&, containing a vacation
37447 message.
37448 .endlist
37449
37450 Another advantage of both these methods is that they both work even when the
37451 use of arbitrary pipes by users is locked out.
37452
37453
37454
37455 .section "Taking copies of mail" "SECID245"
37456 .cindex "message" "copying every"
37457 Some installations have policies that require archive copies of all messages to
37458 be made. A single copy of each message can easily be taken by an appropriate
37459 command in a system filter, which could, for example, use a different file for
37460 each day's messages.
37461
37462 There is also a shadow transport mechanism that can be used to take copies of
37463 messages that are successfully delivered by local transports, one copy per
37464 delivery. This could be used, &'inter alia'&, to implement automatic
37465 notification of delivery by sites that insist on doing such things.
37466
37467
37468
37469 .section "Intermittently connected hosts" "SECID246"
37470 .cindex "intermittently connected hosts"
37471 It has become quite common (because it is cheaper) for hosts to connect to the
37472 Internet periodically rather than remain connected all the time. The normal
37473 arrangement is that mail for such hosts accumulates on a system that is
37474 permanently connected.
37475
37476 Exim was designed for use on permanently connected hosts, and so it is not
37477 particularly well-suited to use in an intermittently connected environment.
37478 Nevertheless there are some features that can be used.
37479
37480
37481 .section "Exim on the upstream server host" "SECID247"
37482 It is tempting to arrange for incoming mail for the intermittently connected
37483 host to remain in Exim's queue until the client connects. However, this
37484 approach does not scale very well. Two different kinds of waiting message are
37485 being mixed up in the same queue &-- those that cannot be delivered because of
37486 some temporary problem, and those that are waiting for their destination host
37487 to connect. This makes it hard to manage the queue, as well as wasting
37488 resources, because each queue runner scans the entire queue.
37489
37490 A better approach is to separate off those messages that are waiting for an
37491 intermittently connected host. This can be done by delivering these messages
37492 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37493 format, from where they are transmitted by other software when their
37494 destination connects. This makes it easy to collect all the mail for one host
37495 in a single directory, and to apply local timeout rules on a per-message basis
37496 if required.
37497
37498 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37499 you are doing this, you should configure Exim with a long retry period for the
37500 intermittent host. For example:
37501 .code
37502 cheshire.wonderland.fict.example    *   F,5d,24h
37503 .endd
37504 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37505 which messages it has queued up for that host. Once the intermittent host comes
37506 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37507 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37508 causes all the queued up messages to be delivered, often down a single SMTP
37509 connection. While the host remains connected, any new messages get delivered
37510 immediately.
37511
37512 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37513 issued with a different IP address each time it connects, Exim's retry
37514 mechanisms on the holding host get confused, because the IP address is normally
37515 used as part of the key string for holding retry information. This can be
37516 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37517 Since this has disadvantages for permanently connected hosts, it is best to
37518 arrange a separate transport for the intermittently connected ones.
37519
37520
37521
37522 .section "Exim on the intermittently connected client host" "SECID248"
37523 The value of &%smtp_accept_queue_per_connection%& should probably be
37524 increased, or even set to zero (that is, disabled) on the intermittently
37525 connected host, so that all incoming messages down a single connection get
37526 delivered immediately.
37527
37528 .cindex "SMTP" "passed connection"
37529 .cindex "SMTP" "multiple deliveries"
37530 .cindex "multiple SMTP deliveries"
37531 .cindex "first pass routing"
37532 Mail waiting to be sent from an intermittently connected host will probably
37533 not have been routed, because without a connection DNS lookups are not
37534 possible. This means that if a normal queue run is done at connection time,
37535 each message is likely to be sent in a separate SMTP session. This can be
37536 avoided by starting the queue run with a command line option beginning with
37537 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37538 first pass, routing is done but no deliveries take place. The second pass is a
37539 normal queue run; since all the messages have been previously routed, those
37540 destined for the same host are likely to get sent as multiple deliveries in a
37541 single SMTP connection.
37542
37543
37544
37545 . ////////////////////////////////////////////////////////////////////////////
37546 . ////////////////////////////////////////////////////////////////////////////
37547
37548 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37549          "Exim as a non-queueing client"
37550 .cindex "client, non-queueing"
37551 .cindex "smart host" "suppressing queueing"
37552 On a personal computer, it is a common requirement for all
37553 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37554 configured to operate that way, for all the popular operating systems.
37555 However, there are some MUAs for Unix-like systems that cannot be so
37556 configured: they submit messages using the command line interface of
37557 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37558 messages this way.
37559
37560 If the personal computer runs continuously, there is no problem, because it can
37561 run a conventional MTA that handles delivery to the smart host, and deal with
37562 any delays via its queueing mechanism. However, if the computer does not run
37563 continuously or runs different operating systems at different times, queueing
37564 email is not desirable.
37565
37566 There is therefore a requirement for something that can provide the
37567 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37568 any queueing or retrying facilities. Furthermore, the delivery to the smart
37569 host should be synchronous, so that if it fails, the sending MUA is immediately
37570 informed. In other words, we want something that extends an MUA that submits
37571 to a local MTA via the command line so that it behaves like one that submits
37572 to a remote smart host using TCP/SMTP.
37573
37574 There are a number of applications (for example, there is one called &'ssmtp'&)
37575 that do this job. However, people have found them to be lacking in various
37576 ways. For instance, you might want to allow aliasing and forwarding to be done
37577 before sending a message to the smart host.
37578
37579 Exim already had the necessary infrastructure for doing this job. Just a few
37580 tweaks were needed to make it behave as required, though it is somewhat of an
37581 overkill to use a fully-featured MTA for this purpose.
37582
37583 .oindex "&%mua_wrapper%&"
37584 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37585 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37586 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37587 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37588 compatible router and transport configuration. Typically there will be just one
37589 router and one transport, sending everything to a smart host.
37590
37591 When run in MUA wrapping mode, the behaviour of Exim changes in the
37592 following ways:
37593
37594 .ilist
37595 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37596 In other words, the only way to submit messages is via the command line.
37597 .next
37598 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37599 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37600 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37601 does not finish until the delivery attempt is complete. If the delivery is
37602 successful, a zero return code is given.
37603 .next
37604 Address redirection is permitted, but the final routing for all addresses must
37605 be to the same remote transport, and to the same list of hosts. Furthermore,
37606 the return address (envelope sender) must be the same for all recipients, as
37607 must any added or deleted header lines. In other words, it must be possible to
37608 deliver the message in a single SMTP transaction, however many recipients there
37609 are.
37610 .next
37611 If these conditions are not met, or if routing any address results in a
37612 failure or defer status, or if Exim is unable to deliver all the recipients
37613 successfully to one of the smart hosts, delivery of the entire message fails.
37614 .next
37615 Because no queueing is allowed, all failures are treated as permanent; there
37616 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37617 smart host. Furthermore, because only a single yes/no response can be given to
37618 the caller, it is not possible to deliver to some recipients and not others. If
37619 there is an error (temporary or permanent) for any recipient, all are failed.
37620 .next
37621 If more than one smart host is listed, Exim will try another host after a
37622 connection failure or a timeout, in the normal way. However, if this kind of
37623 failure happens for all the hosts, the delivery fails.
37624 .next
37625 When delivery fails, an error message is written to the standard error stream
37626 (as well as to Exim's log), and Exim exits to the caller with a return code
37627 value 1. The message is expunged from Exim's spool files. No bounce messages
37628 are ever generated.
37629 .next
37630 No retry data is maintained, and any retry rules are ignored.
37631 .next
37632 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37633 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37634 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37635 .endlist
37636
37637 The overall effect is that Exim makes a single synchronous attempt to deliver
37638 the message, failing if there is any kind of problem. Because no local
37639 deliveries are done and no daemon can be run, Exim does not need root
37640 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37641 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37642 the advantages and disadvantages of running without root privilege.
37643
37644
37645
37646
37647 . ////////////////////////////////////////////////////////////////////////////
37648 . ////////////////////////////////////////////////////////////////////////////
37649
37650 .chapter "Log files" "CHAPlog"
37651 .scindex IIDloggen "log" "general description"
37652 .cindex "log" "types of"
37653 Exim writes three different logs, referred to as the main log, the reject log,
37654 and the panic log:
37655
37656 .ilist
37657 .cindex "main log"
37658 The main log records the arrival of each message and each delivery in a single
37659 line in each case. The format is as compact as possible, in an attempt to keep
37660 down the size of log files. Two-character flag sequences make it easy to pick
37661 out these lines. A number of other events are recorded in the main log. Some of
37662 them are optional, in which case the &%log_selector%& option controls whether
37663 they are included or not. A Perl script called &'eximstats'&, which does simple
37664 analysis of main log files, is provided in the Exim distribution (see section
37665 &<<SECTmailstat>>&).
37666 .next
37667 .cindex "reject log"
37668 The reject log records information from messages that are rejected as a result
37669 of a configuration option (that is, for policy reasons).
37670 The first line of each rejection is a copy of the line that is also written to
37671 the main log. Then, if the message's header has been read at the time the log
37672 is written, its contents are written to this log. Only the original header
37673 lines are available; header lines added by ACLs are not logged. You can use the
37674 reject log to check that your policy controls are working correctly; on a busy
37675 host this may be easier than scanning the main log for rejection messages. You
37676 can suppress the writing of the reject log by setting &%write_rejectlog%&
37677 false.
37678 .next
37679 .cindex "panic log"
37680 .cindex "system log"
37681 When certain serious errors occur, Exim writes entries to its panic log. If the
37682 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37683 are usually written to the main log as well, but can get lost amid the mass of
37684 other entries. The panic log should be empty under normal circumstances. It is
37685 therefore a good idea to check it (or to have a &'cron'& script check it)
37686 regularly, in order to become aware of any problems. When Exim cannot open its
37687 panic log, it tries as a last resort to write to the system log (syslog). This
37688 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37689 message itself is written at priority LOG_CRIT.
37690 .endlist
37691
37692 Every log line starts with a timestamp, in the format shown in the following
37693 example. Note that many of the examples shown in this chapter are line-wrapped.
37694 In the log file, this would be all on one line:
37695 .code
37696 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37697   by QUIT
37698 .endd
37699 By default, the timestamps are in the local timezone. There are two
37700 ways of changing this:
37701
37702 .ilist
37703 You can set the &%timezone%& option to a different time zone; in particular, if
37704 you set
37705 .code
37706 timezone = UTC
37707 .endd
37708 the timestamps will be in UTC (aka GMT).
37709 .next
37710 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37711 example:
37712 .code
37713 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37714 .endd
37715 .endlist
37716
37717 .cindex "log" "process ids in"
37718 .cindex "pid (process id)" "in log lines"
37719 Exim does not include its process id in log lines by default, but you can
37720 request that it does so by specifying the &`pid`& log selector (see section
37721 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37722 brackets, immediately after the time and date.
37723
37724
37725
37726
37727 .section "Where the logs are written" "SECTwhelogwri"
37728 .cindex "log" "destination"
37729 .cindex "log" "to file"
37730 .cindex "log" "to syslog"
37731 .cindex "syslog"
37732 The logs may be written to local files, or to syslog, or both. However, it
37733 should be noted that many syslog implementations use UDP as a transport, and
37734 are therefore unreliable in the sense that messages are not guaranteed to
37735 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37736 It has also been reported that on large log files (tens of megabytes) you may
37737 need to tweak syslog to prevent it syncing the file with each write &-- on
37738 Linux this has been seen to make syslog take 90% plus of CPU time.
37739
37740 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37741 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37742 configuration. This latter string is expanded, so it can contain, for example,
37743 references to the host name:
37744 .code
37745 log_file_path = /var/log/$primary_hostname/exim_%slog
37746 .endd
37747 It is generally advisable, however, to set the string in &_Local/Makefile_&
37748 rather than at runtime, because then the setting is available right from the
37749 start of Exim's execution. Otherwise, if there's something it wants to log
37750 before it has read the configuration file (for example, an error in the
37751 configuration file) it will not use the path you want, and may not be able to
37752 log at all.
37753
37754 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37755 list, currently limited to at most two items. This is one option where the
37756 facility for changing a list separator may not be used. The list must always be
37757 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37758 otherwise the item must either be an absolute path, containing &`%s`& at the
37759 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37760 implying the use of a default path.
37761
37762 When Exim encounters an empty item in the list, it searches the list defined by
37763 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37764 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37765 mean &"use the path specified at build time"&. It no such item exists, log
37766 files are written in the &_log_& subdirectory of the spool directory. This is
37767 equivalent to the setting:
37768 .code
37769 log_file_path = $spool_directory/log/%slog
37770 .endd
37771 If you do not specify anything at build time or runtime,
37772 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37773 that is where the logs are written.
37774
37775 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37776 are in use &-- see section &<<SECTdatlogfil>>& below.
37777
37778 Here are some examples of possible settings:
37779 .display
37780 &`LOG_FILE_PATH=syslog                    `& syslog only
37781 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37782 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37783 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37784 .endd
37785 If there are more than two paths in the list, the first is used and a panic
37786 error is logged.
37787
37788
37789
37790 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37791 .cindex "log" "cycling local files"
37792 .cindex "cycling logs"
37793 .cindex "&'exicyclog'&"
37794 .cindex "log" "local files; writing to"
37795 Some operating systems provide centralized and standardized methods for cycling
37796 log files. For those that do not, a utility script called &'exicyclog'& is
37797 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37798 main and reject logs each time it is called. The maximum number of old logs to
37799 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37800
37801 An Exim delivery process opens the main log when it first needs to write to it,
37802 and it keeps the file open in case subsequent entries are required &-- for
37803 example, if a number of different deliveries are being done for the same
37804 message. However, remote SMTP deliveries can take a long time, and this means
37805 that the file may be kept open long after it is renamed if &'exicyclog'& or
37806 something similar is being used to rename log files on a regular basis. To
37807 ensure that a switch of log files is noticed as soon as possible, Exim calls
37808 &[stat()]& on the main log's name before reusing an open file, and if the file
37809 does not exist, or its inode has changed, the old file is closed and Exim
37810 tries to open the main log from scratch. Thus, an old log file may remain open
37811 for quite some time, but no Exim processes should write to it once it has been
37812 renamed.
37813
37814
37815
37816 .section "Datestamped log files" "SECTdatlogfil"
37817 .cindex "log" "datestamped files"
37818 Instead of cycling the main and reject log files by renaming them
37819 periodically, some sites like to use files whose names contain a datestamp,
37820 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37821 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37822 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37823 point where the datestamp is required. For example:
37824 .code
37825 log_file_path = /var/spool/exim/log/%slog-%D
37826 log_file_path = /var/log/exim-%s-%D.log
37827 log_file_path = /var/spool/exim/log/%D-%slog
37828 log_file_path = /var/log/exim/%s.%M
37829 .endd
37830 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37831 examples of names generated by the above examples:
37832 .code
37833 /var/spool/exim/log/mainlog-20021225
37834 /var/log/exim-reject-20021225.log
37835 /var/spool/exim/log/20021225-mainlog
37836 /var/log/exim/main.200212
37837 .endd
37838 When this form of log file is specified, Exim automatically switches to new
37839 files at midnight. It does not make any attempt to compress old logs; you
37840 will need to write your own script if you require this. You should not
37841 run &'exicyclog'& with this form of logging.
37842
37843 The location of the panic log is also determined by &%log_file_path%&, but it
37844 is not datestamped, because rotation of the panic log does not make sense.
37845 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37846 the string. In addition, if it immediately follows a slash, a following
37847 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37848 character is removed. Thus, the four examples above would give these panic
37849 log names:
37850 .code
37851 /var/spool/exim/log/paniclog
37852 /var/log/exim-panic.log
37853 /var/spool/exim/log/paniclog
37854 /var/log/exim/panic
37855 .endd
37856
37857
37858 .section "Logging to syslog" "SECID249"
37859 .cindex "log" "syslog; writing to"
37860 The use of syslog does not change what Exim logs or the format of its messages,
37861 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37862 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37863 that, the same strings are written to syslog as to log files. The syslog
37864 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37865 by default, but you can change these by setting the &%syslog_facility%& and
37866 &%syslog_processname%& options, respectively. If Exim was compiled with
37867 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37868 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37869 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37870 the time and host name to each line.
37871 The three log streams are mapped onto syslog priorities as follows:
37872
37873 .ilist
37874 &'mainlog'& is mapped to LOG_INFO
37875 .next
37876 &'rejectlog'& is mapped to LOG_NOTICE
37877 .next
37878 &'paniclog'& is mapped to LOG_ALERT
37879 .endlist
37880
37881 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37882 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37883 these are routed by syslog to the same place. You can suppress this duplication
37884 by setting &%syslog_duplication%& false.
37885
37886 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37887 entries contain multiple lines when headers are included. To cope with both
37888 these cases, entries written to syslog are split into separate &[syslog()]&
37889 calls at each internal newline, and also after a maximum of
37890 870 data characters. (This allows for a total syslog line length of 1024, when
37891 additions such as timestamps are added.) If you are running a syslog
37892 replacement that can handle lines longer than the 1024 characters allowed by
37893 RFC 3164, you should set
37894 .code
37895 SYSLOG_LONG_LINES=yes
37896 .endd
37897 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37898 lines, but it still splits at internal newlines in &'reject'& log entries.
37899
37900 To make it easy to re-assemble split lines later, each component of a split
37901 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37902 where <&'n'&> is the component number and <&'m'&> is the total number of
37903 components in the entry. The / delimiter is used when the line was split
37904 because it was too long; if it was split because of an internal newline, the \
37905 delimiter is used. For example, supposing the length limit to be 50 instead of
37906 870, the following would be the result of a typical rejection message to
37907 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37908 name, and pid as added by syslog:
37909 .code
37910 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37911 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37912 [3/5]  when scanning for sender: missing or malformed lo
37913 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37914 [5/5] mple>)
37915 .endd
37916 The same error might cause the following lines to be written to &"rejectlog"&
37917 (LOG_NOTICE):
37918 .code
37919 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37920 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37921 [3/18] er when scanning for sender: missing or malformed
37922 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37923 [5\18] .example>)
37924 [6\18] Recipients: ph10@some.domain.cam.example
37925 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37926 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37927 [9\18]        id 16RdAL-0006pc-00
37928 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37929 [11\18] 09:43 +0100
37930 [12\18] F From: <>
37931 [13\18]   Subject: this is a test header
37932 [18\18]   X-something: this is another header
37933 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37934 [16\18] le>
37935 [17\18] B Bcc:
37936 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37937 .endd
37938 Log lines that are neither too long nor contain newlines are written to syslog
37939 without modification.
37940
37941 If only syslog is being used, the Exim monitor is unable to provide a log tail
37942 display, unless syslog is routing &'mainlog'& to a file on the local host and
37943 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37944 where it is.
37945
37946
37947
37948 .section "Log line flags" "SECID250"
37949 One line is written to the main log for each message received, and for each
37950 successful, unsuccessful, and delayed delivery. These lines can readily be
37951 picked out by the distinctive two-character flags that immediately follow the
37952 timestamp. The flags are:
37953 .display
37954 &`<=`&     message arrival
37955 &`(=`&     message fakereject
37956 &`=>`&     normal message delivery
37957 &`->`&     additional address in same delivery
37958 &`>>`&     cutthrough message delivery
37959 &`*>`&     delivery suppressed by &%-N%&
37960 &`**`&     delivery failed; address bounced
37961 &`==`&     delivery deferred; temporary problem
37962 .endd
37963
37964
37965 .section "Logging message reception" "SECID251"
37966 .cindex "log" "reception line"
37967 The format of the single-line entry in the main log that is written for every
37968 message received is shown in the basic example below, which is split over
37969 several lines in order to fit it on the page:
37970 .code
37971 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37972   H=mailer.fict.example [192.168.123.123] U=exim
37973   P=smtp S=5678 id=<incoming message id>
37974 .endd
37975 The address immediately following &"<="& is the envelope sender address. A
37976 bounce message is shown with the sender address &"<>"&, and if it is locally
37977 generated, this is followed by an item of the form
37978 .code
37979 R=<message id>
37980 .endd
37981 which is a reference to the message that caused the bounce to be sent.
37982
37983 .cindex "HELO"
37984 .cindex "EHLO"
37985 For messages from other hosts, the H and U fields identify the remote host and
37986 record the RFC 1413 identity of the user that sent the message, if one was
37987 received. The number given in square brackets is the IP address of the sending
37988 host. If there is a single, unparenthesized  host name in the H field, as
37989 above, it has been verified to correspond to the IP address (see the
37990 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37991 by the remote host in the SMTP HELO or EHLO command, and has not been
37992 verified. If verification yields a different name to that given for HELO or
37993 EHLO, the verified name appears first, followed by the HELO or EHLO
37994 name in parentheses.
37995
37996 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37997 without brackets, in the HELO or EHLO command, leading to entries in
37998 the log containing text like these examples:
37999 .code
38000 H=(10.21.32.43) [192.168.8.34]
38001 H=([10.21.32.43]) [192.168.8.34]
38002 .endd
38003 This can be confusing. Only the final address in square brackets can be relied
38004 on.
38005
38006 For locally generated messages (that is, messages not received over TCP/IP),
38007 the H field is omitted, and the U field contains the login name of the caller
38008 of Exim.
38009
38010 .cindex "authentication" "logging"
38011 .cindex "AUTH" "logging"
38012 For all messages, the P field specifies the protocol used to receive the
38013 message. This is the value that is stored in &$received_protocol$&. In the case
38014 of incoming SMTP messages, the value indicates whether or not any SMTP
38015 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38016 session was encrypted, there is an additional X field that records the cipher
38017 suite that was used.
38018
38019 .cindex log protocol
38020 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38021 hosts that have authenticated themselves using the SMTP AUTH command. The first
38022 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38023 there is an additional item A= followed by the name of the authenticator that
38024 was used. If an authenticated identification was set up by the authenticator's
38025 &%server_set_id%& option, this is logged too, separated by a colon from the
38026 authenticator name.
38027
38028 .cindex "size" "of message"
38029 The id field records the existing message id, if present. The size of the
38030 received message is given by the S field. When the message is delivered,
38031 headers may be removed or added, so that the size of delivered copies of the
38032 message may not correspond with this value (and indeed may be different to each
38033 other).
38034
38035 The &%log_selector%& option can be used to request the logging of additional
38036 data when a message is received. See section &<<SECTlogselector>>& below.
38037
38038
38039
38040 .section "Logging deliveries" "SECID252"
38041 .cindex "log" "delivery line"
38042 The format of the single-line entry in the main log that is written for every
38043 delivery is shown in one of the examples below, for local and remote
38044 deliveries, respectively. Each example has been split into multiple lines in order
38045 to fit it on the page:
38046 .code
38047 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38048   <marv@hitch.fict.example> R=localuser T=local_delivery
38049 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38050   monk@holistic.fict.example R=dnslookup T=remote_smtp
38051   H=holistic.fict.example [192.168.234.234]
38052 .endd
38053 For ordinary local deliveries, the original address is given in angle brackets
38054 after the final delivery address, which might be a pipe or a file. If
38055 intermediate address(es) exist between the original and the final address, the
38056 last of these is given in parentheses after the final address. The R and T
38057 fields record the router and transport that were used to process the address.
38058
38059 If SMTP AUTH was used for the delivery there is an additional item A=
38060 followed by the name of the authenticator that was used.
38061 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38062 option, this is logged too, separated by a colon from the authenticator name.
38063
38064 If a shadow transport was run after a successful local delivery, the log line
38065 for the successful delivery has an item added on the end, of the form
38066 .display
38067 &`ST=<`&&'shadow transport name'&&`>`&
38068 .endd
38069 If the shadow transport did not succeed, the error message is put in
38070 parentheses afterwards.
38071
38072 .cindex "asterisk" "after IP address"
38073 When more than one address is included in a single delivery (for example, two
38074 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38075 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38076 down a single SMTP connection, an asterisk follows the IP address in the log
38077 lines for the second and subsequent messages.
38078 When two or more messages are delivered down a single TLS connection, the
38079 DNS and some TLS-related information logged for the first message delivered
38080 will not be present in the log lines for the second and subsequent messages.
38081 TLS cipher information is still available.
38082
38083 .cindex "delivery" "cutthrough; logging"
38084 .cindex "cutthrough" "logging"
38085 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38086 line precedes the reception line, since cutthrough waits for a possible
38087 rejection from the destination in case it can reject the sourced item.
38088
38089 The generation of a reply message by a filter file gets logged as a
38090 &"delivery"& to the addressee, preceded by &">"&.
38091
38092 The &%log_selector%& option can be used to request the logging of additional
38093 data when a message is delivered. See section &<<SECTlogselector>>& below.
38094
38095
38096 .section "Discarded deliveries" "SECID253"
38097 .cindex "discarded messages"
38098 .cindex "message" "discarded"
38099 .cindex "delivery" "discarded; logging"
38100 When a message is discarded as a result of the command &"seen finish"& being
38101 obeyed in a filter file which generates no deliveries, a log entry of the form
38102 .code
38103 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38104   <low.club@bridge.example> R=userforward
38105 .endd
38106 is written, to record why no deliveries are logged. When a message is discarded
38107 because it is aliased to &":blackhole:"& the log line is like this:
38108 .code
38109 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38110   <hole@nowhere.example> R=blackhole_router
38111 .endd
38112
38113
38114 .section "Deferred deliveries" "SECID254"
38115 When a delivery is deferred, a line of the following form is logged:
38116 .code
38117 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38118   R=dnslookup T=smtp defer (146): Connection refused
38119 .endd
38120 In the case of remote deliveries, the error is the one that was given for the
38121 last IP address that was tried. Details of individual SMTP failures are also
38122 written to the log, so the above line would be preceded by something like
38123 .code
38124 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38125   mail1.endrest.example [192.168.239.239]: Connection refused
38126 .endd
38127 When a deferred address is skipped because its retry time has not been reached,
38128 a message is written to the log, but this can be suppressed by setting an
38129 appropriate value in &%log_selector%&.
38130
38131
38132
38133 .section "Delivery failures" "SECID255"
38134 .cindex "delivery" "failure; logging"
38135 If a delivery fails because an address cannot be routed, a line of the
38136 following form is logged:
38137 .code
38138 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38139   <jim@trek99.example>: unknown mail domain
38140 .endd
38141 If a delivery fails at transport time, the router and transport are shown, and
38142 the response from the remote host is included, as in this example:
38143 .code
38144 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38145   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38146   after pipelined RCPT TO:<ace400@pb.example>: host
38147   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38148   <ace400@pb.example>...Addressee unknown
38149 .endd
38150 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38151 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38152 disabling PIPELINING. The log lines for all forms of delivery failure are
38153 flagged with &`**`&.
38154
38155
38156
38157 .section "Fake deliveries" "SECID256"
38158 .cindex "delivery" "fake; logging"
38159 If a delivery does not actually take place because the &%-N%& option has been
38160 used to suppress it, a normal delivery line is written to the log, except that
38161 &"=>"& is replaced by &"*>"&.
38162
38163
38164
38165 .section "Completion" "SECID257"
38166 A line of the form
38167 .code
38168 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38169 .endd
38170 is written to the main log when a message is about to be removed from the spool
38171 at the end of its processing.
38172
38173
38174
38175
38176 .section "Summary of Fields in Log Lines" "SECID258"
38177 .cindex "log" "summary of fields"
38178 A summary of the field identifiers that are used in log lines is shown in
38179 the following table:
38180 .display
38181 &`A   `&        authenticator name (and optional id and sender)
38182 &`C   `&        SMTP confirmation on delivery
38183 &`    `&        command list for &"no mail in SMTP session"&
38184 &`CV  `&        certificate verification status
38185 &`D   `&        duration of &"no mail in SMTP session"&
38186 &`DKIM`&        domain verified in incoming message
38187 &`DN  `&        distinguished name from peer certificate
38188 &`DS  `&        DNSSEC secured lookups
38189 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38190 &`F   `&        sender address (on delivery lines)
38191 &`H   `&        host name and IP address
38192 &`I   `&        local interface used
38193 &`id  `&        message id (from header) for incoming message
38194 &`K   `&        CHUNKING extension used
38195 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38196 &`M8S `&        8BITMIME status for incoming message
38197 &`P   `&        on &`<=`& lines: protocol used
38198 &`    `&        on &`=>`& and &`**`& lines: return path
38199 &`PRDR`&        PRDR extension used
38200 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38201 &`Q   `&        alternate queue name
38202 &`QT  `&        on &`=>`& lines: time spent on queue so far
38203 &`    `&        on &"Completed"& lines: time spent on queue
38204 &`R   `&        on &`<=`& lines: reference for local bounce
38205 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38206 &`RT  `&        on &`<=`& lines: time taken for reception
38207 &`S   `&        size of message in bytes
38208 &`SNI `&        server name indication from TLS client hello
38209 &`ST  `&        shadow transport name
38210 &`T   `&        on &`<=`& lines: message subject (topic)
38211 &`TFO `&        connection took advantage of TCP Fast Open
38212 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38213 &`U   `&        local user or RFC 1413 identity
38214 &`X   `&        TLS cipher suite
38215 .endd
38216
38217
38218 .section "Other log entries" "SECID259"
38219 Various other types of log entry are written from time to time. Most should be
38220 self-explanatory. Among the more common are:
38221
38222 .ilist
38223 .cindex "retry" "time not reached"
38224 &'retry time not reached'&&~&~An address previously suffered a temporary error
38225 during routing or local delivery, and the time to retry has not yet arrived.
38226 This message is not written to an individual message log file unless it happens
38227 during the first delivery attempt.
38228 .next
38229 &'retry time not reached for any host'&&~&~An address previously suffered
38230 temporary errors during remote delivery, and the retry time has not yet arrived
38231 for any of the hosts to which it is routed.
38232 .next
38233 .cindex "spool directory" "file locked"
38234 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38235 some other Exim process is already working on the message. This can be quite
38236 common if queue running processes are started at frequent intervals. The
38237 &'exiwhat'& utility script can be used to find out what Exim processes are
38238 doing.
38239 .next
38240 .cindex "error" "ignored"
38241 &'error ignored'&&~&~There are several circumstances that give rise to this
38242 message:
38243 .olist
38244 Exim failed to deliver a bounce message whose age was greater than
38245 &%ignore_bounce_errors_after%&. The bounce was discarded.
38246 .next
38247 A filter file set up a delivery using the &"noerror"& option, and the delivery
38248 failed. The delivery was discarded.
38249 .next
38250 A delivery set up by a router configured with
38251 . ==== As this is a nested list, any displays it contains must be indented
38252 . ==== as otherwise they are too far to the left.
38253 .code
38254     errors_to = <>
38255 .endd
38256 failed. The delivery was discarded.
38257 .endlist olist
38258 .next
38259 .cindex DKIM "log line"
38260 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38261 logging and the message has a DKIM signature header.
38262 .endlist ilist
38263
38264
38265
38266
38267
38268 .section "Reducing or increasing what is logged" "SECTlogselector"
38269 .cindex "log" "selectors"
38270 By setting the &%log_selector%& global option, you can disable some of Exim's
38271 default logging, or you can request additional logging. The value of
38272 &%log_selector%& is made up of names preceded by plus or minus characters. For
38273 example:
38274 .code
38275 log_selector = +arguments -retry_defer
38276 .endd
38277 The list of optional log items is in the following table, with the default
38278 selection marked by asterisks:
38279 .display
38280 &` 8bitmime                   `&  received 8BITMIME status
38281 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38282 &` address_rewrite            `&  address rewriting
38283 &` all_parents                `&  all parents in => lines
38284 &` arguments                  `&  command line arguments
38285 &`*connection_reject          `&  connection rejections
38286 &`*delay_delivery             `&  immediate delivery delayed
38287 &` deliver_time               `&  time taken to attempt delivery
38288 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38289 &`*dkim                       `&  DKIM verified domain on <= lines
38290 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38291 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38292 &` dnssec                     `&  DNSSEC secured lookups
38293 &`*etrn                       `&  ETRN commands
38294 &`*host_lookup_failed         `&  as it says
38295 &` ident_timeout              `&  timeout for ident connection
38296 &` incoming_interface         `&  local interface on <= and => lines
38297 &` incoming_port              `&  remote port on <= lines
38298 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38299 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38300 &`*msg_id                     `&  on <= lines, Message-ID: header value
38301 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38302 &` outgoing_interface         `&  local interface on => lines
38303 &` outgoing_port              `&  add remote port to => lines
38304 &`*queue_run                  `&  start and end queue runs
38305 &` queue_time                 `&  time on queue for one recipient
38306 &` queue_time_overall         `&  time on queue for whole message
38307 &` pid                        `&  Exim process id
38308 &` pipelining                 `&  PIPELINING use, on <= and => lines
38309 &` proxy                      `&  proxy address on <= and => lines
38310 &` receive_time               `&  time taken to receive message
38311 &` received_recipients        `&  recipients on <= lines
38312 &` received_sender            `&  sender on <= lines
38313 &`*rejected_header            `&  header contents on reject log
38314 &`*retry_defer                `&  &"retry time not reached"&
38315 &` return_path_on_delivery    `&  put return path on => and ** lines
38316 &` sender_on_delivery         `&  add sender to => lines
38317 &`*sender_verify_fail         `&  sender verification failures
38318 &`*size_reject                `&  rejection because too big
38319 &`*skip_delivery              `&  delivery skipped in a queue run
38320 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38321 &` smtp_connection            `&  incoming SMTP connections
38322 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38323 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38324 &` smtp_no_mail               `&  session with no MAIL commands
38325 &` smtp_protocol_error        `&  SMTP protocol errors
38326 &` smtp_syntax_error          `&  SMTP syntax errors
38327 &` subject                    `&  contents of &'Subject:'& on <= lines
38328 &`*tls_certificate_verified   `&  certificate verification status
38329 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38330 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38331 &` tls_resumption             `&  append * to cipher field
38332 &` tls_sni                    `&  TLS SNI on <= lines
38333 &` unknown_in_list            `&  DNS lookup failed in list match
38334
38335 &` all                        `&  all of the above
38336 .endd
38337 See also the &%slow_lookup_log%& main configuration option,
38338 section &<<SECID99>>&
38339
38340 More details on each of these items follows:
38341
38342 .ilist
38343 .cindex "8BITMIME"
38344 .cindex "log" "8BITMIME"
38345 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38346 which may help in tracking down interoperability issues with ancient MTAs
38347 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38348 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38349 &`7BIT`& and &`8BITMIME`& respectively.
38350 .next
38351 .cindex "&%warn%& ACL verb" "log when skipping"
38352 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38353 its conditions cannot be evaluated, a log line to this effect is written if
38354 this log selector is set.
38355 .next
38356 .cindex "log" "rewriting"
38357 .cindex "rewriting" "logging"
38358 &%address_rewrite%&: This applies both to global rewrites and per-transport
38359 rewrites, but not to rewrites in filters run as an unprivileged user (because
38360 such users cannot access the log).
38361 .next
38362 .cindex "log" "full parentage"
38363 &%all_parents%&: Normally only the original and final addresses are logged on
38364 delivery lines; with this selector, intermediate parents are given in
38365 parentheses between them.
38366 .next
38367 .cindex "log" "Exim arguments"
38368 .cindex "Exim arguments, logging"
38369 &%arguments%&: This causes Exim to write the arguments with which it was called
38370 to the main log, preceded by the current working directory. This is a debugging
38371 feature, added to make it easier to find out how certain MUAs call
38372 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38373 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38374 that are empty or that contain white space are quoted. Non-printing characters
38375 are shown as escape sequences. This facility cannot log unrecognized arguments,
38376 because the arguments are checked before the configuration file is read. The
38377 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38378 between the caller and Exim.
38379 .next
38380 .cindex "log" "connection rejections"
38381 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38382 connection is rejected, for whatever reason.
38383 .next
38384 .cindex "log" "delayed delivery"
38385 .cindex "delayed delivery, logging"
38386 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38387 started for an incoming message because the load is too high or too many
38388 messages were received on one connection. Logging does not occur if no delivery
38389 process is started because &%queue_only%& is set or &%-odq%& was used.
38390 .next
38391 .cindex "log" "delivery duration"
38392 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38393 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38394 If millisecond logging is enabled, short times will be shown with greater
38395 precision, eg. &`DT=0.304s`&.
38396 .next
38397 .cindex "log" "message size on delivery"
38398 .cindex "size" "of message"
38399 &%delivery_size%&: For each delivery, the size of message delivered is added to
38400 the &"=>"& line, tagged with S=.
38401 .next
38402 .cindex log "DKIM verification"
38403 .cindex DKIM "verification logging"
38404 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38405 verifies successfully a tag of DKIM is added, with one of the verified domains.
38406 .next
38407 .cindex log "DKIM verification"
38408 .cindex DKIM "verification logging"
38409 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38410 .next
38411 .cindex "log" "dnslist defer"
38412 .cindex "DNS list" "logging defer"
38413 .cindex "black list (DNS)"
38414 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38415 DNS black list suffers a temporary error.
38416 .next
38417 .cindex log dnssec
38418 .cindex dnssec logging
38419 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38420 dns lookups gave secure results a tag of DS is added.
38421 For acceptance this covers the reverse and forward lookups for host name verification.
38422 It does not cover helo-name verification.
38423 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38424 .next
38425 .cindex "log" "ETRN commands"
38426 .cindex "ETRN" "logging"
38427 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38428 is run to determine whether or not it is actually accepted. An invalid ETRN
38429 command, or one received within a message transaction is not logged by this
38430 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38431 .next
38432 .cindex "log" "host lookup failure"
38433 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38434 any addresses, or when a lookup of an IP address fails to find a host name, a
38435 log line is written. This logging does not apply to direct DNS lookups when
38436 routing email addresses, but it does apply to &"byname"& lookups.
38437 .next
38438 .cindex "log" "ident timeout"
38439 .cindex "RFC 1413" "logging timeout"
38440 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38441 client's ident port times out.
38442 .next
38443 .cindex "log" "incoming interface"
38444 .cindex "log" "local interface"
38445 .cindex "log" "local address and port"
38446 .cindex "TCP/IP" "logging local address and port"
38447 .cindex "interface" "logging"
38448 &%incoming_interface%&: The interface on which a message was received is added
38449 to the &"<="& line as an IP address in square brackets, tagged by I= and
38450 followed by a colon and the port number. The local interface and port are also
38451 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38452 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38453 The latter can be disabled by turning off the &%outgoing_interface%& option.
38454 .next
38455 .cindex log "incoming proxy address"
38456 .cindex proxy "logging proxy address"
38457 .cindex "TCP/IP" "logging proxy address"
38458 &%proxy%&: The internal (closest to the system running Exim) IP address
38459 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38460 on a proxied connection
38461 or the &"=>"& line for a message delivered on a proxied connection.
38462 See &<<SECTproxyInbound>>& for more information.
38463 .next
38464 .cindex "log" "incoming remote port"
38465 .cindex "port" "logging remote"
38466 .cindex "TCP/IP" "logging incoming remote port"
38467 .vindex "&$sender_fullhost$&"
38468 .vindex "&$sender_rcvhost$&"
38469 &%incoming_port%&: The remote port number from which a message was received is
38470 added to log entries and &'Received:'& header lines, following the IP address
38471 in square brackets, and separated from it by a colon. This is implemented by
38472 changing the value that is put in the &$sender_fullhost$& and
38473 &$sender_rcvhost$& variables. Recording the remote port number has become more
38474 important with the widening use of NAT (see RFC 2505).
38475 .next
38476 .cindex "log" "dropped connection"
38477 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38478 connection is unexpectedly dropped.
38479 .next
38480 .cindex "log" "millisecond timestamps"
38481 .cindex millisecond logging
38482 .cindex timestamps "millisecond, in logs"
38483 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38484 appended to the seconds value.
38485 .next
38486 .cindex "log" "message id"
38487 &%msg_id%&: The value of the Message-ID: header.
38488 .next
38489 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38490 This will be either because the message is a bounce, or was submitted locally
38491 (submission mode) without one.
38492 The field identifier will have an asterix appended: &"id*="&.
38493 .next
38494 .cindex "log" "outgoing interface"
38495 .cindex "log" "local interface"
38496 .cindex "log" "local address and port"
38497 .cindex "TCP/IP" "logging local address and port"
38498 .cindex "interface" "logging"
38499 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38500 interface on which a message was sent is added to delivery lines as an I= tag
38501 followed by IP address in square brackets. You can disable this by turning
38502 off the &%outgoing_interface%& option.
38503 .next
38504 .cindex "log" "outgoing remote port"
38505 .cindex "port" "logging outgoing remote"
38506 .cindex "TCP/IP" "logging outgoing remote port"
38507 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38508 containing => tags) following the IP address.
38509 The local port is also added if &%incoming_interface%& and
38510 &%outgoing_interface%& are both enabled.
38511 This option is not included in the default setting, because for most ordinary
38512 configurations, the remote port number is always 25 (the SMTP port), and the
38513 local port is a random ephemeral port.
38514 .next
38515 .cindex "log" "process ids in"
38516 .cindex "pid (process id)" "in log lines"
38517 &%pid%&: The current process id is added to every log line, in square brackets,
38518 immediately after the time and date.
38519 .next
38520 .cindex log pipelining
38521 .cindex pipelining "logging outgoing"
38522 &%pipelining%&: A field is added to delivery and accept
38523 log lines when the ESMTP PIPELINING extension was used.
38524 The field is a single "L".
38525
38526 On accept lines, where PIPELINING was offered but not used by the client,
38527 the field has a minus appended.
38528
38529 .cindex "pipelining" "early connection"
38530 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38531 accept "L" fields have a period appended if the feature was
38532 offered but not used, or an asterisk appended if used.
38533 Delivery "L" fields have an asterisk appended if used.
38534
38535 .next
38536 .cindex "log" "queue run"
38537 .cindex "queue runner" "logging"
38538 &%queue_run%&: The start and end of every queue run are logged.
38539 .next
38540 .cindex "log" "queue time"
38541 &%queue_time%&: The amount of time the message has been in the queue on the
38542 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38543 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38544 includes reception time as well as the delivery time for the current address.
38545 This means that it may be longer than the difference between the arrival and
38546 delivery log line times, because the arrival log line is not written until the
38547 message has been successfully received.
38548 If millisecond logging is enabled, short times will be shown with greater
38549 precision, eg. &`QT=1.578s`&.
38550 .next
38551 &%queue_time_overall%&: The amount of time the message has been in the queue on
38552 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38553 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38554 message, so it includes reception time as well as the total delivery time.
38555 .next
38556 .cindex "log" "receive duration"
38557 &%receive_time%&: For each message, the amount of real time it has taken to
38558 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38559 If millisecond logging is enabled, short times will be shown with greater
38560 precision, eg. &`RT=0.204s`&.
38561 .next
38562 .cindex "log" "recipients"
38563 &%received_recipients%&: The recipients of a message are listed in the main log
38564 as soon as the message is received. The list appears at the end of the log line
38565 that is written when a message is received, preceded by the word &"for"&. The
38566 addresses are listed after they have been qualified, but before any rewriting
38567 has taken place.
38568 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38569 in the list.
38570 .next
38571 .cindex "log" "sender reception"
38572 &%received_sender%&: The unrewritten original sender of a message is added to
38573 the end of the log line that records the message's arrival, after the word
38574 &"from"& (before the recipients if &%received_recipients%& is also set).
38575 .next
38576 .cindex "log" "header lines for rejection"
38577 &%rejected_header%&: If a message's header has been received at the time a
38578 rejection is written to the reject log, the complete header is added to the
38579 log. Header logging can be turned off individually for messages that are
38580 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38581 .next
38582 .cindex "log" "retry defer"
38583 &%retry_defer%&: A log line is written if a delivery is deferred because a
38584 retry time has not yet been reached. However, this &"retry time not reached"&
38585 message is always omitted from individual message logs after the first delivery
38586 attempt.
38587 .next
38588 .cindex "log" "return path"
38589 &%return_path_on_delivery%&: The return path that is being transmitted with
38590 the message is included in delivery and bounce lines, using the tag P=.
38591 This is omitted if no delivery actually happens, for example, if routing fails,
38592 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38593 .next
38594 .cindex "log" "sender on delivery"
38595 &%sender_on_delivery%&: The message's sender address is added to every delivery
38596 and bounce line, tagged by F= (for &"from"&).
38597 This is the original sender that was received with the message; it is not
38598 necessarily the same as the outgoing return path.
38599 .next
38600 .cindex "log" "sender verify failure"
38601 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38602 gives details of a sender verification failure is not written. Log lines for
38603 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38604 detail is lost.
38605 .next
38606 .cindex "log" "size rejection"
38607 &%size_reject%&: A log line is written whenever a message is rejected because
38608 it is too big.
38609 .next
38610 .cindex "log" "frozen messages; skipped"
38611 .cindex "frozen messages" "logging skipping"
38612 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38613 queue run because it is frozen or because another process is already delivering
38614 it.
38615 .cindex "&""spool file is locked""&"
38616 The message that is written is &"spool file is locked"&.
38617 .next
38618 .cindex "log" "smtp confirmation"
38619 .cindex "SMTP" "logging confirmation"
38620 .cindex "LMTP" "logging confirmation"
38621 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38622 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38623 A number of MTAs (including Exim) return an identifying string in this
38624 response.
38625 .next
38626 .cindex "log" "SMTP connections"
38627 .cindex "SMTP" "logging connections"
38628 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38629 established or closed, unless the connection is from a host that matches
38630 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38631 only when the closure is unexpected.) This applies to connections from local
38632 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38633 dropped in the middle of a message, a log line is always written, whether or
38634 not this selector is set, but otherwise nothing is written at the start and end
38635 of connections unless this selector is enabled.
38636
38637 For TCP/IP connections to an Exim daemon, the current number of connections is
38638 included in the log message for each new connection, but note that the count is
38639 reset if the daemon is restarted.
38640 Also, because connections are closed (and the closure is logged) in
38641 subprocesses, the count may not include connections that have been closed but
38642 whose termination the daemon has not yet noticed. Thus, while it is possible to
38643 match up the opening and closing of connections in the log, the value of the
38644 logged counts may not be entirely accurate.
38645 .next
38646 .cindex "log" "SMTP transaction; incomplete"
38647 .cindex "SMTP" "logging incomplete transactions"
38648 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38649 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38650 and the message sender plus any accepted recipients are included in the log
38651 line. This can provide evidence of dictionary attacks.
38652 .next
38653 .cindex "log" "non-MAIL SMTP sessions"
38654 .cindex "MAIL" "logging session without"
38655 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38656 connection terminates without having issued a MAIL command. This includes both
38657 the case when the connection is dropped, and the case when QUIT is used. It
38658 does not include cases where the connection is rejected right at the start (by
38659 an ACL, or because there are too many connections, or whatever). These cases
38660 already have their own log lines.
38661
38662 The log line that is written contains the identity of the client in the usual
38663 way, followed by D= and a time, which records the duration of the connection.
38664 If the connection was authenticated, this fact is logged exactly as it is for
38665 an incoming message, with an A= item. If the connection was encrypted, CV=,
38666 DN=, and X= items may appear as they do for an incoming message, controlled by
38667 the same logging options.
38668
38669 Finally, if any SMTP commands were issued during the connection, a C= item
38670 is added to the line, listing the commands that were used. For example,
38671 .code
38672 C=EHLO,QUIT
38673 .endd
38674 shows that the client issued QUIT straight after EHLO. If there were fewer
38675 than 20 commands, they are all listed. If there were more than 20 commands,
38676 the last 20 are listed, preceded by &"..."&. However, with the default
38677 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38678 have been aborted before 20 non-mail commands are processed.
38679 .next
38680 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38681 colon-separated, is appended to the A= item for a message arrival or delivery
38682 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38683 was accepted or used.
38684 .next
38685 .cindex "log" "SMTP protocol error"
38686 .cindex "SMTP" "logging protocol error"
38687 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38688 encountered. Exim does not have perfect detection of all protocol errors
38689 because of transmission delays and the use of pipelining. If PIPELINING has
38690 been advertised to a client, an Exim server assumes that the client will use
38691 it, and therefore it does not count &"expected"& errors (for example, RCPT
38692 received after rejecting MAIL) as protocol errors.
38693 .next
38694 .cindex "SMTP" "logging syntax errors"
38695 .cindex "SMTP" "syntax errors; logging"
38696 .cindex "SMTP" "unknown command; logging"
38697 .cindex "log" "unknown SMTP command"
38698 .cindex "log" "SMTP syntax error"
38699 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38700 encountered. An unrecognized command is treated as a syntax error. For an
38701 external connection, the host identity is given; for an internal connection
38702 using &%-bs%& the sender identification (normally the calling user) is given.
38703 .next
38704 .cindex "log" "subject"
38705 .cindex "subject, logging"
38706 &%subject%&: The subject of the message is added to the arrival log line,
38707 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38708 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38709 specifies whether characters with values greater than 127 should be logged
38710 unchanged, or whether they should be rendered as escape sequences.
38711 .next
38712 .cindex "log" "certificate verification"
38713 .cindex log DANE
38714 .cindex DANE logging
38715 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38716 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38717 verified
38718 using a CA trust anchor,
38719 &`CA=dane`& if using a DNS trust anchor,
38720 and &`CV=no`& if not.
38721 .next
38722 .cindex "log" "TLS cipher"
38723 .cindex "TLS" "logging cipher"
38724 &%tls_cipher%&: When a message is sent or received over an encrypted
38725 connection, the cipher suite used is added to the log line, preceded by X=.
38726 .next
38727 .cindex "log" "TLS peer DN"
38728 .cindex "TLS" "logging peer DN"
38729 &%tls_peerdn%&: When a message is sent or received over an encrypted
38730 connection, and a certificate is supplied by the remote host, the peer DN is
38731 added to the log line, preceded by DN=.
38732 .next
38733 .cindex "log" "TLS resumption"
38734 .cindex "TLS" "logging session resumption"
38735 .new
38736 &%tls_resumption%&: When a message is sent or received over an encrypted
38737 connection and the TLS session resumed one used on a previous TCP connection,
38738 an asterisk is appended to the X= cipher field in the log line.
38739 .wen
38740 .next
38741 .cindex "log" "TLS SNI"
38742 .cindex "TLS" "logging SNI"
38743 .cindex SNI logging
38744 &%tls_sni%&: When a message is received over an encrypted connection, and
38745 the remote host provided the Server Name Indication extension, the SNI is
38746 added to the log line, preceded by SNI=.
38747 .next
38748 .cindex "log" "DNS failure in list"
38749 &%unknown_in_list%&: This setting causes a log entry to be written when the
38750 result of a list match is failure because a DNS lookup failed.
38751 .endlist
38752
38753
38754 .section "Message log" "SECID260"
38755 .cindex "message" "log file for"
38756 .cindex "log" "message log; description of"
38757 .cindex "&_msglog_& directory"
38758 .oindex "&%preserve_message_logs%&"
38759 In addition to the general log files, Exim writes a log file for each message
38760 that it handles. The names of these per-message logs are the message ids, and
38761 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38762 message log contains copies of the log lines that apply to the message. This
38763 makes it easier to inspect the status of an individual message without having
38764 to search the main log. A message log is deleted when processing of the message
38765 is complete, unless &%preserve_message_logs%& is set, but this should be used
38766 only with great care because they can fill up your disk very quickly.
38767
38768 On a heavily loaded system, it may be desirable to disable the use of
38769 per-message logs, in order to reduce disk I/O. This can be done by setting the
38770 &%message_logs%& option false.
38771 .ecindex IIDloggen
38772
38773
38774
38775
38776 . ////////////////////////////////////////////////////////////////////////////
38777 . ////////////////////////////////////////////////////////////////////////////
38778
38779 .chapter "Exim utilities" "CHAPutils"
38780 .scindex IIDutils "utilities"
38781 A number of utility scripts and programs are supplied with Exim and are
38782 described in this chapter. There is also the Exim Monitor, which is covered in
38783 the next chapter. The utilities described here are:
38784
38785 .itable none 0 0 3  7* left  15* left  40* left
38786 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38787   "list what Exim processes are doing"
38788 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38789 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38790 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38791 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38792                                                 various criteria"
38793 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38794 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38795   "extract statistics from the log"
38796 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38797   "check address acceptance from given IP"
38798 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38799 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38800 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38801 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38802 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38803 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38804 .endtable
38805
38806 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38807 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38808 &url(https://duncanthrax.net/exilog/) for details.
38809
38810
38811
38812
38813 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38814 .cindex "&'exiwhat'&"
38815 .cindex "process, querying"
38816 .cindex "SIGUSR1"
38817 On operating systems that can restart a system call after receiving a signal
38818 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38819 a line describing what it is doing to the file &_exim-process.info_& in the
38820 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38821 processes it can find, having first emptied the file. It then waits for one
38822 second to allow the Exim processes to react before displaying the results. In
38823 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38824 send the signal to the Exim processes, so it is normally run as root.
38825
38826 &*Warning*&: This is not an efficient process. It is intended for occasional
38827 use by system administrators. It is not sensible, for example, to set up a
38828 script that sends SIGUSR1 signals to Exim processes at short intervals.
38829
38830
38831 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38832 varies in different operating systems. Not only are different options used,
38833 but the format of the output is different. For this reason, there are some
38834 system configuration options that configure exactly how &'exiwhat'& works. If
38835 it doesn't seem to be working for you, check the following compile-time
38836 options:
38837 .display
38838 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38839 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38840 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38841 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38842 .endd
38843 An example of typical output from &'exiwhat'& is
38844 .code
38845 164 daemon: -q1h, listening on port 25
38846 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38847 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38848   [10.19.42.42] (editor@ref.example)
38849 10592 handling incoming call from [192.168.243.242]
38850 10628 accepting a local non-SMTP message
38851 .endd
38852 The first number in the output line is the process number. The third line has
38853 been split here, in order to fit it on the page.
38854
38855
38856
38857 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38858 .cindex "&'exiqgrep'&"
38859 .cindex "queue" "grepping"
38860 This utility is a Perl script contributed by Matt Hubbard. It runs
38861 .code
38862 exim -bpu
38863 .endd
38864 or (in case &*-a*& switch is specified)
38865 .code
38866 exim -bp
38867 .endd
38868 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38869 contain alternate exim configuration the queue management might be using.
38870
38871 to obtain a queue listing, and then greps the output to select messages
38872 that match given criteria. The following selection options are available:
38873
38874 .vlist
38875 .vitem &*-f*&&~<&'regex'&>
38876 Match the sender address using a case-insensitive search. The field that is
38877 tested is enclosed in angle brackets, so you can test for bounce messages with
38878 .code
38879 exiqgrep -f '^<>$'
38880 .endd
38881 .vitem &*-r*&&~<&'regex'&>
38882 Match a recipient address using a case-insensitive search. The field that is
38883 tested is not enclosed in angle brackets.
38884
38885 .vitem &*-s*&&~<&'regex'&>
38886 Match against the size field.
38887
38888 .vitem &*-y*&&~<&'seconds'&>
38889 Match messages that are younger than the given time.
38890
38891 .vitem &*-o*&&~<&'seconds'&>
38892 Match messages that are older than the given time.
38893
38894 .vitem &*-z*&
38895 Match only frozen messages.
38896
38897 .vitem &*-x*&
38898 Match only non-frozen messages.
38899
38900 .vitem &*-G*&&~<&'queuename'&>
38901 Match only messages in the given queue.  Without this, the default queue is searched.
38902 .endlist
38903
38904 The following options control the format of the output:
38905
38906 .vlist
38907 .vitem &*-c*&
38908 Display only the count of matching messages.
38909
38910 .vitem &*-l*&
38911 Long format &-- display the full message information as output by Exim. This is
38912 the default.
38913
38914 .vitem &*-i*&
38915 Display message ids only.
38916
38917 .vitem &*-b*&
38918 Brief format &-- one line per message.
38919
38920 .vitem &*-R*&
38921 Display messages in reverse order.
38922
38923 .vitem &*-a*&
38924 Include delivered recipients in queue listing.
38925 .endlist
38926
38927 There is one more option, &%-h%&, which outputs a list of options.
38928
38929
38930
38931 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38932 .cindex "&'exiqsumm'&"
38933 .cindex "queue" "summary"
38934 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38935 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38936 running a command such as
38937 .code
38938 exim -bp | exiqsumm
38939 .endd
38940 The output consists of one line for each domain that has messages waiting for
38941 it, as in the following example:
38942 .code
38943 3   2322   74m   66m  msn.com.example
38944 .endd
38945 Each line lists the number of pending deliveries for a domain, their total
38946 volume, and the length of time that the oldest and the newest messages have
38947 been waiting. Note that the number of pending deliveries is greater than the
38948 number of messages when messages have more than one recipient.
38949
38950 A summary line is output at the end. By default the output is sorted on the
38951 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38952 the output to be sorted by oldest message and by count of messages,
38953 respectively. There are also three options that split the messages for each
38954 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38955 separates frozen messages, and &%-s%& separates messages according to their
38956 sender.
38957
38958 The output of &'exim -bp'& contains the original addresses in the message, so
38959 this also applies to the output from &'exiqsumm'&. No domains from addresses
38960 generated by aliasing or forwarding are included (unless the &%one_time%&
38961 option of the &(redirect)& router has been used to convert them into &"top
38962 level"& addresses).
38963
38964
38965
38966
38967 .section "Extracting specific information from the log (exigrep)" &&&
38968          "SECTextspeinf"
38969 .cindex "&'exigrep'&"
38970 .cindex "log" "extracts; grepping for"
38971 The &'exigrep'& utility is a Perl script that searches one or more main log
38972 files for entries that match a given pattern. When it finds a match, it
38973 extracts all the log entries for the relevant message, not just those that
38974 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38975 given message, or all mail for a given user, or for a given host, for example.
38976 The input files can be in Exim log format or syslog format.
38977 If a matching log line is not associated with a specific message, it is
38978 included in &'exigrep'&'s output without any additional lines. The usage is:
38979 .display
38980 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38981 .endd
38982 If no log filenames are given on the command line, the standard input is read.
38983
38984 The &%-t%& argument specifies a number of seconds. It adds an additional
38985 condition for message selection. Messages that are complete are shown only if
38986 they spent more than <&'n'&> seconds in the queue.
38987
38988 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38989 makes it case-sensitive. This may give a performance improvement when searching
38990 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38991 option; with &%-I%& they do not. In both cases it is possible to change the
38992 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38993
38994 The &%-l%& option means &"literal"&, that is, treat all characters in the
38995 pattern as standing for themselves. Otherwise the pattern must be a Perl
38996 regular expression.
38997
38998 The &%-v%& option inverts the matching condition. That is, a line is selected
38999 if it does &'not'& match the pattern.
39000
39001 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39002 that are generated as a result/response to a message that &'exigrep'& matched
39003 normally.
39004
39005 Example of &%-M%&:
39006 user_a sends a message to user_b, which generates a bounce back to user_b. If
39007 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39008 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39009 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39010 when searching for &"user_a"& will show both messages since the bounce is
39011 &"related"& to or a &"result"& of the first message that was found by the
39012 search term.
39013
39014 If the location of a &'zcat'& command is known from the definition of
39015 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39016 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39017 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39018 autodetection of some well known compression extensions.
39019
39020
39021 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39022 .cindex "&'exipick'&"
39023 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39024 lists messages from the queue according to a variety of criteria. For details
39025 of &'exipick'&'s facilities, run &'exipick'& with
39026 the &%--help%& option.
39027
39028
39029 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39030 .cindex "log" "cycling local files"
39031 .cindex "cycling logs"
39032 .cindex "&'exicyclog'&"
39033 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39034 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39035 you are using log files with datestamps in their names (see section
39036 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39037 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39038 There are two command line options for &'exicyclog'&:
39039 .ilist
39040 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39041 default that is set when Exim is built. The default default is 10.
39042 .next
39043 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39044 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39045 overriding the script's default, which is to find the setting from Exim's
39046 configuration.
39047 .endlist
39048
39049 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39050 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39051 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39052 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39053 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39054 logs are handled similarly.
39055
39056 If the limit is greater than 99, the script uses 3-digit numbers such as
39057 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39058 to one that is greater, or &'vice versa'&, you will have to fix the names of
39059 any existing log files.
39060
39061 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39062 the end are deleted. All files with numbers greater than 01 are compressed,
39063 using a compression command which is configured by the COMPRESS_COMMAND
39064 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39065 root &%crontab%& entry of the form
39066 .code
39067 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39068 .endd
39069 assuming you have used the name &"exim"& for the Exim user. You can run
39070 &'exicyclog'& as root if you wish, but there is no need.
39071
39072
39073
39074 .section "Mail statistics (eximstats)" "SECTmailstat"
39075 .cindex "statistics"
39076 .cindex "&'eximstats'&"
39077 A Perl script called &'eximstats'& is provided for extracting statistical
39078 information from log files. The output is either plain text, or HTML.
39079 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39080 . --- 404 error and everything else points to that.
39081
39082 The &'eximstats'& script has been hacked about quite a bit over time. The
39083 latest version is the result of some extensive revision by Steve Campbell. A
39084 lot of information is given by default, but there are options for suppressing
39085 various parts of it. Following any options, the arguments to the script are a
39086 list of files, which should be main log files. For example:
39087 .code
39088 eximstats -nr /var/spool/exim/log/mainlog.01
39089 .endd
39090 By default, &'eximstats'& extracts information about the number and volume of
39091 messages received from or delivered to various hosts. The information is sorted
39092 both by message count and by volume, and the top fifty hosts in each category
39093 are listed on the standard output. Similar information, based on email
39094 addresses or domains instead of hosts can be requested by means of various
39095 options. For messages delivered and received locally, similar statistics are
39096 also produced per user.
39097
39098 The output also includes total counts and statistics about delivery errors, and
39099 histograms showing the number of messages received and deliveries made in each
39100 hour of the day. A delivery with more than one address in its envelope (for
39101 example, an SMTP transaction with more than one RCPT command) is counted
39102 as a single delivery by &'eximstats'&.
39103
39104 Though normally more deliveries than receipts are reported (as messages may
39105 have multiple recipients), it is possible for &'eximstats'& to report more
39106 messages received than delivered, even though the queue is empty at the start
39107 and end of the period in question. If an incoming message contains no valid
39108 recipients, no deliveries are recorded for it. A bounce message is handled as
39109 an entirely separate message.
39110
39111 &'eximstats'& always outputs a grand total summary giving the volume and number
39112 of messages received and deliveries made, and the number of hosts involved in
39113 each case. It also outputs the number of messages that were delayed (that is,
39114 not completely delivered at the first attempt), and the number that had at
39115 least one address that failed.
39116
39117 The remainder of the output is in sections that can be independently disabled
39118 or modified by various options. It consists of a summary of deliveries by
39119 transport, histograms of messages received and delivered per time interval
39120 (default per hour), information about the time messages spent in the queue,
39121 a list of relayed messages, lists of the top fifty sending hosts, local
39122 senders, destination hosts, and destination local users by count and by volume,
39123 and a list of delivery errors that occurred.
39124
39125 The relay information lists messages that were actually relayed, that is, they
39126 came from a remote host and were directly delivered to some other remote host,
39127 without being processed (for example, for aliasing or forwarding) locally.
39128
39129 There are quite a few options for &'eximstats'& to control exactly what it
39130 outputs. These are documented in the Perl script itself, and can be extracted
39131 by running the command &(perldoc)& on the script. For example:
39132 .code
39133 perldoc /usr/exim/bin/eximstats
39134 .endd
39135
39136 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39137 .cindex "&'exim_checkaccess'&"
39138 .cindex "policy control" "checking access"
39139 .cindex "checking access"
39140 The &%-bh%& command line argument allows you to run a fake SMTP session with
39141 debugging output, in order to check what Exim is doing when it is applying
39142 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39143 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39144 sometimes you just want to answer the question &"Does this address have
39145 access?"& without bothering with any further details.
39146
39147 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39148 two arguments, an IP address and an email address:
39149 .code
39150 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39151 .endd
39152 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39153 given email address would be accepted in a RCPT command in a TCP/IP
39154 connection from the host with the given IP address. The output of the utility
39155 is either the word &"accepted"&, or the SMTP error response, for example:
39156 .code
39157 Rejected:
39158 550 Relay not permitted
39159 .endd
39160 When running this test, the utility uses &`<>`& as the envelope sender address
39161 for the MAIL command, but you can change this by providing additional
39162 options. These are passed directly to the Exim command. For example, to specify
39163 that the test is to be run with the sender address &'himself@there.example'&
39164 you can use:
39165 .code
39166 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39167                  -f himself@there.example
39168 .endd
39169 Note that these additional Exim command line items must be given after the two
39170 mandatory arguments.
39171
39172 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39173 while running its checks. You can run checks that include callouts by using
39174 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39175
39176
39177
39178 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39179 .cindex "DBM" "building dbm files"
39180 .cindex "building DBM files"
39181 .cindex "&'exim_dbmbuild'&"
39182 .cindex "lower casing"
39183 .cindex "binary zero" "in lookup key"
39184 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39185 the format used by the &(lsearch)& lookup (see section
39186 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39187 names as keys and the remainder of the information as data. The lower-casing
39188 can be prevented by calling the program with the &%-nolc%& option.
39189
39190 A terminating zero is included as part of the key string. This is expected by
39191 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39192 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39193 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39194 files.
39195
39196 The program requires two arguments: the name of the input file (which can be a
39197 single hyphen to indicate the standard input), and the name of the output file.
39198 It creates the output under a temporary name, and then renames it if all went
39199 well.
39200
39201 .cindex "USE_DB"
39202 If the native DB interface is in use (USE_DB is set in a compile-time
39203 configuration file &-- this is common in free versions of Unix) the two
39204 filenames must be different, because in this mode the Berkeley DB functions
39205 create a single output file using exactly the name given. For example,
39206 .code
39207 exim_dbmbuild /etc/aliases /etc/aliases.db
39208 .endd
39209 reads the system alias file and creates a DBM version of it in
39210 &_/etc/aliases.db_&.
39211
39212 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39213 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39214 environment, the suffixes are added to the second argument of
39215 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39216 when the Berkeley functions are used in compatibility mode (though this is not
39217 recommended), because in that case it adds a &_.db_& suffix to the filename.
39218
39219 If a duplicate key is encountered, the program outputs a warning, and when it
39220 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39221 option is used. By default, only the first of a set of duplicates is used &--
39222 this makes it compatible with &(lsearch)& lookups. There is an option
39223 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39224 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39225 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39226 return code is 2.
39227
39228
39229
39230
39231 .section "Finding individual retry times (exinext)" "SECTfinindret"
39232 .cindex "retry" "times"
39233 .cindex "&'exinext'&"
39234 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39235 fish specific information out of the retry database. Given a mail domain (or a
39236 complete address), it looks up the hosts for that domain, and outputs any retry
39237 information for the hosts or for the domain. At present, the retry information
39238 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39239 output. For example:
39240 .code
39241 $ exinext piglet@milne.fict.example
39242 kanga.milne.example:192.168.8.1 error 146: Connection refused
39243   first failed: 21-Feb-1996 14:57:34
39244   last tried:   21-Feb-1996 14:57:34
39245   next try at:  21-Feb-1996 15:02:34
39246 roo.milne.example:192.168.8.3 error 146: Connection refused
39247   first failed: 20-Jan-1996 13:12:08
39248   last tried:   21-Feb-1996 11:42:03
39249   next try at:  21-Feb-1996 19:42:03
39250   past final cutoff time
39251 .endd
39252 You can also give &'exinext'& a local part, without a domain, and it
39253 will give any retry information for that local part in your default domain.
39254 A message id can be used to obtain retry information pertaining to a specific
39255 message. This exists only when an attempt to deliver a message to a remote host
39256 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39257 &'exinext'& is not particularly efficient, but then it is not expected to be
39258 run very often.
39259
39260 The &'exinext'& utility calls Exim to find out information such as the location
39261 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39262 passed on to the &'exim'& commands. The first specifies an alternate Exim
39263 configuration file, and the second sets macros for use within the configuration
39264 file. These features are mainly to help in testing, but might also be useful in
39265 environments where more than one configuration file is in use.
39266
39267
39268
39269 .section "Hints database maintenance" "SECThindatmai"
39270 .cindex "hints database" "maintenance"
39271 .cindex "maintaining Exim's hints database"
39272 Three utility programs are provided for maintaining the DBM files that Exim
39273 uses to contain its delivery hint information. Each program requires two
39274 arguments. The first specifies the name of Exim's spool directory, and the
39275 second is the name of the database it is to operate on. These are as follows:
39276
39277 .ilist
39278 &'retry'&: the database of retry information
39279 .next
39280 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39281 for remote hosts
39282 .next
39283 &'callout'&: the callout cache
39284 .next
39285 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39286 .next
39287 .new
39288 &'tls'&: TLS session resumption data
39289 .wen
39290 .next
39291 &'misc'&: other hints data
39292 .endlist
39293
39294 The &'misc'& database is used for
39295
39296 .ilist
39297 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39298 .next
39299 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39300 &(smtp)& transport)
39301 .next
39302 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39303 in a transport)
39304 .endlist
39305
39306
39307
39308 .section "exim_dumpdb" "SECID261"
39309 .cindex "&'exim_dumpdb'&"
39310 The entire contents of a database are written to the standard output by the
39311 &'exim_dumpdb'& program, which has no options or arguments other than the
39312 spool and database names. For example, to dump the retry database:
39313 .code
39314 exim_dumpdb /var/spool/exim retry
39315 .endd
39316 Two lines of output are produced for each entry:
39317 .code
39318 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39319 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39320 .endd
39321 The first item on the first line is the key of the record. It starts with one
39322 of the letters R, or T, depending on whether it refers to a routing or
39323 transport retry. For a local delivery, the next part is the local address; for
39324 a remote delivery it is the name of the remote host, followed by its failing IP
39325 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39326 transport). If the remote port is not the standard one (port 25), it is added
39327 to the IP address. Then there follows an error code, an additional error code,
39328 and a textual description of the error.
39329
39330 The three times on the second line are the time of first failure, the time of
39331 the last delivery attempt, and the computed time for the next attempt. The line
39332 ends with an asterisk if the cutoff time for the last retry rule has been
39333 exceeded.
39334
39335 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39336 consists of a host name followed by a list of ids for messages that are or were
39337 waiting to be delivered to that host. If there are a very large number for any
39338 one host, continuation records, with a sequence number added to the host name,
39339 may be seen. The data in these records is often out of date, because a message
39340 may be routed to several alternative hosts, and Exim makes no effort to keep
39341 cross-references.
39342
39343
39344
39345 .section "exim_tidydb" "SECID262"
39346 .cindex "&'exim_tidydb'&"
39347 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39348 database. If run with no options, it removes all records that are more than 30
39349 days old. The age is calculated from the date and time that the record was last
39350 updated. Note that, in the case of the retry database, it is &'not'& the time
39351 since the first delivery failure. Information about a host that has been down
39352 for more than 30 days will remain in the database, provided that the record is
39353 updated sufficiently often.
39354
39355 The cutoff date can be altered by means of the &%-t%& option, which must be
39356 followed by a time. For example, to remove all records older than a week from
39357 the retry database:
39358 .code
39359 exim_tidydb -t 7d /var/spool/exim retry
39360 .endd
39361 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39362 message ids. In the former these appear as data in records keyed by host &--
39363 they were messages that were waiting for that host &-- and in the latter they
39364 are the keys for retry information for messages that have suffered certain
39365 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39366 message ids in database records are those of messages that are still on the
39367 queue. Message ids for messages that no longer exist are removed from
39368 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39369 For the &'retry'& database, records whose keys are non-existent message ids are
39370 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39371 whenever it removes information from the database.
39372
39373 Certain records are automatically removed by Exim when they are no longer
39374 needed, but others are not. For example, if all the MX hosts for a domain are
39375 down, a retry record is created for each one. If the primary MX host comes back
39376 first, its record is removed when Exim successfully delivers to it, but the
39377 records for the others remain because Exim has not tried to use those hosts.
39378
39379 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39380 hints databases. You should do this at a quiet time of day, because it requires
39381 a database to be locked (and therefore inaccessible to Exim) while it does its
39382 work. Removing records from a DBM file does not normally make the file smaller,
39383 but all the common DBM libraries are able to re-use the space that is released.
39384 After an initial phase of increasing in size, the databases normally reach a
39385 point at which they no longer get any bigger, as long as they are regularly
39386 tidied.
39387
39388 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39389 databases is likely to keep on increasing.
39390
39391
39392
39393
39394 .section "exim_fixdb" "SECID263"
39395 .cindex "&'exim_fixdb'&"
39396 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39397 Its main use is for testing Exim, but it might also be occasionally useful for
39398 getting round problems in a live system. It has no options, and its interface
39399 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39400 key of a database record can then be entered, and the data for that record is
39401 displayed.
39402
39403 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39404 except the &'retry'& database, that is the only operation that can be carried
39405 out. For the &'retry'& database, each field is output preceded by a number, and
39406 data for individual fields can be changed by typing the field number followed
39407 by new data, for example:
39408 .code
39409 > 4 951102:1000
39410 .endd
39411 resets the time of the next delivery attempt. Time values are given as a
39412 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39413 used as optional separators.
39414
39415
39416
39417
39418 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39419 .cindex "mailbox" "maintenance"
39420 .cindex "&'exim_lock'&"
39421 .cindex "locking mailboxes"
39422 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39423 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39424 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39425 a user agent while investigating a problem. The utility requires the name of
39426 the file as its first argument. If the locking is successful, the second
39427 argument is run as a command (using C's &[system()]& function); if there is no
39428 second argument, the value of the SHELL environment variable is used; if this
39429 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39430 is unlocked and the utility ends. The following options are available:
39431
39432 .vlist
39433 .vitem &%-fcntl%&
39434 Use &[fcntl()]& locking on the open mailbox.
39435
39436 .vitem &%-flock%&
39437 Use &[flock()]& locking on the open mailbox, provided the operating system
39438 supports it.
39439
39440 .vitem &%-interval%&
39441 This must be followed by a number, which is a number of seconds; it sets the
39442 interval to sleep between retries (default 3).
39443
39444 .vitem &%-lockfile%&
39445 Create a lock file before opening the mailbox.
39446
39447 .vitem &%-mbx%&
39448 Lock the mailbox using MBX rules.
39449
39450 .vitem &%-q%&
39451 Suppress verification output.
39452
39453 .vitem &%-retries%&
39454 This must be followed by a number; it sets the number of times to try to get
39455 the lock (default 10).
39456
39457 .vitem &%-restore_time%&
39458 This option causes &%exim_lock%& to restore the modified and read times to the
39459 locked file before exiting. This allows you to access a locked mailbox (for
39460 example, to take a backup copy) without disturbing the times that the user
39461 subsequently sees.
39462
39463 .vitem &%-timeout%&
39464 This must be followed by a number, which is a number of seconds; it sets a
39465 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39466 default), a non-blocking call is used.
39467
39468 .vitem &%-v%&
39469 Generate verbose output.
39470 .endlist
39471
39472 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39473 default is to create a lock file and also to use &[fcntl()]& locking on the
39474 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39475 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39476 requires that the directory containing the file be writeable. Locking by lock
39477 file does not last forever; Exim assumes that a lock file is expired if it is
39478 more than 30 minutes old.
39479
39480 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39481 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39482 to be taken out on the open mailbox, and an exclusive lock on the file
39483 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39484 number of the mailbox file. When the locking is released, if an exclusive lock
39485 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39486
39487 The default output contains verification of the locking that takes place. The
39488 &%-v%& option causes some additional information to be given. The &%-q%& option
39489 suppresses all output except error messages.
39490
39491 A command such as
39492 .code
39493 exim_lock /var/spool/mail/spqr
39494 .endd
39495 runs an interactive shell while the file is locked, whereas
39496 .display
39497 &`exim_lock -q /var/spool/mail/spqr <<End`&
39498 <&'some commands'&>
39499 &`End`&
39500 .endd
39501 runs a specific non-interactive sequence of commands while the file is locked,
39502 suppressing all verification output. A single command can be run by a command
39503 such as
39504 .code
39505 exim_lock -q /var/spool/mail/spqr \
39506   "cp /var/spool/mail/spqr /some/where"
39507 .endd
39508 Note that if a command is supplied, it must be entirely contained within the
39509 second argument &-- hence the quotes.
39510 .ecindex IIDutils
39511
39512
39513 . ////////////////////////////////////////////////////////////////////////////
39514 . ////////////////////////////////////////////////////////////////////////////
39515
39516 .chapter "The Exim monitor" "CHAPeximon"
39517 .scindex IIDeximon "Exim monitor" "description"
39518 .cindex "X-windows"
39519 .cindex "&'eximon'&"
39520 .cindex "Local/eximon.conf"
39521 .cindex "&_exim_monitor/EDITME_&"
39522 The Exim monitor is an application which displays in an X window information
39523 about the state of Exim's queue and what Exim is doing. An admin user can
39524 perform certain operations on messages from this GUI interface; however all
39525 such facilities are also available from the command line, and indeed, the
39526 monitor itself makes use of the command line to perform any actions requested.
39527
39528
39529
39530 .section "Running the monitor" "SECID264"
39531 The monitor is started by running the script called &'eximon'&. This is a shell
39532 script that sets up a number of environment variables, and then runs the
39533 binary called &_eximon.bin_&. The default appearance of the monitor window can
39534 be changed by editing the &_Local/eximon.conf_& file created by editing
39535 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39536 parameters are for.
39537
39538 The parameters that get built into the &'eximon'& script can be overridden for
39539 a particular invocation by setting up environment variables of the same names,
39540 preceded by &`EXIMON_`&. For example, a shell command such as
39541 .code
39542 EXIMON_LOG_DEPTH=400 eximon
39543 .endd
39544 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39545 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39546 overrides the Exim log file configuration. This makes it possible to have
39547 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39548 syslog messages are routed to a file on the local host.
39549
39550 X resources can be used to change the appearance of the window in the normal
39551 way. For example, a resource setting of the form
39552 .code
39553 Eximon*background: gray94
39554 .endd
39555 changes the colour of the background to light grey rather than white. The
39556 stripcharts are drawn with both the data lines and the reference lines in
39557 black. This means that the reference lines are not visible when on top of the
39558 data. However, their colour can be changed by setting a resource called
39559 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39560 For example, if your X server is running Unix, you could set up lighter
39561 reference lines in the stripcharts by obeying
39562 .code
39563 xrdb -merge <<End
39564 Eximon*highlight: gray
39565 End
39566 .endd
39567 .cindex "admin user"
39568 In order to see the contents of messages in the queue, and to operate on them,
39569 &'eximon'& must either be run as root or by an admin user.
39570
39571 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39572 contain X11 resource parameters interpreted by the X11 library.  In addition,
39573 if the first parameter starts with the string "gdb" then it is removed and the
39574 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39575 versioned variants of gdb can be invoked).
39576
39577 The monitor's window is divided into three parts. The first contains one or
39578 more stripcharts and two action buttons, the second contains a &"tail"& of the
39579 main log file, and the third is a display of the queue of messages awaiting
39580 delivery, with two more action buttons. The following sections describe these
39581 different parts of the display.
39582
39583
39584
39585
39586 .section "The stripcharts" "SECID265"
39587 .cindex "stripchart"
39588 The first stripchart is always a count of messages in the queue. Its name can
39589 be configured by setting QUEUE_STRIPCHART_NAME in the
39590 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39591 configuration script by regular expression matches on log file entries, making
39592 it possible to display, for example, counts of messages delivered to certain
39593 hosts or using certain transports. The supplied defaults display counts of
39594 received and delivered messages, and of local and SMTP deliveries. The default
39595 period between stripchart updates is one minute; this can be adjusted by a
39596 parameter in the &_Local/eximon.conf_& file.
39597
39598 The stripchart displays rescale themselves automatically as the value they are
39599 displaying changes. There are always 10 horizontal lines in each chart; the
39600 title string indicates the value of each division when it is greater than one.
39601 For example, &"x2"& means that each division represents a value of 2.
39602
39603 It is also possible to have a stripchart which shows the percentage fullness of
39604 a particular disk partition, which is useful when local deliveries are confined
39605 to a single partition.
39606
39607 .cindex "&%statvfs%& function"
39608 This relies on the availability of the &[statvfs()]& function or equivalent in
39609 the operating system. Most, but not all versions of Unix that support Exim have
39610 this. For this particular stripchart, the top of the chart always represents
39611 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39612 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39613 &_Local/eximon.conf_& file.
39614
39615
39616
39617
39618 .section "Main action buttons" "SECID266"
39619 .cindex "size" "of monitor window"
39620 .cindex "Exim monitor" "window size"
39621 .cindex "window size"
39622 Below the stripcharts there is an action button for quitting the monitor. Next
39623 to this is another button marked &"Size"&. They are placed here so that
39624 shrinking the window to its default minimum size leaves just the queue count
39625 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39626 the window to expand to its maximum size, unless it is already at the maximum,
39627 in which case it is reduced to its minimum.
39628
39629 When expanding to the maximum, if the window cannot be fully seen where it
39630 currently is, it is moved back to where it was the last time it was at full
39631 size. When it is expanding from its minimum size, the old position is
39632 remembered, and next time it is reduced to the minimum it is moved back there.
39633
39634 The idea is that you can keep a reduced window just showing one or two
39635 stripcharts at a convenient place on your screen, easily expand it to show
39636 the full window when required, and just as easily put it back to what it was.
39637 The idea is copied from what the &'twm'& window manager does for its
39638 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39639 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39640
39641 Normally, the monitor starts up with the window at its full size, but it can be
39642 built so that it starts up with the window at its smallest size, by setting
39643 START_SMALL=yes in &_Local/eximon.conf_&.
39644
39645
39646
39647 .section "The log display" "SECID267"
39648 .cindex "log" "tail of; in monitor"
39649 The second section of the window is an area in which a display of the tail of
39650 the main log is maintained.
39651 To save space on the screen, the timestamp on each log line is shortened by
39652 removing the date and, if &%log_timezone%& is set, the timezone.
39653 The log tail is not available when the only destination for logging data is
39654 syslog, unless the syslog lines are routed to a local file whose name is passed
39655 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39656
39657 The log sub-window has a scroll bar at its lefthand side which can be used to
39658 move back to look at earlier text, and the up and down arrow keys also have a
39659 scrolling effect. The amount of log that is kept depends on the setting of
39660 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39661 to use. When this is full, the earlier 50% of data is discarded &-- this is
39662 much more efficient than throwing it away line by line. The sub-window also has
39663 a horizontal scroll bar for accessing the ends of long log lines. This is the
39664 only means of horizontal scrolling; the right and left arrow keys are not
39665 available. Text can be cut from this part of the window using the mouse in the
39666 normal way. The size of this subwindow is controlled by parameters in the
39667 configuration file &_Local/eximon.conf_&.
39668
39669 Searches of the text in the log window can be carried out by means of the ^R
39670 and ^S keystrokes, which default to a reverse and a forward search,
39671 respectively. The search covers only the text that is displayed in the window.
39672 It cannot go further back up the log.
39673
39674 The point from which the search starts is indicated by a caret marker. This is
39675 normally at the end of the text in the window, but can be positioned explicitly
39676 by pointing and clicking with the left mouse button, and is moved automatically
39677 by a successful search. If new text arrives in the window when it is scrolled
39678 back, the caret remains where it is, but if the window is not scrolled back,
39679 the caret is moved to the end of the new text.
39680
39681 Pressing ^R or ^S pops up a window into which the search text can be typed.
39682 There are buttons for selecting forward or reverse searching, for carrying out
39683 the search, and for cancelling. If the &"Search"& button is pressed, the search
39684 happens and the window remains so that further searches can be done. If the
39685 &"Return"& key is pressed, a single search is done and the window is closed. If
39686 ^C is typed the search is cancelled.
39687
39688 The searching facility is implemented using the facilities of the Athena text
39689 widget. By default this pops up a window containing both &"search"& and
39690 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39691 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39692 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39693 provided version of &%TextPop%& when the remaining parts of the text widget
39694 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39695 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39696 on these systems, at the expense of having unwanted items in the search popup
39697 window.
39698
39699
39700
39701 .section "The queue display" "SECID268"
39702 .cindex "queue" "display in monitor"
39703 The bottom section of the monitor window contains a list of all messages that
39704 are in the queue, which includes those currently being received or delivered,
39705 as well as those awaiting delivery. The size of this subwindow is controlled by
39706 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39707 at which it is updated is controlled by another parameter in the same file &--
39708 the default is 5 minutes, since queue scans can be quite expensive. However,
39709 there is an &"Update"& action button just above the display which can be used
39710 to force an update of the queue display at any time.
39711
39712 When a host is down for some time, a lot of pending mail can build up for it,
39713 and this can make it hard to deal with other messages in the queue. To help
39714 with this situation there is a button next to &"Update"& called &"Hide"&. If
39715 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39716 type anything in here and press &"Return"&, the text is added to a chain of
39717 such texts, and if every undelivered address in a message matches at least one
39718 of the texts, the message is not displayed.
39719
39720 If there is an address that does not match any of the texts, all the addresses
39721 are displayed as normal. The matching happens on the ends of addresses so, for
39722 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39723 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39724 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39725 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39726 a hide request is automatically cancelled after one hour.
39727
39728 While the dialogue box is displayed, you can't press any buttons or do anything
39729 else to the monitor window. For this reason, if you want to cut text from the
39730 queue display to use in the dialogue box, you have to do the cutting before
39731 pressing the &"Hide"& button.
39732
39733 The queue display contains, for each unhidden queued message, the length of
39734 time it has been in the queue, the size of the message, the message id, the
39735 message sender, and the first undelivered recipient, all on one line. If it is
39736 a bounce message, the sender is shown as &"<>"&. If there is more than one
39737 recipient to which the message has not yet been delivered, subsequent ones are
39738 listed on additional lines, up to a maximum configured number, following which
39739 an ellipsis is displayed. Recipients that have already received the message are
39740 not shown.
39741
39742 .cindex "frozen messages" "display"
39743 If a message is frozen, an asterisk is displayed at the left-hand side.
39744
39745 The queue display has a vertical scroll bar, and can also be scrolled by means
39746 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39747 The text searching facilities, as described above for the log window, are also
39748 available, but the caret is always moved to the end of the text when the queue
39749 display is updated.
39750
39751
39752
39753 .section "The queue menu" "SECID269"
39754 .cindex "queue" "menu in monitor"
39755 If the &%shift%& key is held down and the left button is clicked when the mouse
39756 pointer is over the text for any message, an action menu pops up, and the first
39757 line of the queue display for the message is highlighted. This does not affect
39758 any selected text.
39759
39760 If you want to use some other event for popping up the menu, you can set the
39761 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39762 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39763 value set in this parameter is a standard X event description. For example, to
39764 run eximon using &%ctrl%& rather than &%shift%& you could use
39765 .code
39766 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39767 .endd
39768 The title of the menu is the message id, and it contains entries which act as
39769 follows:
39770
39771 .ilist
39772 &'message log'&: The contents of the message log for the message are displayed
39773 in a new text window.
39774 .next
39775 &'headers'&: Information from the spool file that contains the envelope
39776 information and headers is displayed in a new text window. See chapter
39777 &<<CHAPspool>>& for a description of the format of spool files.
39778 .next
39779 &'body'&: The contents of the spool file containing the body of the message are
39780 displayed in a new text window. There is a default limit of 20,000 bytes to the
39781 amount of data displayed. This can be changed by setting the BODY_MAX
39782 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39783 .next
39784 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39785 delivery of the message. This causes an automatic thaw if the message is
39786 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39787 a new text window. The delivery is run in a separate process, to avoid holding
39788 up the monitor while the delivery proceeds.
39789 .next
39790 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39791 that the message be frozen.
39792 .next
39793 .cindex "thawing messages"
39794 .cindex "unfreezing messages"
39795 .cindex "frozen messages" "thawing"
39796 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39797 that the message be thawed.
39798 .next
39799 .cindex "delivery" "forcing failure"
39800 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39801 that Exim gives up trying to deliver the message. A bounce message is generated
39802 for any remaining undelivered addresses.
39803 .next
39804 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39805 that the message be deleted from the system without generating a bounce
39806 message.
39807 .next
39808 &'add recipient'&: A dialog box is displayed into which a recipient address can
39809 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39810 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39811 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39812 causes a call to Exim to be made using the &%-Mar%& option to request that an
39813 additional recipient be added to the message, unless the entry box is empty, in
39814 which case no action is taken.
39815 .next
39816 &'mark delivered'&: A dialog box is displayed into which a recipient address
39817 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39818 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39819 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39820 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39821 recipient address as already delivered, unless the entry box is empty, in which
39822 case no action is taken.
39823 .next
39824 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39825 mark all recipient addresses as already delivered.
39826 .next
39827 &'edit sender'&: A dialog box is displayed initialized with the current
39828 sender's address. Pressing RETURN causes a call to Exim to be made using the
39829 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39830 in which case no action is taken. If you want to set an empty sender (as in
39831 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39832 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39833 the address is qualified with that domain.
39834 .endlist
39835
39836 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39837 other cases when a call to Exim is made, if there is any output from Exim (in
39838 particular, if the command fails) a window containing the command and the
39839 output is displayed. Otherwise, the results of the action are normally apparent
39840 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39841 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39842 if no output is generated.
39843
39844 The queue display is automatically updated for actions such as freezing and
39845 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39846 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39847 force an update of the display after one of these actions.
39848
39849 In any text window that is displayed as result of a menu action, the normal
39850 cut-and-paste facility is available, and searching can be carried out using ^R
39851 and ^S, as described above for the log tail window.
39852 .ecindex IIDeximon
39853
39854
39855
39856
39857
39858 . ////////////////////////////////////////////////////////////////////////////
39859 . ////////////////////////////////////////////////////////////////////////////
39860
39861 .chapter "Security considerations" "CHAPsecurity"
39862 .scindex IIDsecurcon "security" "discussion of"
39863 This chapter discusses a number of issues concerned with security, some of
39864 which are also covered in other parts of this manual.
39865
39866 For reasons that this author does not understand, some people have promoted
39867 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39868 existence of this chapter in the documentation. However, the intent of the
39869 chapter is simply to describe the way Exim works in relation to certain
39870 security concerns, not to make any specific claims about the effectiveness of
39871 its security as compared with other MTAs.
39872
39873 What follows is a description of the way Exim is supposed to be. Best efforts
39874 have been made to try to ensure that the code agrees with the theory, but an
39875 absence of bugs can never be guaranteed. Any that are reported will get fixed
39876 as soon as possible.
39877
39878
39879 .section "Building a more &""hardened""& Exim" "SECID286"
39880 .cindex "security" "build-time features"
39881 There are a number of build-time options that can be set in &_Local/Makefile_&
39882 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39883 Exim administrator who does not have the root password, or by someone who has
39884 penetrated the Exim (but not the root) account. These options are as follows:
39885
39886 .ilist
39887 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39888 start of any filenames used with the &%-C%& option. When it is set, these
39889 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39890 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39891 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39892 default setting for &%ALT_CONFIG_PREFIX%&.
39893
39894 If the permitted configuration files are confined to a directory to
39895 which only root has access, this guards against someone who has broken
39896 into the Exim account from running a privileged Exim with an arbitrary
39897 configuration file, and using it to break into other accounts.
39898 .next
39899
39900 If a non-trusted configuration file (i.e. not the default configuration file
39901 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39902 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39903 the next item), then root privilege is retained only if the caller of Exim is
39904 root. This locks out the possibility of testing a configuration using &%-C%&
39905 right through message reception and delivery, even if the caller is root. The
39906 reception works, but by that time, Exim is running as the Exim user, so when
39907 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39908 privilege to be lost. However, root can test reception and delivery using two
39909 separate commands.
39910
39911 .next
39912 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39913 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39914 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39915 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39916 the restrictive side.  Requiring build-time selection of safe macros is onerous
39917 but this option is intended solely as a transition mechanism to permit
39918 previously-working configurations to continue to work after release 4.73.
39919 .next
39920 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39921 is disabled.
39922 .next
39923 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39924 never to be used for any deliveries. This is like the &%never_users%& runtime
39925 option, but it cannot be overridden; the runtime option adds additional users
39926 to the list. The default setting is &"root"&; this prevents a non-root user who
39927 is permitted to modify the runtime file from using Exim as a way to get root.
39928 .endlist
39929
39930
39931
39932 .section "Root privilege" "SECID270"
39933 .cindex "setuid"
39934 .cindex "root privilege"
39935 The Exim binary is normally setuid to root, which means that it gains root
39936 privilege (runs as root) when it starts execution. In some special cases (for
39937 example, when the daemon is not in use and there are no local deliveries), it
39938 may be possible to run Exim setuid to some user other than root. This is
39939 discussed in the next section. However, in most installations, root privilege
39940 is required for two things:
39941
39942 .ilist
39943 To set up a socket connected to the standard SMTP port (25) when initialising
39944 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39945 not required.
39946 .next
39947 To be able to change uid and gid in order to read users' &_.forward_& files and
39948 perform local deliveries as the receiving user or as specified in the
39949 configuration.
39950 .endlist
39951
39952 It is not necessary to be root to do any of the other things Exim does, such as
39953 receiving messages and delivering them externally over SMTP, and it is
39954 obviously more secure if Exim does not run as root except when necessary.
39955 For this reason, a user and group for Exim to use must be defined in
39956 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39957 group"&. Their values can be changed by the runtime configuration, though this
39958 is not recommended. Often a user called &'exim'& is used, but some sites use
39959 &'mail'& or another user name altogether.
39960
39961 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39962 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39963 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39964
39965 After a new Exim process has interpreted its command line options, it changes
39966 uid and gid in the following cases:
39967
39968 .ilist
39969 .oindex "&%-C%&"
39970 .oindex "&%-D%&"
39971 If the &%-C%& option is used to specify an alternate configuration file, or if
39972 the &%-D%& option is used to define macro values for the configuration, and the
39973 calling process is not running as root, the uid and gid are changed to those of
39974 the calling process.
39975 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39976 option may not be used at all.
39977 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39978 can be supplied if the calling process is running as root, the Exim run-time
39979 user or CONFIGURE_OWNER, if defined.
39980 .next
39981 .oindex "&%-be%&"
39982 .oindex "&%-bf%&"
39983 .oindex "&%-bF%&"
39984 If the expansion test option (&%-be%&) or one of the filter testing options
39985 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39986 calling process.
39987 .next
39988 If the process is not a daemon process or a queue runner process or a delivery
39989 process or a process for testing address routing (started with &%-bt%&), the
39990 uid and gid are changed to the Exim user and group. This means that Exim always
39991 runs under its own uid and gid when receiving messages. This also applies when
39992 testing address verification
39993 .oindex "&%-bv%&"
39994 .oindex "&%-bh%&"
39995 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39996 option).
39997 .next
39998 For a daemon, queue runner, delivery, or address testing process, the uid
39999 remains as root at this stage, but the gid is changed to the Exim group.
40000 .endlist
40001
40002 The processes that initially retain root privilege behave as follows:
40003
40004 .ilist
40005 A daemon process changes the gid to the Exim group and the uid to the Exim
40006 user after setting up one or more listening sockets. The &[initgroups()]&
40007 function is called, so that if the Exim user is in any additional groups, they
40008 will be used during message reception.
40009 .next
40010 A queue runner process retains root privilege throughout its execution. Its
40011 job is to fork a controlled sequence of delivery processes.
40012 .next
40013 A delivery process retains root privilege throughout most of its execution,
40014 but any actual deliveries (that is, the transports themselves) are run in
40015 subprocesses which always change to a non-root uid and gid. For local
40016 deliveries this is typically the uid and gid of the owner of the mailbox; for
40017 remote deliveries, the Exim uid and gid are used. Once all the delivery
40018 subprocesses have been run, a delivery process changes to the Exim uid and gid
40019 while doing post-delivery tidying up such as updating the retry database and
40020 generating bounce and warning messages.
40021
40022 While the recipient addresses in a message are being routed, the delivery
40023 process runs as root. However, if a user's filter file has to be processed,
40024 this is done in a subprocess that runs under the individual user's uid and
40025 gid. A system filter is run as root unless &%system_filter_user%& is set.
40026 .next
40027 A process that is testing addresses (the &%-bt%& option) runs as root so that
40028 the routing is done in the same environment as a message delivery.
40029 .endlist
40030
40031
40032
40033
40034 .section "Running Exim without privilege" "SECTrunexiwitpri"
40035 .cindex "privilege, running without"
40036 .cindex "unprivileged running"
40037 .cindex "root privilege" "running without"
40038 Some installations like to run Exim in an unprivileged state for more of its
40039 operation, for added security. Support for this mode of operation is provided
40040 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40041 gid are changed to the Exim user and group at the start of a delivery process
40042 (and also queue runner and address testing processes). This means that address
40043 routing is no longer run as root, and the deliveries themselves cannot change
40044 to any other uid.
40045
40046 .cindex SIGHUP
40047 .cindex "daemon" "restarting"
40048 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40049 that the daemon can still be started in the usual way, and it can respond
40050 correctly to SIGHUP because the re-invocation regains root privilege.
40051
40052 An alternative approach is to make Exim setuid to the Exim user and also setgid
40053 to the Exim group. If you do this, the daemon must be started from a root
40054 process. (Calling Exim from a root process makes it behave in the way it does
40055 when it is setuid root.) However, the daemon cannot restart itself after a
40056 SIGHUP signal because it cannot regain privilege.
40057
40058 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40059 stops Exim from trying to re-invoke itself to do a delivery after a message has
40060 been received. Such a re-invocation is a waste of resources because it has no
40061 effect.
40062
40063 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40064 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40065 to the Exim user seems a clean approach, but there is one complication:
40066
40067 In this style of operation, Exim is running with the real uid and gid set to
40068 those of the calling process, and the effective uid/gid set to Exim's values.
40069 Ideally, any association with the calling process' uid/gid should be dropped,
40070 that is, the real uid/gid should be reset to the effective values so as to
40071 discard any privileges that the caller may have. While some operating systems
40072 have a function that permits this action for a non-root effective uid, quite a
40073 number of them do not. Because of this lack of standardization, Exim does not
40074 address this problem at this time.
40075
40076 For this reason, the recommended approach for &"mostly unprivileged"& running
40077 is to keep the Exim binary setuid to root, and to set
40078 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40079 be used in the most straightforward way.
40080
40081 If you configure Exim not to run delivery processes as root, there are a
40082 number of restrictions on what you can do:
40083
40084 .ilist
40085 You can deliver only as the Exim user/group. You should  explicitly use the
40086 &%user%& and &%group%& options to override routers or local transports that
40087 normally deliver as the recipient. This makes sure that configurations that
40088 work in this mode function the same way in normal mode. Any implicit or
40089 explicit specification of another user causes an error.
40090 .next
40091 Use of &_.forward_& files is severely restricted, such that it is usually
40092 not worthwhile to include them in the configuration.
40093 .next
40094 Users who wish to use &_.forward_& would have to make their home directory and
40095 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40096 and their equivalents in Exim filters, cannot be used. While they could be
40097 enabled in the Exim user's name, that would be insecure and not very useful.
40098 .next
40099 Unless the local user mailboxes are all owned by the Exim user (possible in
40100 some POP3 or IMAP-only environments):
40101
40102 .olist
40103 They must be owned by the Exim group and be writeable by that group. This
40104 implies you must set &%mode%& in the appendfile configuration, as well as the
40105 mode of the mailbox files themselves.
40106 .next
40107 You must set &%no_check_owner%&, since most or all of the files will not be
40108 owned by the Exim user.
40109 .next
40110 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40111 on a newly created mailbox when unprivileged. This also implies that new
40112 mailboxes need to be created manually.
40113 .endlist olist
40114 .endlist ilist
40115
40116
40117 These restrictions severely restrict what can be done in local deliveries.
40118 However, there are no restrictions on remote deliveries. If you are running a
40119 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40120 gives more security at essentially no cost.
40121
40122 If you are using the &%mua_wrapper%& facility (see chapter
40123 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40124
40125
40126
40127
40128 .section "Delivering to local files" "SECID271"
40129 Full details of the checks applied by &(appendfile)& before it writes to a file
40130 are given in chapter &<<CHAPappendfile>>&.
40131
40132
40133
40134 .section "Running local commands" "SECTsecconslocalcmds"
40135 .cindex "security" "local commands"
40136 .cindex "security" "command injection attacks"
40137 There are a number of ways in which an administrator can configure Exim to run
40138 commands based upon received, untrustworthy, data. Further, in some
40139 configurations a user who can control a &_.forward_& file can also arrange to
40140 run commands. Configuration to check includes, but is not limited to:
40141
40142 .ilist
40143 Use of &%use_shell%& in the pipe transport: various forms of shell command
40144 injection may be possible with this option present. It is dangerous and should
40145 be used only with considerable caution. Consider constraints which whitelist
40146 allowed characters in a variable which is to be used in a pipe transport that
40147 has &%use_shell%& enabled.
40148 .next
40149 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40150 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40151 &_.forward_& files in a redirect router. If Exim is running on a central mail
40152 hub to which ordinary users do not have shell access, but home directories are
40153 NFS mounted (for instance) then administrators should review the list of these
40154 forbid options available, and should bear in mind that the options that may
40155 need forbidding can change as new features are added between releases.
40156 .next
40157 The &%${run...}%& expansion item does not use a shell by default, but
40158 administrators can configure use of &_/bin/sh_& as part of the command.
40159 Such invocations should be viewed with prejudicial suspicion.
40160 .next
40161 Administrators who use embedded Perl are advised to explore how Perl's
40162 taint checking might apply to their usage.
40163 .next
40164 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40165 administrators are well advised to view its use with suspicion, in case (for
40166 instance) it allows a local-part to contain embedded Exim directives.
40167 .next
40168 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40169 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40170 each can reference arbitrary lists and files, rather than just being a list
40171 of opaque strings.
40172 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40173 real-world security vulnerabilities caused by its use with untrustworthy data
40174 injected in, for SQL injection attacks.
40175 Consider the use of the &%inlisti%& expansion condition instead.
40176 .endlist
40177
40178
40179
40180
40181 .section "Trust in configuration data" "SECTsecconfdata"
40182 .cindex "security" "data sources"
40183 .cindex "security" "regular expressions"
40184 .cindex "regular expressions" "security"
40185 .cindex "PCRE" "security"
40186 If configuration data for Exim can come from untrustworthy sources, there
40187 are some issues to be aware of:
40188
40189 .ilist
40190 Use of &%${expand...}%& may provide a path for shell injection attacks.
40191 .next
40192 Letting untrusted data provide a regular expression is unwise.
40193 .next
40194 Using &%${match...}%& to apply a fixed regular expression against untrusted
40195 data may result in pathological behaviour within PCRE.  Be aware of what
40196 "backtracking" means and consider options for being more strict with a regular
40197 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40198 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40199 possessive quantifiers or just not using regular expressions against untrusted
40200 data.
40201 .next
40202 It can be important to correctly use &%${quote:...}%&,
40203 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40204 items to ensure that data is correctly constructed.
40205 .next
40206 Some lookups might return multiple results, even though normal usage is only
40207 expected to yield one result.
40208 .endlist
40209
40210
40211
40212
40213 .section "IPv4 source routing" "SECID272"
40214 .cindex "source routing" "in IP packets"
40215 .cindex "IP source routing"
40216 Many operating systems suppress IP source-routed packets in the kernel, but
40217 some cannot be made to do this, so Exim does its own check. It logs incoming
40218 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40219 IPv6. No special checking is currently done.
40220
40221
40222
40223 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40224 Support for these SMTP commands is disabled by default. If required, they can
40225 be enabled by defining suitable ACLs.
40226
40227
40228
40229
40230 .section "Privileged users" "SECID274"
40231 .cindex "trusted users"
40232 .cindex "admin user"
40233 .cindex "privileged user"
40234 .cindex "user" "trusted"
40235 .cindex "user" "admin"
40236 Exim recognizes two sets of users with special privileges. Trusted users are
40237 able to submit new messages to Exim locally, but supply their own sender
40238 addresses and information about a sending host. For other users submitting
40239 local messages, Exim sets up the sender address from the uid, and doesn't
40240 permit a remote host to be specified.
40241
40242 .oindex "&%-f%&"
40243 However, an untrusted user is permitted to use the &%-f%& command line option
40244 in the special form &%-f <>%& to indicate that a delivery failure for the
40245 message should not cause an error report. This affects the message's envelope,
40246 but it does not affect the &'Sender:'& header. Untrusted users may also be
40247 permitted to use specific forms of address with the &%-f%& option by setting
40248 the &%untrusted_set_sender%& option.
40249
40250 Trusted users are used to run processes that receive mail messages from some
40251 other mail domain and pass them on to Exim for delivery either locally, or over
40252 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40253 as any user listed in the &%trusted_users%& configuration option, or under any
40254 group listed in the &%trusted_groups%& option.
40255
40256 Admin users are permitted to do things to the messages on Exim's queue. They
40257 can freeze or thaw messages, cause them to be returned to their senders, remove
40258 them entirely, or modify them in various ways. In addition, admin users can run
40259 the Exim monitor and see all the information it is capable of providing, which
40260 includes the contents of files on the spool.
40261
40262 .oindex "&%-M%&"
40263 .oindex "&%-q%&"
40264 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40265 delivery of messages on its queue is restricted to admin users. This
40266 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40267 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40268 queue is also restricted to admin users. This restriction can be relaxed by
40269 setting &%no_queue_list_requires_admin%&.
40270
40271 Exim recognizes an admin user if the calling process is running as root or as
40272 the Exim user or if any of the groups associated with the calling process is
40273 the Exim group. It is not necessary actually to be running under the Exim
40274 group. However, if admin users who are not root or the Exim user are to access
40275 the contents of files on the spool via the Exim monitor (which runs
40276 unprivileged), Exim must be built to allow group read access to its spool
40277 files.
40278
40279 By default, regular users are trusted to perform basic testing and
40280 introspection commands, as themselves.  This setting can be tightened by
40281 setting the &%commandline_checks_require_admin%& option.
40282 This affects most of the checking options,
40283 such as &%-be%& and anything else &%-b*%&.
40284
40285
40286 .section "Spool files" "SECID275"
40287 .cindex "spool directory" "files"
40288 Exim's spool directory and everything it contains is owned by the Exim user and
40289 set to the Exim group. The mode for spool files is defined in the
40290 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40291 any user who is a member of the Exim group can access these files.
40292
40293
40294
40295 .section "Use of argv[0]" "SECID276"
40296 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40297 of specific strings, Exim assumes certain options. For example, calling Exim
40298 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40299 to calling it with the option &%-bS%&. There are no security implications in
40300 this.
40301
40302
40303
40304 .section "Use of %f formatting" "SECID277"
40305 The only use made of &"%f"& by Exim is in formatting load average values. These
40306 are actually stored in integer variables as 1000 times the load average.
40307 Consequently, their range is limited and so therefore is the length of the
40308 converted output.
40309
40310
40311
40312 .section "Embedded Exim path" "SECID278"
40313 Exim uses its own path name, which is embedded in the code, only when it needs
40314 to re-exec in order to regain root privilege. Therefore, it is not root when it
40315 does so. If some bug allowed the path to get overwritten, it would lead to an
40316 arbitrary program's being run as exim, not as root.
40317
40318
40319
40320 .section "Dynamic module directory" "SECTdynmoddir"
40321 Any dynamically loadable modules must be installed into the directory
40322 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40323 loading it.
40324
40325
40326 .section "Use of sprintf()" "SECID279"
40327 .cindex "&[sprintf()]&"
40328 A large number of occurrences of &"sprintf"& in the code are actually calls to
40329 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40330 The intermediate formatting is done into a large fixed buffer by a function
40331 that runs through the format string itself, and checks the length of each
40332 conversion before performing it, thus preventing buffer overruns.
40333
40334 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40335 the output buffer is known to be sufficiently long to contain the converted
40336 string.
40337
40338
40339
40340 .section "Use of debug_printf() and log_write()" "SECID280"
40341 Arbitrary strings are passed to both these functions, but they do their
40342 formatting by calling the function &'string_vformat()'&, which runs through
40343 the format string itself, and checks the length of each conversion.
40344
40345
40346
40347 .section "Use of strcat() and strcpy()" "SECID281"
40348 These are used only in cases where the output buffer is known to be large
40349 enough to hold the result.
40350 .ecindex IIDsecurcon
40351
40352
40353
40354
40355 . ////////////////////////////////////////////////////////////////////////////
40356 . ////////////////////////////////////////////////////////////////////////////
40357
40358 .chapter "Format of spool files" "CHAPspool"
40359 .scindex IIDforspo1 "format" "spool files"
40360 .scindex IIDforspo2 "spool directory" "format of files"
40361 .scindex IIDforspo3 "spool files" "format of"
40362 .cindex "spool files" "editing"
40363 A message on Exim's queue consists of two files, whose names are the message id
40364 followed by -D and -H, respectively. The data portion of the message is kept in
40365 the -D file on its own. The message's envelope, status, and headers are all
40366 kept in the -H file, whose format is described in this chapter. Each of these
40367 two files contains the final component of its own name as its first line. This
40368 is insurance against disk crashes where the directory is lost but the files
40369 themselves are recoverable.
40370
40371 The file formats may be changed, or new formats added, at any release.
40372 Spool files are not intended as an interface to other programs
40373 and should not be used as such.
40374
40375 Some people are tempted into editing -D files in order to modify messages. You
40376 need to be extremely careful if you do this; it is not recommended and you are
40377 on your own if you do it. Here are some of the pitfalls:
40378
40379 .ilist
40380 You must ensure that Exim does not try to deliver the message while you are
40381 fiddling with it. The safest way is to take out a write lock on the -D file,
40382 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40383 place, the lock will be retained. If you write a new file and rename it, the
40384 lock will be lost at the instant of rename.
40385 .next
40386 .vindex "&$body_linecount$&"
40387 If you change the number of lines in the file, the value of
40388 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40389 cause incomplete transmission of messages or undeliverable messages.
40390 .next
40391 If the message is in MIME format, you must take care not to break it.
40392 .next
40393 If the message is cryptographically signed, any change will invalidate the
40394 signature.
40395 .endlist
40396 All in all, modifying -D files is fraught with danger.
40397
40398 Files whose names end with -J may also be seen in the &_input_& directory (or
40399 its subdirectories when &%split_spool_directory%& is set). These are journal
40400 files, used to record addresses to which the message has been delivered during
40401 the course of a delivery attempt. If there are still undelivered recipients at
40402 the end, the -H file is updated, and the -J file is deleted. If, however, there
40403 is some kind of crash (for example, a power outage) before this happens, the -J
40404 file remains in existence. When Exim next processes the message, it notices the
40405 -J file and uses it to update the -H file before starting the next delivery
40406 attempt.
40407
40408 Files whose names end with -K or .eml may also be seen in the spool.
40409 These are temporaries used for DKIM or malware processing, when that is used.
40410 They should be tidied up by normal operations; any old ones are probably
40411 relics of crashes and can be removed.
40412
40413 .section "Format of the -H file" "SECID282"
40414 .cindex "uid (user id)" "in spool file"
40415 .cindex "gid (group id)" "in spool file"
40416 The second line of the -H file contains the login name for the uid of the
40417 process that called Exim to read the message, followed by the numerical uid and
40418 gid. For a locally generated message, this is normally the user who sent the
40419 message. For a message received over TCP/IP via the daemon, it is
40420 normally the Exim user.
40421
40422 The third line of the file contains the address of the message's sender as
40423 transmitted in the envelope, contained in angle brackets. The sender address is
40424 empty for bounce messages. For incoming SMTP mail, the sender address is given
40425 in the MAIL command. For locally generated mail, the sender address is
40426 created by Exim from the login name of the current user and the configured
40427 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40428 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40429 &"<>"& or an address that matches &%untrusted_set_senders%&.
40430
40431 The fourth line contains two numbers. The first is the time that the message
40432 was received, in the conventional Unix form &-- the number of seconds since the
40433 start of the epoch. The second number is a count of the number of messages
40434 warning of delayed delivery that have been sent to the sender.
40435
40436 There follow a number of lines starting with a hyphen. These can appear in any
40437 order, and are omitted when not relevant:
40438
40439 .vlist
40440 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40441 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40442 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40443 recognized, to provide backward compatibility. In the old format, a line of
40444 this form is present for every ACL variable that is not empty. The number
40445 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40446 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40447 the data string for the variable. The string itself starts at the beginning of
40448 the next line, and is followed by a newline character. It may contain internal
40449 newlines.
40450
40451 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40452 A line of this form is present for every ACL connection variable that is
40453 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40454 The length is the length of the data string for the variable. The string itself
40455 starts at the beginning of the next line, and is followed by a newline
40456 character. It may contain internal newlines.
40457
40458 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40459 A line of this form is present for every ACL message variable that is defined.
40460 Note that there is a space between &%-aclm%& and the rest of the name. The
40461 length is the length of the data string for the variable. The string itself
40462 starts at the beginning of the next line, and is followed by a newline
40463 character. It may contain internal newlines.
40464
40465 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40466 This is present if, when the message was received over SMTP, the value of
40467 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40468
40469 .vitem &%-allow_unqualified_recipient%&
40470 This is present if unqualified recipient addresses are permitted in header
40471 lines (to stop such addresses from being qualified if rewriting occurs at
40472 transport time). Local messages that were input using &%-bnq%& and remote
40473 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40474
40475 .vitem &%-allow_unqualified_sender%&
40476 This is present if unqualified sender addresses are permitted in header lines
40477 (to stop such addresses from being qualified if rewriting occurs at transport
40478 time). Local messages that were input using &%-bnq%& and remote messages from
40479 hosts that match &%sender_unqualified_hosts%& set this flag.
40480
40481 .vitem "&%-auth_id%&&~<&'text'&>"
40482 The id information for a message received on an authenticated SMTP connection
40483 &-- the value of the &$authenticated_id$& variable.
40484
40485 .vitem "&%-auth_sender%&&~<&'address'&>"
40486 The address of an authenticated sender &-- the value of the
40487 &$authenticated_sender$& variable.
40488
40489 .vitem "&%-body_linecount%&&~<&'number'&>"
40490 This records the number of lines in the body of the message, and is
40491 present unless &%-spool_file_wireformat%& is.
40492
40493 .vitem "&%-body_zerocount%&&~<&'number'&>"
40494 This records the number of binary zero bytes in the body of the message, and is
40495 present if the number is greater than zero.
40496
40497 .vitem &%-deliver_firsttime%&
40498 This is written when a new message is first added to the spool. When the spool
40499 file is updated after a deferral, it is omitted.
40500
40501 .vitem "&%-frozen%&&~<&'time'&>"
40502 .cindex "frozen messages" "spool data"
40503 The message is frozen, and the freezing happened at <&'time'&>.
40504
40505 .vitem "&%-helo_name%&&~<&'text'&>"
40506 This records the host name as specified by a remote host in a HELO or EHLO
40507 command.
40508
40509 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40510 This records the IP address of the host from which the message was received and
40511 the remote port number that was used. It is omitted for locally generated
40512 messages.
40513
40514 .vitem "&%-host_auth%&&~<&'text'&>"
40515 If the message was received on an authenticated SMTP connection, this records
40516 the name of the authenticator &-- the value of the
40517 &$sender_host_authenticated$& variable.
40518
40519 .vitem &%-host_lookup_failed%&
40520 This is present if an attempt to look up the sending host's name from its IP
40521 address failed. It corresponds to the &$host_lookup_failed$& variable.
40522
40523 .vitem "&%-host_name%&&~<&'text'&>"
40524 .cindex "reverse DNS lookup"
40525 .cindex "DNS" "reverse lookup"
40526 This records the name of the remote host from which the message was received,
40527 if the host name was looked up from the IP address when the message was being
40528 received. It is not present if no reverse lookup was done.
40529
40530 .vitem "&%-ident%&&~<&'text'&>"
40531 For locally submitted messages, this records the login of the originating user,
40532 unless it was a trusted user and the &%-oMt%& option was used to specify an
40533 ident value. For messages received over TCP/IP, this records the ident string
40534 supplied by the remote host, if any.
40535
40536 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40537 This records the IP address of the local interface and the port number through
40538 which a message was received from a remote host. It is omitted for locally
40539 generated messages.
40540
40541 .vitem &%-local%&
40542 The message is from a local sender.
40543
40544 .vitem &%-localerror%&
40545 The message is a locally-generated bounce message.
40546
40547 .vitem "&%-local_scan%&&~<&'string'&>"
40548 This records the data string that was returned by the &[local_scan()]& function
40549 when the message was received &-- the value of the &$local_scan_data$&
40550 variable. It is omitted if no data was returned.
40551
40552 .vitem &%-manual_thaw%&
40553 The message was frozen but has been thawed manually, that is, by an explicit
40554 Exim command rather than via the auto-thaw process.
40555
40556 .vitem &%-N%&
40557 A testing delivery process was started using the &%-N%& option to suppress any
40558 actual deliveries, but delivery was deferred. At any further delivery attempts,
40559 &%-N%& is assumed.
40560
40561 .vitem &%-received_protocol%&
40562 This records the value of the &$received_protocol$& variable, which contains
40563 the name of the protocol by which the message was received.
40564
40565 .vitem &%-sender_set_untrusted%&
40566 The envelope sender of this message was set by an untrusted local caller (used
40567 to ensure that the caller is displayed in queue listings).
40568
40569 .vitem "&%-spam_score_int%&&~<&'number'&>"
40570 If a message was scanned by SpamAssassin, this is present. It records the value
40571 of &$spam_score_int$&.
40572
40573 .vitem &%-spool_file_wireformat%&
40574 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40575 rather than Unix-format.
40576 The line-ending is CRLF rather than newline.
40577 There is still, however, no leading-dot-stuffing.
40578
40579 .vitem &%-tls_certificate_verified%&
40580 A TLS certificate was received from the client that sent this message, and the
40581 certificate was verified by the server.
40582
40583 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40584 When the message was received over an encrypted connection, this records the
40585 name of the cipher suite that was used.
40586
40587 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40588 When the message was received over an encrypted connection, and a certificate
40589 was received from the client, this records the Distinguished Name from that
40590 certificate.
40591 .endlist
40592
40593 Any of the above may have an extra hyphen prepended, to indicate the the
40594 corresponding data is untrusted.
40595
40596 Following the options there is a list of those addresses to which the message
40597 is not to be delivered. This set of addresses is initialized from the command
40598 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40599 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40600 the address is added to this set. The addresses are kept internally as a
40601 balanced binary tree, and it is a representation of that tree which is written
40602 to the spool file. If an address is expanded via an alias or forward file, the
40603 original address is added to the tree when deliveries to all its child
40604 addresses are complete.
40605
40606 If the tree is empty, there is a single line in the spool file containing just
40607 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40608 Y or N, followed by an address. The address is the value for the node of the
40609 tree, and the letters indicate whether the node has a left branch and/or a
40610 right branch attached to it, respectively. If branches exist, they immediately
40611 follow. Here is an example of a three-node tree:
40612 .code
40613 YY darcy@austen.fict.example
40614 NN alice@wonderland.fict.example
40615 NN editor@thesaurus.ref.example
40616 .endd
40617 After the non-recipients tree, there is a list of the message's recipients.
40618 This is a simple list, preceded by a count. It includes all the original
40619 recipients of the message, including those to whom the message has already been
40620 delivered. In the simplest case, the list contains one address per line. For
40621 example:
40622 .code
40623 4
40624 editor@thesaurus.ref.example
40625 darcy@austen.fict.example
40626 rdo@foundation
40627 alice@wonderland.fict.example
40628 .endd
40629 However, when a child address has been added to the top-level addresses as a
40630 result of the use of the &%one_time%& option on a &(redirect)& router, each
40631 line is of the following form:
40632 .display
40633 <&'top-level address'&> <&'errors_to address'&> &&&
40634   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40635 .endd
40636 The 01 flag bit indicates the presence of the three other fields that follow
40637 the top-level address. Other bits may be used in future to support additional
40638 fields. The <&'parent number'&> is the offset in the recipients list of the
40639 original parent of the &"one time"& address. The first two fields are the
40640 envelope sender that is associated with this address and its length. If the
40641 length is zero, there is no special envelope sender (there are then two space
40642 characters in the line). A non-empty field can arise from a &(redirect)& router
40643 that has an &%errors_to%& setting.
40644
40645
40646 A blank line separates the envelope and status information from the headers
40647 which follow. A header may occupy several lines of the file, and to save effort
40648 when reading it in, each header is preceded by a number and an identifying
40649 character. The number is the number of characters in the header, including any
40650 embedded newlines and the terminating newline. The character is one of the
40651 following:
40652
40653 .table2 50pt
40654 .row <&'blank'&>         "header in which Exim has no special interest"
40655 .row &`B`&               "&'Bcc:'& header"
40656 .row &`C`&               "&'Cc:'& header"
40657 .row &`F`&               "&'From:'& header"
40658 .row &`I`&               "&'Message-id:'& header"
40659 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40660 .row &`R`&               "&'Reply-To:'& header"
40661 .row &`S`&               "&'Sender:'& header"
40662 .row &`T`&               "&'To:'& header"
40663 .row &`*`&               "replaced or deleted header"
40664 .endtable
40665
40666 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40667 purposes. They are not transmitted when the message is delivered. Here is a
40668 typical set of headers:
40669 .code
40670 111P Received: by hobbit.fict.example with local (Exim 4.00)
40671 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40672 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40673 038* X-rewrote-sender: bb@hobbit.fict.example
40674 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40675 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40676 099* To: alice@wonderland.fict.example, rdo@foundation,
40677 darcy@austen.fict.example, editor@thesaurus.ref.example
40678 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40679 darcy@austen.fict.example, editor@thesaurus.ref.example
40680 038  Date: Fri, 11 May 2001 10:28:59 +0100
40681 .endd
40682 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40683 &'To:'& header have been rewritten, the last one because routing expanded the
40684 unqualified domain &'foundation'&.
40685 .ecindex IIDforspo1
40686 .ecindex IIDforspo2
40687 .ecindex IIDforspo3
40688
40689 .section "Format of the -D file" "SECID282a"
40690 The data file is traditionally in Unix-standard format: lines are ended with
40691 an ASCII newline character.
40692 However, when the &%spool_wireformat%& main option is used some -D files
40693 can have an alternate format.
40694 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40695 The -D file lines (not including the first name-component line) are
40696 suitable for direct copying to the wire when transmitting using the
40697 ESMTP CHUNKING option, meaning lower processing overhead.
40698 Lines are terminated with an ASCII CRLF pair.
40699 There is no dot-stuffing (and no dot-termination).
40700
40701 . ////////////////////////////////////////////////////////////////////////////
40702 . ////////////////////////////////////////////////////////////////////////////
40703
40704 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
40705          "DKIM, SPF, SRS and DMARC Support"
40706
40707 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40708 .cindex "DKIM"
40709
40710 DKIM is a mechanism by which messages sent by some entity can be provably
40711 linked to a domain which that entity controls.  It permits reputation to
40712 be tracked on a per-domain basis, rather than merely upon source IP address.
40713 DKIM is documented in RFC 6376.
40714
40715 As DKIM relies on the message being unchanged in transit, messages handled
40716 by a mailing-list (which traditionally adds to the message) will not match
40717 any original DKIM signature.
40718
40719 DKIM support is compiled into Exim by default if TLS support is present.
40720 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40721
40722 Exim's DKIM implementation allows for
40723 .olist
40724 Signing outgoing messages: This function is implemented in the SMTP transport.
40725 It can co-exist with all other Exim features
40726 (including transport filters)
40727 except cutthrough delivery.
40728 .next
40729 Verifying signatures in incoming messages: This is implemented by an additional
40730 ACL (acl_smtp_dkim), which can be called several times per message, with
40731 different signature contexts.
40732 .endlist
40733
40734 In typical Exim style, the verification implementation does not include any
40735 default "policy". Instead it enables you to build your own policy using
40736 Exim's standard controls.
40737
40738 Please note that verification of DKIM signatures in incoming mail is turned
40739 on by default for logging (in the <= line) purposes.
40740
40741 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40742 When set, for each signature in incoming email,
40743 exim will log a line displaying the most important signature details, and the
40744 signature status. Here is an example (with line-breaks added for clarity):
40745 .code
40746 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40747     d=facebookmail.com s=q1-2009b
40748     c=relaxed/relaxed a=rsa-sha1
40749     i=@facebookmail.com t=1252484542 [verification succeeded]
40750 .endd
40751
40752 You might want to turn off DKIM verification processing entirely for internal
40753 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40754 control modifier. This should typically be done in the RCPT ACL, at points
40755 where you accept mail from relay sources (internal hosts or authenticated
40756 senders).
40757
40758
40759 .section "Signing outgoing messages" "SECDKIMSIGN"
40760 .cindex "DKIM" "signing"
40761
40762 For signing to be usable you must have published a DKIM record in DNS.
40763 Note that RFC 8301 (which does not cover EC keys) says:
40764 .code
40765 rsa-sha1 MUST NOT be used for signing or verifying.
40766
40767 Signers MUST use RSA keys of at least 1024 bits for all keys.
40768 Signers SHOULD use RSA keys of at least 2048 bits.
40769 .endd
40770
40771 Note also that the key content (the 'p=' field)
40772 in the DNS record is different between RSA and EC keys;
40773 for the former it is the base64 of the ASN.1 for the RSA public key
40774 (equivalent to the private-key .pem with the header/trailer stripped)
40775 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40776
40777 Signing is enabled by setting private options on the SMTP transport.
40778 These options take (expandable) strings as arguments.
40779
40780 .option dkim_domain smtp string list&!! unset
40781 The domain(s) you want to sign with.
40782 After expansion, this can be a list.
40783 Each element in turn,
40784 lowercased,
40785 is put into the &%$dkim_domain%& expansion variable
40786 while expanding the remaining signing options.
40787 If it is empty after expansion, DKIM signing is not done,
40788 and no error will result even if &%dkim_strict%& is set.
40789
40790 .option dkim_selector smtp string list&!! unset
40791 This sets the key selector string.
40792 After expansion, which can use &$dkim_domain$&, this can be a list.
40793 Each element in turn is put in the expansion
40794 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40795 option along with &%$dkim_domain%&.
40796 If the option is empty after expansion, DKIM signing is not done for this domain,
40797 and no error will result even if &%dkim_strict%& is set.
40798
40799 .option dkim_private_key smtp string&!! unset
40800 This sets the private key to use.
40801 You can use the &%$dkim_domain%& and
40802 &%$dkim_selector%& expansion variables to determine the private key to use.
40803 The result can either
40804 .ilist
40805 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40806 .next
40807 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40808 be a valid Ed25519 private key (same format as above)
40809 .next
40810 start with a slash, in which case it is treated as a file that contains
40811 the private key
40812 .next
40813 be "0", "false" or the empty string, in which case the message will not
40814 be signed. This case will not result in an error, even if &%dkim_strict%&
40815 is set.
40816 .endlist
40817
40818 To generate keys under OpenSSL:
40819 .code
40820 openssl genrsa -out dkim_rsa.private 2048
40821 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40822 .endd
40823 The result file from the first command should be retained, and
40824 this option set to use it.
40825 Take the base-64 lines from the output of the second command, concatenated,
40826 for the DNS TXT record.
40827 See section 3.6 of RFC6376 for the record specification.
40828
40829 Under GnuTLS:
40830 .code
40831 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40832 certtool --load-privkey=dkim_rsa.private --pubkey-info
40833 .endd
40834
40835 Note that RFC 8301 says:
40836 .code
40837 Signers MUST use RSA keys of at least 1024 bits for all keys.
40838 Signers SHOULD use RSA keys of at least 2048 bits.
40839 .endd
40840
40841 EC keys for DKIM are defined by RFC 8463.
40842 They are considerably smaller than RSA keys for equivalent protection.
40843 As they are a recent development, users should consider dual-signing
40844 (by setting a list of selectors, and an expansion for this option)
40845 for some transition period.
40846 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40847 for EC keys.
40848
40849 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40850 .code
40851 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40852 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40853 .endd
40854
40855 To produce the required public key value for a DNS record:
40856 .code
40857 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40858 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40859 .endd
40860
40861 Exim also supports an alternate format
40862 of Ed25519 keys in DNS which was a candidate during development
40863 of the standard, but not adopted.
40864 A future release will probably drop that support.
40865
40866 .option dkim_hash smtp string&!! sha256
40867 Can be set to any one of the supported hash methods, which are:
40868 .ilist
40869 &`sha1`& &-- should not be used, is old and insecure
40870 .next
40871 &`sha256`& &-- the default
40872 .next
40873 &`sha512`& &-- possibly more secure but less well supported
40874 .endlist
40875
40876 Note that RFC 8301 says:
40877 .code
40878 rsa-sha1 MUST NOT be used for signing or verifying.
40879 .endd
40880
40881 .option dkim_identity smtp string&!! unset
40882 If set after expansion, the value is used to set an "i=" tag in
40883 the signing header.  The DKIM standards restrict the permissible
40884 syntax of this optional tag to a mail address, with possibly-empty
40885 local part, an @, and a domain identical to or subdomain of the "d="
40886 tag value.  Note that Exim does not check the value.
40887
40888 .option dkim_canon smtp string&!! unset
40889 This option sets the canonicalization method used when signing a message.
40890 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40891 The option defaults to "relaxed" when unset. Note: the current implementation
40892 only supports signing with the same canonicalization method for both headers and body.
40893
40894 .option dkim_strict smtp string&!! unset
40895 This  option  defines  how  Exim  behaves  when  signing a message that
40896 should be signed fails for some reason.  When the expansion evaluates to
40897 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40898 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40899 variables here.
40900
40901 .option dkim_sign_headers smtp string&!! "see below"
40902 If set, this option must expand to a colon-separated
40903 list of header names.
40904 Headers with these names, or the absence or such a header, will be included
40905 in the message signature.
40906 When unspecified, the header names listed in RFC4871 will be used,
40907 whether or not each header is present in the message.
40908 The default list is available for the expansion in the macro
40909 &"_DKIM_SIGN_HEADERS"&
40910 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40911
40912 If a name is repeated, multiple headers by that name (or the absence thereof)
40913 will be signed.  The textually later headers in the headers part of the
40914 message are signed first, if there are multiples.
40915
40916 A name can be prefixed with either an &"="& or a &"+"& character.
40917 If an &"="& prefix is used, all headers that are present with this name
40918 will be signed.
40919 If a &"+"& prefix if used, all headers that are present with this name
40920 will be signed, and one signature added for a missing header with the
40921 name will be appended.
40922
40923 .option dkim_timestamps smtp integer&!! unset
40924 This option controls the inclusion of timestamp information in the signature.
40925 If not set, no such information will be included.
40926 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40927 for the expiry tag
40928 (eg. 1209600 for two weeks);
40929 both creation (t=) and expiry (x=) tags will be included.
40930
40931 RFC 6376 lists these tags as RECOMMENDED.
40932
40933
40934 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40935 .cindex "DKIM" "verification"
40936
40937 Verification of DKIM signatures in SMTP incoming email is done for all
40938 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40939 .cindex DKIM "selecting signature algorithms"
40940 Individual classes of signature algorithm can be ignored by changing
40941 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40942 The &%dkim_verify_minimal%& option can be set to cease verification
40943 processing for a message once the first passing signature is found.
40944
40945 .cindex authentication "expansion item"
40946 Performing verification sets up information used by the
40947 &%authresults%& expansion item.
40948
40949 For most purposes the default option settings suffice and the remainder
40950 of this section can be ignored.
40951
40952 The results of verification are made available to the
40953 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40954 A missing ACL definition defaults to accept.
40955 By default, the ACL is called once for each
40956 syntactically(!) correct signature in the incoming message.
40957 If any ACL call does not accept, the message is not accepted.
40958 If a cutthrough delivery was in progress for the message, that is
40959 summarily dropped (having wasted the transmission effort).
40960
40961 To evaluate the verification result in the ACL
40962 a large number of expansion variables
40963 containing the signature status and its details are set up during the
40964 runtime of the ACL.
40965
40966 Calling the ACL only for existing signatures is not sufficient to build
40967 more advanced policies. For that reason, the main option
40968 &%dkim_verify_signers%&, and an expansion variable
40969 &%$dkim_signers%& exist.
40970
40971 The main option &%dkim_verify_signers%& can be set to a colon-separated
40972 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40973 called. It is expanded when the message has been received. At this point,
40974 the expansion variable &%$dkim_signers%& already contains a colon-separated
40975 list of signer domains and identities for the message. When
40976 &%dkim_verify_signers%& is not specified in the main configuration,
40977 it defaults as:
40978 .code
40979 dkim_verify_signers = $dkim_signers
40980 .endd
40981 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40982 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40983 call the ACL for known domains or identities. This would be achieved as follows:
40984 .code
40985 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40986 .endd
40987 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40988 and "ebay.com", plus all domains and identities that have signatures in the message.
40989 You can also be more creative in constructing your policy. For example:
40990 .code
40991 dkim_verify_signers = $sender_address_domain:$dkim_signers
40992 .endd
40993
40994 If a domain or identity is listed several times in the (expanded) value of
40995 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40996
40997 Note that if the option is set using untrustworthy data
40998 (such as the From: header)
40999 care should be taken to force lowercase for domains
41000 and for the domain part if identities.
41001 The default setting can be regarded as trustworthy in this respect.
41002
41003 If multiple signatures match a domain (or identity), the ACL is called once
41004 for each matching signature.
41005
41006
41007 Inside the DKIM ACL, the following expansion variables are
41008 available (from most to least important):
41009
41010
41011 .vlist
41012 .vitem &%$dkim_cur_signer%&
41013 The signer that is being evaluated in this ACL run. This can be a domain or
41014 an identity. This is one of the list items from the expanded main option
41015 &%dkim_verify_signers%& (see above).
41016
41017 .vitem &%$dkim_verify_status%&
41018 Within the DKIM ACL,
41019 a string describing the general status of the signature. One of
41020 .ilist
41021 &%none%&: There is no signature in the message for the current domain or
41022 identity (as reflected by &%$dkim_cur_signer%&).
41023 .next
41024 &%invalid%&: The signature could not be verified due to a processing error.
41025 More detail is available in &%$dkim_verify_reason%&.
41026 .next
41027 &%fail%&: Verification of the signature failed.  More detail is
41028 available in &%$dkim_verify_reason%&.
41029 .next
41030 &%pass%&: The signature passed verification. It is valid.
41031 .endlist
41032
41033 This variable can be overwritten using an ACL 'set' modifier.
41034 This might, for instance, be done to enforce a policy restriction on
41035 hash-method or key-size:
41036 .code
41037   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41038        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41039        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41040                                   {< {$dkim_key_length}{1024}}}}
41041        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41042        set dkim_verify_status = fail
41043        set dkim_verify_reason = hash too weak or key too short
41044 .endd
41045
41046 So long as a DKIM ACL is defined (it need do no more than accept),
41047 after all the DKIM ACL runs have completed, the value becomes a
41048 colon-separated list of the values after each run.
41049 This is maintained for the mime, prdr and data ACLs.
41050
41051 .vitem &%$dkim_verify_reason%&
41052 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41053 "fail" or "invalid". One of
41054 .ilist
41055 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41056 key for the domain could not be retrieved. This may be a temporary problem.
41057 .next
41058 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41059 record for the domain is syntactically invalid.
41060 .next
41061 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41062 body hash does not match the one specified in the signature header. This
41063 means that the message body was modified in transit.
41064 .next
41065 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41066 could not be verified. This may mean that headers were modified,
41067 re-written or otherwise changed in a way which is incompatible with
41068 DKIM verification. It may of course also mean that the signature is forged.
41069 .endlist
41070
41071 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41072
41073 .vitem &%$dkim_domain%&
41074 The signing domain. IMPORTANT: This variable is only populated if there is
41075 an actual signature in the message for the current domain or identity (as
41076 reflected by &%$dkim_cur_signer%&).
41077
41078 .vitem &%$dkim_identity%&
41079 The signing identity, if present. IMPORTANT: This variable is only populated
41080 if there is an actual signature in the message for the current domain or
41081 identity (as reflected by &%$dkim_cur_signer%&).
41082
41083 .vitem &%$dkim_selector%&
41084 The key record selector string.
41085
41086 .vitem &%$dkim_algo%&
41087 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41088 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41089 may also be 'ed25519-sha256'.
41090 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41091 for EC keys.
41092
41093 Note that RFC 8301 says:
41094 .code
41095 rsa-sha1 MUST NOT be used for signing or verifying.
41096
41097 DKIM signatures identified as having been signed with historic
41098 algorithms (currently, rsa-sha1) have permanently failed evaluation
41099 .endd
41100
41101 To enforce this you must either have a DKIM ACL which checks this variable
41102 and overwrites the &$dkim_verify_status$& variable as discussed above,
41103 or have set the main option &%dkim_verify_hashes%& to exclude
41104 processing of such signatures.
41105
41106 .vitem &%$dkim_canon_body%&
41107 The body canonicalization method. One of 'relaxed' or 'simple'.
41108
41109 .vitem &%$dkim_canon_headers%&
41110 The header canonicalization method. One of 'relaxed' or 'simple'.
41111
41112 .vitem &%$dkim_copiedheaders%&
41113 A transcript of headers and their values which are included in the signature
41114 (copied from the 'z=' tag of the signature).
41115 Note that RFC6376 requires that verification fail if the From: header is
41116 not included in the signature.  Exim does not enforce this; sites wishing
41117 strict enforcement should code the check explicitly.
41118
41119 .vitem &%$dkim_bodylength%&
41120 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41121 limit was set by the signer, "9999999999999" is returned. This makes sure
41122 that this variable always expands to an integer value.
41123 &*Note:*& The presence of the signature tag specifying a signing body length
41124 is one possible route to spoofing of valid DKIM signatures.
41125 A paranoid implementation might wish to regard signature where this variable
41126 shows less than the "no limit" return as being invalid.
41127
41128 .vitem &%$dkim_created%&
41129 UNIX timestamp reflecting the date and time when the signature was created.
41130 When this was not specified by the signer, "0" is returned.
41131
41132 .vitem &%$dkim_expires%&
41133 UNIX timestamp reflecting the date and time when the signer wants the
41134 signature to be treated as "expired". When this was not specified by the
41135 signer, "9999999999999" is returned. This makes it possible to do useful
41136 integer size comparisons against this value.
41137 Note that Exim does not check this value.
41138
41139 .vitem &%$dkim_headernames%&
41140 A colon-separated list of names of headers included in the signature.
41141
41142 .vitem &%$dkim_key_testing%&
41143 "1" if the key record has the "testing" flag set, "0" if not.
41144
41145 .vitem &%$dkim_key_nosubdomains%&
41146 "1" if the key record forbids subdomaining, "0" otherwise.
41147
41148 .vitem &%$dkim_key_srvtype%&
41149 Service type (tag s=) from the key record. Defaults to "*" if not specified
41150 in the key record.
41151
41152 .vitem &%$dkim_key_granularity%&
41153 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41154 in the key record.
41155
41156 .vitem &%$dkim_key_notes%&
41157 Notes from the key record (tag n=).
41158
41159 .vitem &%$dkim_key_length%&
41160 Number of bits in the key.
41161 Valid only once the key is loaded, which is at the time the header signature
41162 is verified, which is after the body hash is.
41163
41164 Note that RFC 8301 says:
41165 .code
41166 Verifiers MUST NOT consider signatures using RSA keys of
41167 less than 1024 bits as valid signatures.
41168 .endd
41169
41170 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41171 option.
41172
41173 .endlist
41174
41175 In addition, two ACL conditions are provided:
41176
41177 .vlist
41178 .vitem &%dkim_signers%&
41179 ACL condition that checks a colon-separated list of domains or identities
41180 for a match against the domain or identity that the ACL is currently verifying
41181 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41182 verb to a group of domains or identities. For example:
41183
41184 .code
41185 # Warn when Mail purportedly from GMail has no gmail signature
41186 warn sender_domains = gmail.com
41187      dkim_signers = gmail.com
41188      dkim_status = none
41189      log_message = GMail sender without gmail.com DKIM signature
41190 .endd
41191
41192 Note that the above does not check for a total lack of DKIM signing;
41193 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41194
41195 .vitem &%dkim_status%&
41196 ACL condition that checks a colon-separated list of possible DKIM verification
41197 results against the actual result of verification. This is typically used
41198 to restrict an ACL verb to a list of verification outcomes, for example:
41199
41200 .code
41201 deny sender_domains = paypal.com:paypal.de
41202      dkim_signers = paypal.com:paypal.de
41203      dkim_status = none:invalid:fail
41204      message = Mail from Paypal with invalid/missing signature
41205 .endd
41206
41207 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41208 see the documentation of the &%$dkim_verify_status%& expansion variable above
41209 for more information of what they mean.
41210 .endlist
41211
41212
41213
41214
41215 .section "SPF (Sender Policy Framework)" SECSPF
41216 .cindex SPF verification
41217
41218 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41219 messages with its domain in the envelope from, documented by RFC 7208.
41220 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41221 the &url(http://openspf.org).
41222 . --- 2019-10-28: still not https, open-spf.org is told to be a
41223 . --- web-archive copy of the now dead openspf.org site
41224 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41225 . --- discussion.
41226
41227 Messages sent by a system not authorised will fail checking of such assertions.
41228 This includes retransmissions done by traditional forwarders.
41229
41230 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41231 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41232 &url(https://www.libspf2.org/).
41233 There is no Exim involvement in the transmission of messages;
41234 publishing certain DNS records is all that is required.
41235
41236 For verification, an ACL condition and an expansion lookup are provided.
41237 .cindex authentication "expansion item"
41238 Performing verification sets up information used by the
41239 &%authresults%& expansion item.
41240
41241
41242 .cindex SPF "ACL condition"
41243 .cindex ACL "spf condition"
41244 The ACL condition "spf" can be used at or after the MAIL ACL.
41245 It takes as an argument a list of strings giving the outcome of the SPF check,
41246 and will succeed for any matching outcome.
41247 Valid strings are:
41248 .vlist
41249 .vitem &%pass%&
41250 The SPF check passed, the sending host is positively verified by SPF.
41251
41252 .vitem &%fail%&
41253 The SPF check failed, the sending host is NOT allowed to send mail for the
41254 domain in the envelope-from address.
41255
41256 .vitem &%softfail%&
41257 The SPF check failed, but the queried domain can't absolutely confirm that this
41258 is a forgery.
41259
41260 .vitem &%none%&
41261 The queried domain does not publish SPF records.
41262
41263 .vitem &%neutral%&
41264 The SPF check returned a "neutral" state.  This means the queried domain has
41265 published a SPF record, but wants to allow outside servers to send mail under
41266 its domain as well.  This should be treated like "none".
41267
41268 .vitem &%permerror%&
41269 This indicates a syntax error in the SPF record of the queried domain.
41270 You may deny messages when this occurs.
41271
41272 .vitem &%temperror%&
41273 This indicates a temporary error during all processing, including Exim's
41274 SPF processing.  You may defer messages when this occurs.
41275 .endlist
41276
41277 You can prefix each string with an exclamation mark to  invert
41278 its meaning,  for example  "!fail" will  match all  results but
41279 "fail".  The  string  list is  evaluated  left-to-right,  in a
41280 short-circuit fashion.
41281
41282 Example:
41283 .code
41284 deny spf = fail
41285      message = $sender_host_address is not allowed to send mail from \
41286                ${if def:sender_address_domain \
41287                     {$sender_address_domain}{$sender_helo_name}}.  \
41288                Please see http://www.open-spf.org/Why;\
41289                identity=${if def:sender_address_domain \
41290                              {$sender_address}{$sender_helo_name}};\
41291                ip=$sender_host_address
41292 .endd
41293
41294 Note: The above mentioned URL may not be as helpful as expected. You are
41295 encouraged to replace the link with a link to a site with more
41296 explanations.
41297
41298 When the spf condition has run, it sets up several expansion
41299 variables:
41300
41301 .cindex SPF "verification variables"
41302 .vlist
41303 .vitem &$spf_header_comment$&
41304 .vindex &$spf_header_comment$&
41305   This contains a human-readable string describing the outcome
41306   of the SPF check. You can add it to a custom header or use
41307   it for logging purposes.
41308
41309 .vitem &$spf_received$&
41310 .vindex &$spf_received$&
41311   This contains a complete Received-SPF: header that can be
41312   added to the message. Please note that according to the SPF
41313   draft, this header must be added at the top of the header
41314   list. Please see section 10 on how you can do this.
41315
41316   Note: in case of "Best-guess" (see below), the convention is
41317   to put this string in a header called X-SPF-Guess: instead.
41318
41319 .vitem &$spf_result$&
41320 .vindex &$spf_result$&
41321   This contains the outcome of the SPF check in string form,
41322   one of pass, fail, softfail, none, neutral, permerror or
41323   temperror.
41324
41325 .vitem &$spf_result_guessed$&
41326 .vindex &$spf_result_guessed$&
41327   This boolean is true only if a best-guess operation was used
41328   and required in order to obtain a result.
41329
41330 .vitem &$spf_smtp_comment$&
41331 .vindex &$spf_smtp_comment$&
41332 .vindex &%spf_smtp_comment_template%&
41333   This contains a string that can be used in a SMTP response
41334   to the calling party. Useful for "fail".
41335   The string is generated by the SPF library from the template configured in the main config
41336   option &%spf_smtp_comment_template%&.
41337 .endlist
41338
41339
41340 .cindex SPF "ACL condition"
41341 .cindex ACL "spf_guess condition"
41342 .cindex SPF "best guess"
41343 In addition to SPF, you can also perform checks for so-called
41344 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41345 SPF, but it is supported by the same framework that enables SPF
41346 capability.
41347 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41348 for a description of what it means.
41349 . --- 2019-10-28: still not https:
41350
41351 To access this feature, simply use the spf_guess condition in place
41352 of the spf one.  For example:
41353
41354 .code
41355 deny spf_guess = fail
41356      message = $sender_host_address doesn't look trustworthy to me
41357 .endd
41358
41359 In case you decide to reject messages based on this check, you
41360 should note that although it uses the same framework, "Best-guess"
41361 is not SPF, and therefore you should not mention SPF at all in your
41362 reject message.
41363
41364 When the spf_guess condition has run, it sets up the same expansion
41365 variables as when spf condition is run, described above.
41366
41367 Additionally, since Best-guess is not standardized, you may redefine
41368 what "Best-guess" means to you by redefining the main configuration
41369 &%spf_guess%& option.
41370 For example, the following:
41371
41372 .code
41373 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41374 .endd
41375
41376 would relax host matching rules to a broader network range.
41377
41378
41379 .cindex SPF "lookup expansion"
41380 .cindex lookup spf
41381 A lookup expansion is also available. It takes an email
41382 address as the key and an IP address
41383 (v4 or v6)
41384 as the database:
41385
41386 .code
41387   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41388 .endd
41389
41390 The lookup will return the same result strings as can appear in
41391 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41392
41393
41394
41395
41396
41397 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41398 .cindex SRS "sender rewriting scheme"
41399
41400 .new
41401 SRS can be used to modify sender addresses when forwarding so that
41402 SPF verification does not object to them.
41403 It operates by encoding the original envelope sender in a new
41404 sender local part and using a domain run by the forwarding site
41405 as the new domain for the sender.  Any DSN message should be returned
41406 to this new sender at the forwarding site, which can extract the
41407 original sender from the coded local part and forward the DSN to
41408 the originator.
41409
41410 This is a way of avoiding the breakage that SPF does to forwarding.
41411 The constructed local-part will be longer than the original,
41412 leading to possible problems with very long addresses.
41413 The changing of the sender address also hinders the tracing of mail
41414 problems.
41415
41416 Exim can be built to include native SRS support.  To do this
41417 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41418 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41419 will be defined.
41420 The support is limited to SRS0-encoding; SRS1 is not supported.
41421
41422 .cindex SRS excoding
41423 To encode an address use this expansion item:
41424 .vlist
41425 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41426 .cindex "&%srs_encode%& expansion item"
41427 .cindex SRS "expansion item"
41428 The first argument should be a secret known and used by all systems
41429 handling the recipient domain for the original message.
41430 There is no need to periodically change this key; a timestamp is also
41431 encoded.
41432 The second argument should be given as the envelope sender address before this
41433 encoding operation.
41434 The third argument should be the recipient domain of the message when
41435 it arrived at this system.
41436 .endlist
41437
41438 .cindex SRS decoding
41439 To decode an address use this expansion condition:
41440 .vlist
41441 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
41442 The first argument should be the recipient local prt as is was received.
41443 The second argument is the site secret.
41444
41445 If the messages is not for an SRS-encoded recipient the condition will
41446 return false.  If it is, the condition will return true and the variable
41447 &$srs_recipient$& will be set to the decoded (original) value.
41448 .endlist
41449
41450 Example usage:
41451 .code
41452   #macro
41453   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
41454   
41455   #routers
41456
41457   outbound:
41458     driver =    dnslookup
41459     # if outbound, and forwarding has been done, use an alternate transport
41460     domains =   ! +my_domains
41461     transport = ${if eq {$local_part@$domain} \
41462                         {$original_local_part@$original_domain} \
41463                      {remote_smtp} {remote_forwarded_smtp}}
41464   
41465   inbound_srs:
41466     driver =    redirect
41467     senders =   :
41468     domains =   +my_domains
41469     # detect inbound bounces which are SRS'd, and decode them
41470     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
41471     data =      $srs_recipient
41472   
41473   inbound_srs_failure:
41474     driver =    redirect
41475     senders =   :
41476     domains =   +my_domains
41477     # detect inbound bounces which look SRS'd but are invalid
41478     condition = ${if inbound_srs {$local_part} {}}
41479     allow_fail
41480     data =      :fail: Invalid SRS recipient address
41481
41482   #... further routers here
41483
41484   
41485   # transport; should look like the non-forward outbound
41486   # one, plus the max_rcpt and return_path options
41487   remote_forwarded_smtp:
41488     driver =              smtp
41489     # modify the envelope from, for mails that we forward
41490     max_rcpt =            1
41491     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
41492 .endd
41493
41494
41495 .wen
41496
41497
41498
41499 .section DMARC SECDMARC
41500 .cindex DMARC verification
41501
41502 DMARC combines feedback from SPF, DKIM, and header From: in order
41503 to attempt to provide better indicators of the authenticity of an
41504 email.  This document does not explain the fundamentals; you
41505 should read and understand how it works by visiting the website at
41506 &url(http://www.dmarc.org/).
41507
41508 If Exim is built with DMARC support,
41509 the libopendmarc library is used.
41510
41511 For building Exim yourself, obtain the library from
41512 &url(http://sourceforge.net/projects/opendmarc/)
41513 to obtain a copy, or find it in your favorite package
41514 repository.  You will need to attend to the local/Makefile feature
41515 SUPPORT_DMARC and the associated LDFLAGS addition.
41516 This description assumes
41517 that headers will be in /usr/local/include, and that the libraries
41518 are in /usr/local/lib.
41519
41520 . subsection
41521
41522 There are three main-configuration options:
41523 .cindex DMARC "configuration options"
41524
41525 The &%dmarc_tld_file%& option
41526 .oindex &%dmarc_tld_file%&
41527 defines the location of a text file of valid
41528 top level domains the opendmarc library uses
41529 during domain parsing. Maintained by Mozilla,
41530 the most current version can be downloaded
41531 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41532 See also the util/renew-opendmarc-tlds.sh script.
41533 The default for the option is unset.
41534 If not set, DMARC processing is disabled.
41535
41536
41537 The &%dmarc_history_file%& option, if set
41538 .oindex &%dmarc_history_file%&
41539 defines the location of a file to log results
41540 of dmarc verification on inbound emails. The
41541 contents are importable by the opendmarc tools
41542 which will manage the data, send out DMARC
41543 reports, and expire the data. Make sure the
41544 directory of this file is writable by the user
41545 exim runs as.
41546 The default is unset.
41547
41548 The &%dmarc_forensic_sender%& option
41549 .oindex &%dmarc_forensic_sender%&
41550 defines an alternate email address to use when sending a
41551 forensic report detailing alignment failures
41552 if a sender domain's dmarc record specifies it
41553 and you have configured Exim to send them.
41554 If set, this is expanded and used for the
41555 From: header line; the address is extracted
41556 from it and used for the envelope from.
41557 If not set (the default), the From: header is expanded from
41558 the dsn_from option, and <> is used for the
41559 envelope from.
41560
41561 . I wish we had subsections...
41562
41563 .cindex DMARC controls
41564 By default, the DMARC processing will run for any remote,
41565 non-authenticated user.  It makes sense to only verify DMARC
41566 status of messages coming from remote, untrusted sources.  You can
41567 use standard conditions such as hosts, senders, etc, to decide that
41568 DMARC verification should *not* be performed for them and disable
41569 DMARC with an ACL control modifier:
41570 .code
41571   control = dmarc_disable_verify
41572 .endd
41573 A DMARC record can also specify a "forensic address", which gives
41574 exim an email address to submit reports about failed alignment.
41575 Exim does not do this by default because in certain conditions it
41576 results in unintended information leakage (what lists a user might
41577 be subscribed to, etc).  You must configure exim to submit forensic
41578 reports to the owner of the domain.  If the DMARC record contains a
41579 forensic address and you specify the control statement below, then
41580 exim will send these forensic emails.  It is also advised that you
41581 configure a &%dmarc_forensic_sender%& because the default sender address
41582 construction might be inadequate.
41583 .code
41584   control = dmarc_enable_forensic
41585 .endd
41586 (AGAIN: You can choose not to send these forensic reports by simply
41587 not putting the dmarc_enable_forensic control line at any point in
41588 your exim config.  If you don't tell exim to send them, it will not
41589 send them.)
41590
41591 There are no options to either control.  Both must appear before
41592 the DATA acl.
41593
41594 . subsection
41595
41596 DMARC checks cam be run on incoming SMTP  messages by using the
41597 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41598 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41599 condition.  Putting this condition in the ACLs is required in order
41600 for a DMARC check to actually occur.  All of the variables are set
41601 up before the DATA ACL, but there is no actual DMARC check that
41602 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41603
41604 The &"dmarc_status"& condition takes a list of strings on its
41605 right-hand side.  These strings describe recommended action based
41606 on the DMARC check.  To understand what the policy recommendations
41607 mean, refer to the DMARC website above.  Valid strings are:
41608 .display
41609 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41610 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41611 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41612 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41613 &'norecord    '& No policy section in the DMARC record for this sender domain.
41614 &'nofrom      '& Unable to determine the domain of the sender.
41615 &'temperror   '& Library error or dns error.
41616 &'off         '& The DMARC check was disabled for this email.
41617 .endd
41618 You can prefix each string with an exclamation mark to invert its
41619 meaning, for example "!accept" will match all results but
41620 "accept".  The string list is evaluated left-to-right in a
41621 short-circuit fashion.  When a string matches the outcome of the
41622 DMARC check, the condition succeeds.  If none of the listed
41623 strings matches the outcome of the DMARC check, the condition
41624 fails.
41625
41626 Of course, you can also use any other lookup method that Exim
41627 supports, including LDAP, Postgres, MySQL, etc, as long as the
41628 result is a list of colon-separated strings.
41629
41630 Performing the check sets up information used by the
41631 &%authresults%& expansion item.
41632
41633 Several expansion variables are set before the DATA ACL is
41634 processed, and you can use them in this ACL.  The following
41635 expansion variables are available:
41636
41637 .vlist
41638 .vitem &$dmarc_status$&
41639 .vindex &$dmarc_status$&
41640 .cindex DMARC result
41641 A one word status indicating what the DMARC library
41642 thinks of the email.  It is a combination of the results of
41643 DMARC record lookup and the SPF/DKIM/DMARC processing results
41644 (if a DMARC record was found).  The actual policy declared
41645 in the DMARC record is in a separate expansion variable.
41646
41647 .vitem &$dmarc_status_text$&
41648 .vindex &$dmarc_status_text$&
41649 Slightly longer, human readable status.
41650
41651 .vitem &$dmarc_used_domain$&
41652 .vindex &$dmarc_used_domain$&
41653 The domain which DMARC used to look up the DMARC policy record.
41654
41655 .vitem &$dmarc_domain_policy$&
41656 .vindex &$dmarc_domain_policy$&
41657 The policy declared in the DMARC record.  Valid values
41658 are "none", "reject" and "quarantine".  It is blank when there
41659 is any error, including no DMARC record.
41660 .endlist
41661
41662 . subsection
41663
41664 By default, Exim's DMARC configuration is intended to be
41665 non-intrusive and conservative.  To facilitate this, Exim will not
41666 create any type of logging files without explicit configuration by
41667 you, the admin.  Nor will Exim send out any emails/reports about
41668 DMARC issues without explicit configuration by you, the admin (other
41669 than typical bounce messages that may come about due to ACL
41670 processing or failure delivery issues).
41671
41672 In order to log statistics suitable to be imported by the opendmarc
41673 tools, you need to:
41674 .ilist
41675 Configure the global option &%dmarc_history_file%&
41676 .next
41677 Configure cron jobs to call the appropriate opendmarc history
41678 import scripts and truncating the dmarc_history_file
41679 .endlist
41680
41681 In order to send forensic reports, you need to:
41682 .ilist
41683 Configure the global option &%dmarc_forensic_sender%&
41684 .next
41685 Configure, somewhere before the DATA ACL, the control option to
41686 enable sending DMARC forensic reports
41687 .endlist
41688
41689 . subsection
41690
41691 Example usage:
41692 .code
41693 (RCPT ACL)
41694   warn    domains        = +local_domains
41695           hosts          = +local_hosts
41696           control        = dmarc_disable_verify
41697
41698   warn    !domains       = +screwed_up_dmarc_records
41699           control        = dmarc_enable_forensic
41700
41701   warn    condition      = (lookup if destined to mailing list)
41702           set acl_m_mailing_list = 1
41703
41704 (DATA ACL)
41705   warn    dmarc_status   = accept : none : off
41706           !authenticated = *
41707           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41708
41709   warn    dmarc_status   = !accept
41710           !authenticated = *
41711           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41712
41713   warn    dmarc_status   = quarantine
41714           !authenticated = *
41715           set $acl_m_quarantine = 1
41716           # Do something in a transport with this flag variable
41717
41718   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41719           condition      = ${if eq{$acl_m_mailing_list}{1}}
41720           message        = Messages from $dmarc_used_domain break mailing lists
41721
41722   deny    dmarc_status   = reject
41723           !authenticated = *
41724           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41725
41726   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41727 .endd
41728
41729
41730
41731
41732
41733 . ////////////////////////////////////////////////////////////////////////////
41734 . ////////////////////////////////////////////////////////////////////////////
41735
41736 .chapter "Proxies" "CHAPproxies" &&&
41737          "Proxy support"
41738 .cindex "proxy support"
41739 .cindex "proxy" "access via"
41740
41741 A proxy is an intermediate system through which communication is passed.
41742 Proxies may provide a security, availability or load-distribution function.
41743
41744
41745 .section "Inbound proxies" SECTproxyInbound
41746 .cindex proxy inbound
41747 .cindex proxy "server side"
41748 .cindex proxy "Proxy protocol"
41749 .cindex "Proxy protocol" proxy
41750
41751 Exim has support for receiving inbound SMTP connections via a proxy
41752 that uses &"Proxy Protocol"& to speak to it.
41753 To include this support, include &"SUPPORT_PROXY=yes"&
41754 in Local/Makefile.
41755
41756 It was built on the HAProxy specification, found at
41757 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41758
41759 The purpose of this facility is so that an application load balancer,
41760 such as HAProxy, can sit in front of several Exim servers
41761 to distribute load.
41762 Exim uses the local protocol communication with the proxy to obtain
41763 the remote SMTP system IP address and port information.
41764 There is no logging if a host passes or
41765 fails Proxy Protocol negotiation, but it can easily be determined and
41766 recorded in an ACL (example is below).
41767
41768 Use of a proxy is enabled by setting the &%hosts_proxy%&
41769 main configuration option to a hostlist; connections from these
41770 hosts will use Proxy Protocol.
41771 Exim supports both version 1 and version 2 of the Proxy Protocol and
41772 automatically determines which version is in use.
41773
41774 The Proxy Protocol header is the first data received on a TCP connection
41775 and is inserted before any TLS-on-connect handshake from the client; Exim
41776 negotiates TLS between Exim-as-server and the remote client, not between
41777 Exim and the proxy server.
41778
41779 The following expansion variables are usable
41780 (&"internal"& and &"external"& here refer to the interfaces
41781 of the proxy):
41782 .display
41783 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41784 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41785 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41786 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41787 &'proxy_session            '& boolean: SMTP connection via proxy
41788 .endd
41789 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41790 there was a protocol error.
41791 The variables &$sender_host_address$& and &$sender_host_port$&
41792 will have values for the actual client system, not the proxy.
41793
41794 Since the real connections are all coming from the proxy, and the
41795 per host connection tracking is done before Proxy Protocol is
41796 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41797 handle all of the parallel volume you expect per inbound proxy.
41798 With the option set so high, you lose the ability
41799 to protect your server from many connections from one IP.
41800 In order to prevent your server from overload, you
41801 need to add a per connection ratelimit to your connect ACL.
41802 A possible solution is:
41803 .display
41804   # Set max number of connections per host
41805   LIMIT   = 5
41806   # Or do some kind of IP lookup in a flat file or database
41807   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41808
41809   defer   ratelimit      = LIMIT / 5s / per_conn / strict
41810           message        = Too many connections from this IP right now
41811 .endd
41812
41813
41814
41815 .section "Outbound proxies" SECTproxySOCKS
41816 .cindex proxy outbound
41817 .cindex proxy "client side"
41818 .cindex proxy SOCKS
41819 .cindex SOCKS proxy
41820 Exim has support for sending outbound SMTP via a proxy
41821 using a protocol called SOCKS5 (defined by RFC1928).
41822 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41823 Local/Makefile.
41824
41825 Use of a proxy is enabled by setting the &%socks_proxy%& option
41826 on an smtp transport.
41827 The option value is expanded and should then be a list
41828 (colon-separated by default) of proxy specifiers.
41829 Each proxy specifier is a list
41830 (space-separated by default) where the initial element
41831 is an IP address and any subsequent elements are options.
41832
41833 Options are a string <name>=<value>.
41834 The list of options is in the following table:
41835 .display
41836 &'auth   '& authentication method
41837 &'name   '& authentication username
41838 &'pass   '& authentication password
41839 &'port   '& tcp port
41840 &'tmo    '& connection timeout
41841 &'pri    '& priority
41842 &'weight '& selection bias
41843 .endd
41844
41845 More details on each of these options follows:
41846
41847 .ilist
41848 .cindex authentication "to proxy"
41849 .cindex proxy authentication
41850 &%auth%&: Either &"none"& (default) or &"name"&.
41851 Using &"name"& selects username/password authentication per RFC 1929
41852 for access to the proxy.
41853 Default is &"none"&.
41854 .next
41855 &%name%&: sets the username for the &"name"& authentication method.
41856 Default is empty.
41857 .next
41858 &%pass%&: sets the password for the &"name"& authentication method.
41859 Default is empty.
41860 .next
41861 &%port%&: the TCP port number to use for the connection to the proxy.
41862 Default is 1080.
41863 .next
41864 &%tmo%&: sets a connection timeout in seconds for this proxy.
41865 Default is 5.
41866 .next
41867 &%pri%&: specifies a priority for the proxy within the list,
41868 higher values being tried first.
41869 The default priority is 1.
41870 .next
41871 &%weight%&: specifies a selection bias.
41872 Within a priority set servers are queried in a random fashion,
41873 weighted by this value.
41874 The default value for selection bias is 1.
41875 .endlist
41876
41877 Proxies from the list are tried according to their priority
41878 and weight settings until one responds.  The timeout for the
41879 overall connection applies to the set of proxied attempts.
41880
41881 .section Logging SECTproxyLog
41882 To log the (local) IP of a proxy in the incoming or delivery logline,
41883 add &"+proxy"& to the &%log_selector%& option.
41884 This will add a component tagged with &"PRX="& to the line.
41885
41886 . ////////////////////////////////////////////////////////////////////////////
41887 . ////////////////////////////////////////////////////////////////////////////
41888
41889 .chapter "Internationalisation" "CHAPi18n" &&&
41890          "Internationalisation""
41891 .cindex internationalisation "email address"
41892 .cindex EAI
41893 .cindex i18n
41894 .cindex utf8 "mail name handling"
41895
41896 Exim has support for Internationalised mail names.
41897 To include this it must be built with SUPPORT_I18N and the libidn library.
41898 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41899
41900 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41901 instead of it) then IDNA2008 is supported; this adds an extra library
41902 requirement, upon libidn2.
41903
41904 .section "MTA operations" SECTi18nMTA
41905 .cindex SMTPUTF8 "ESMTP option"
41906 .cindex "ESMTP extensions" SMTPUTF8
41907 The main configuration option &%smtputf8_advertise_hosts%& specifies
41908 a host list.  If this matches the sending host and
41909 accept_8bitmime is true (the default) then the ESMTP option
41910 SMTPUTF8 will be advertised.
41911
41912 If the sender specifies the SMTPUTF8 option on a MAIL command
41913 international handling for the message is enabled and
41914 the expansion variable &$message_smtputf8$& will have value TRUE.
41915
41916 The option &%allow_utf8_domains%& is set to true for this
41917 message. All DNS lookups are converted to a-label form
41918 whatever the setting of &%allow_utf8_domains%&
41919 when Exim is built with SUPPORT_I18N.
41920
41921 Both localparts and domain are maintained as the original
41922 UTF-8 form internally; any comparison or regular-expression use will
41923 require appropriate care.  Filenames created, eg. by
41924 the appendfile transport, will have UTF-8 names.
41925
41926 HELO names sent by the smtp transport will have any UTF-8
41927 components expanded to a-label form,
41928 and any certificate name checks will be done using the a-label
41929 form of the name.
41930
41931 .cindex log protocol
41932 .cindex SMTPUTF8 logging
41933 .cindex i18n logging
41934 Log lines and Received-by: header lines will acquire a "utf8"
41935 prefix on the protocol element, eg. utf8esmtp.
41936
41937 The following expansion operators can be used:
41938 .code
41939 ${utf8_domain_to_alabel:str}
41940 ${utf8_domain_from_alabel:str}
41941 ${utf8_localpart_to_alabel:str}
41942 ${utf8_localpart_from_alabel:str}
41943 .endd
41944
41945 .cindex utf8 "address downconversion"
41946 .cindex i18n "utf8 address downconversion"
41947 The RCPT ACL
41948 may use the following modifier:
41949 .display
41950 control = utf8_downconvert
41951 control = utf8_downconvert/<value>
41952 .endd
41953 This sets a flag requiring that envelope addresses are converted to
41954 a-label form before smtp delivery.
41955 This is usually for use in a Message Submission Agent context,
41956 but could be used for any message.
41957
41958 If a value is appended it may be:
41959 .display
41960 &`1  `& mandatory downconversion
41961 &`0  `& no downconversion
41962 &`-1 `& if SMTPUTF8 not supported by destination host
41963 .endd
41964 If no value is given, 1 is used.
41965
41966 If mua_wrapper is set, the utf8_downconvert control
41967 is initially set to -1.
41968
41969 The smtp transport has an option &%utf8_downconvert%&.
41970 If set it must expand to one of the three values described above,
41971 or an empty string.
41972 If non-empty it overrides value previously set
41973 (due to mua_wrapper or by an ACL control).
41974
41975
41976 There is no explicit support for VRFY and EXPN.
41977 Configurations supporting these should inspect
41978 &$smtp_command_argument$& for an SMTPUTF8 argument.
41979
41980 There is no support for LMTP on Unix sockets.
41981 Using the "lmtp" protocol option on an smtp transport,
41982 for LMTP over TCP, should work as expected.
41983
41984 There is no support for DSN unitext handling,
41985 and no provision for converting logging from or to UTF-8.
41986
41987
41988
41989 .section "MDA operations" SECTi18nMDA
41990 To aid in constructing names suitable for IMAP folders
41991 the following expansion operator can be used:
41992 .code
41993 ${imapfolder {<string>} {<sep>} {<specials>}}
41994 .endd
41995
41996 The string is converted from the charset specified by
41997 the "headers charset" command (in a filter file)
41998 or &%headers_charset%& main configuration option (otherwise),
41999 to the
42000 modified UTF-7 encoding specified by RFC 2060,
42001 with the following exception: All occurrences of <sep>
42002 (which has to be a single character)
42003 are replaced with periods ("."), and all periods and slashes that are not
42004 <sep> and are not in the <specials> string are BASE64 encoded.
42005
42006 The third argument can be omitted, defaulting to an empty string.
42007 The second argument can be omitted, defaulting to "/".
42008
42009 This is the encoding used by Courier for Maildir names on disk, and followed
42010 by many other IMAP servers.
42011
42012 Examples:
42013 .display
42014 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42015 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42016 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42017 .endd
42018
42019 Note that the source charset setting is vital, and also that characters
42020 must be representable in UTF-16.
42021
42022
42023 . ////////////////////////////////////////////////////////////////////////////
42024 . ////////////////////////////////////////////////////////////////////////////
42025
42026 .chapter "Events" "CHAPevents" &&&
42027          "Events"
42028 .cindex events
42029
42030 The events mechanism in Exim can be used to intercept processing at a number
42031 of points.  It was originally invented to give a way to do customised logging
42032 actions (for example, to a database) but can also be used to modify some
42033 processing actions.
42034
42035 Most installations will never need to use Events.
42036 The support can be left out of a build by defining DISABLE_EVENT=yes
42037 in &_Local/Makefile_&.
42038
42039 There are two major classes of events: main and transport.
42040 The main configuration option &%event_action%& controls reception events;
42041 a transport option &%event_action%& controls delivery events.
42042
42043 Both options are a string which is expanded when the event fires.
42044 An example might look like:
42045 .cindex logging custom
42046 .code
42047 event_action = ${if eq {msg:delivery}{$event_name} \
42048 {${lookup pgsql {SELECT * FROM record_Delivery( \
42049     '${quote_pgsql:$sender_address_domain}',\
42050     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42051     '${quote_pgsql:$domain}', \
42052     '${quote_pgsql:${lc:$local_part}}', \
42053     '${quote_pgsql:$host_address}', \
42054     '${quote_pgsql:${lc:$host}}', \
42055     '${quote_pgsql:$message_exim_id}')}} \
42056 } {}}
42057 .endd
42058
42059 Events have names which correspond to the point in process at which they fire.
42060 The name is placed in the variable &$event_name$& and the event action
42061 expansion must check this, as it will be called for every possible event type.
42062
42063 The current list of events is:
42064 .display
42065 &`dane:fail              after    transport  `& per connection
42066 &`msg:complete           after    main       `& per message
42067 &`msg:defer              after    transport  `& per message per delivery try
42068 &`msg:delivery           after    transport  `& per recipient
42069 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
42070 &`msg:rcpt:defer         after    transport  `& per recipient
42071 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
42072 &`msg:fail:delivery      after    transport  `& per recipient
42073 &`msg:fail:internal      after    main       `& per recipient
42074 &`tcp:connect            before   transport  `& per connection
42075 &`tcp:close              after    transport  `& per connection
42076 &`tls:cert               before   both       `& per certificate in verification chain
42077 &`smtp:connect           after    transport  `& per connection
42078 &`smtp:ehlo              after    transport  `& per connection
42079 .endd
42080 New event types may be added in future.
42081
42082 The event name is a colon-separated list, defining the type of
42083 event in a tree of possibilities.  It may be used as a list
42084 or just matched on as a whole.  There will be no spaces in the name.
42085
42086 The second column in the table above describes whether the event fires
42087 before or after the action is associates with.  Those which fire before
42088 can be used to affect that action (more on this below).
42089
42090 The third column in the table above says what section of the configuration
42091 should define the event action.
42092
42093 An additional variable, &$event_data$&, is filled with information varying
42094 with the event type:
42095 .display
42096 &`dane:fail            `& failure reason
42097 &`msg:defer            `& error string
42098 &`msg:delivery         `& smtp confirmation message
42099 &`msg:fail:internal    `& failure reason
42100 &`msg:fail:delivery    `& smtp error message
42101 &`msg:host:defer       `& error string
42102 &`msg:rcpt:host:defer  `& error string
42103 &`msg:rcpt:defer       `& error string
42104 &`tls:cert             `& verification chain depth
42105 &`smtp:connect         `& smtp banner
42106 &`smtp:ehlo            `& smtp ehlo response
42107 .endd
42108
42109 The :defer events populate one extra variable: &$event_defer_errno$&.
42110
42111 For complex operations an ACL expansion can be used in &%event_action%&
42112 however due to the multiple contexts that Exim operates in during
42113 the course of its processing:
42114 .ilist
42115 variables set in transport events will not be visible outside that
42116 transport call
42117 .next
42118 acl_m variables in a server context are lost on a new connection,
42119 and after smtp helo/ehlo/mail/starttls/rset commands
42120 .endlist
42121 Using an ACL expansion with the logwrite modifier can be
42122 a useful way of writing to the main log.
42123
42124 The expansion of the event_action option should normally
42125 return an empty string.  Should it return anything else the
42126 following will be forced:
42127 .display
42128 &`tcp:connect      `&  do not connect
42129 &`tls:cert         `&  refuse verification
42130 &`smtp:connect     `&  close connection
42131 .endd
42132 All other message types ignore the result string, and
42133 no other use is made of it.
42134
42135 For a tcp:connect event, if the connection is being made to a proxy
42136 then the address and port variables will be that of the proxy and not
42137 the target system.
42138
42139 For tls:cert events, if GnuTLS is in use this will trigger only per
42140 chain element received on the connection.
42141 For OpenSSL it will trigger for every chain element including those
42142 loaded locally.
42143
42144 . ////////////////////////////////////////////////////////////////////////////
42145 . ////////////////////////////////////////////////////////////////////////////
42146
42147 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42148          "Adding drivers or lookups"
42149 .cindex "adding drivers"
42150 .cindex "new drivers, adding"
42151 .cindex "drivers" "adding new"
42152 The following actions have to be taken in order to add a new router, transport,
42153 authenticator, or lookup type to Exim:
42154
42155 .olist
42156 Choose a name for the driver or lookup type that does not conflict with any
42157 existing name; I will use &"newdriver"& in what follows.
42158 .next
42159 Add to &_src/EDITME_& the line:
42160 .display
42161 <&'type'&>&`_NEWDRIVER=yes`&
42162 .endd
42163 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42164 code is not to be included in the binary by default, comment this line out. You
42165 should also add any relevant comments about the driver or lookup type.
42166 .next
42167 Add to &_src/config.h.defaults_& the line:
42168 .code
42169 #define <type>_NEWDRIVER
42170 .endd
42171 .next
42172 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42173 and create a table entry as is done for all the other drivers and lookup types.
42174 .next
42175 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42176 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42177 Add your &`NEWDRIVER`& to that list.
42178 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42179 simple form that most lookups have.
42180 .next
42181 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42182 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42183 driver or lookup type and add it to the definition of OBJ.
42184 .next
42185 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42186 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42187 .next
42188 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42189 &_src_&.
42190 .next
42191 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42192 as for other drivers and lookups.
42193 .endlist
42194
42195 Then all you need to do is write the code! A good way to start is to make a
42196 proforma by copying an existing module of the same type, globally changing all
42197 occurrences of the name, and cutting out most of the code. Note that any
42198 options you create must be listed in alphabetical order, because the tables are
42199 searched using a binary chop procedure.
42200
42201 There is a &_README_& file in each of the sub-directories of &_src_& describing
42202 the interface that is expected.
42203
42204
42205
42206
42207 . ////////////////////////////////////////////////////////////////////////////
42208 . ////////////////////////////////////////////////////////////////////////////
42209
42210 . /////////////////////////////////////////////////////////////////////////////
42211 . These lines are processing instructions for the Simple DocBook Processor that
42212 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42213 . PDFs than using xmlto and fop. They will be ignored by all other XML
42214 . processors.
42215 . /////////////////////////////////////////////////////////////////////////////
42216
42217 .literal xml
42218 <?sdop
42219   format="newpage"
42220   foot_right_recto="&chaptertitle;"
42221   foot_right_verso="&chaptertitle;"
42222 ?>
42223 .literal off
42224
42225 .makeindex "Options index"   "option"
42226 .makeindex "Variables index" "variable"
42227 .makeindex "Concept index"   "concept"
42228
42229
42230 . /////////////////////////////////////////////////////////////////////////////
42231 . /////////////////////////////////////////////////////////////////////////////