Testsuite: add test for hanging callout connections
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.93"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2019
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part$&"
1403 .vindex "&$local_part_suffix$&"
1404 .cindex affix "router precondition"
1405 If the &%local_parts%& option is set, the local part of the address must be in
1406 the set of local parts that it defines. If &%local_part_prefix%& or
1407 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1408 part before this check. If you want to do precondition tests on local parts
1409 that include affixes, you can do so by using a &%condition%& option (see below)
1410 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1411 &$local_part_suffix$& as necessary.
1412 .next
1413 .vindex "&$local_user_uid$&"
1414 .vindex "&$local_user_gid$&"
1415 .vindex "&$home$&"
1416 If the &%check_local_user%& option is set, the local part must be the name of
1417 an account on the local host. If this check succeeds, the uid and gid of the
1418 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1419 user's home directory is placed in &$home$&; these values can be used in the
1420 remaining preconditions.
1421 .next
1422 If the &%router_home_directory%& option is set, it is expanded at this point,
1423 because it overrides the value of &$home$&. If this expansion were left till
1424 later, the value of &$home$& as set by &%check_local_user%& would be used in
1425 subsequent tests. Having two different values of &$home$& in the same router
1426 could lead to confusion.
1427 .next
1428 If the &%senders%& option is set, the envelope sender address must be in the
1429 set of addresses that it defines.
1430 .next
1431 If the &%require_files%& option is set, the existence or non-existence of
1432 specified files is tested.
1433 .next
1434 .cindex "customizing" "precondition"
1435 If the &%condition%& option is set, it is evaluated and tested. This option
1436 uses an expanded string to allow you to set up your own custom preconditions.
1437 Expanded strings are described in chapter &<<CHAPexpand>>&.
1438 .endlist
1439
1440
1441 Note that &%require_files%& comes near the end of the list, so you cannot use
1442 it to check for the existence of a file in which to lookup up a domain, local
1443 part, or sender. However, as these options are all expanded, you can use the
1444 &%exists%& expansion condition to make such tests within each condition. The
1445 &%require_files%& option is intended for checking files that the router may be
1446 going to use internally, or which are needed by a specific transport (for
1447 example, &_.procmailrc_&).
1448
1449
1450
1451 .section "Delivery in detail" "SECID18"
1452 .cindex "delivery" "in detail"
1453 When a message is to be delivered, the sequence of events is as follows:
1454
1455 .ilist
1456 If a system-wide filter file is specified, the message is passed to it. The
1457 filter may add recipients to the message, replace the recipients, discard the
1458 message, cause a new message to be generated, or cause the message delivery to
1459 fail. The format of the system filter file is the same as for Exim user filter
1460 files, described in the separate document entitled &'Exim's interfaces to mail
1461 filtering'&.
1462 .cindex "Sieve filter" "not available for system filter"
1463 (&*Note*&: Sieve cannot be used for system filter files.)
1464
1465 Some additional features are available in system filters &-- see chapter
1466 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1467 filter only once per delivery attempt, however many recipients it has. However,
1468 if there are several delivery attempts because one or more addresses could not
1469 be immediately delivered, the system filter is run each time. The filter
1470 condition &%first_delivery%& can be used to detect the first run of the system
1471 filter.
1472 .next
1473 Each recipient address is offered to each configured router, in turn, subject to
1474 its preconditions, until one is able to handle it. If no router can handle the
1475 address, that is, if they all decline, the address is failed. Because routers
1476 can be targeted at particular domains, several locally handled domains can be
1477 processed entirely independently of each other.
1478 .next
1479 .cindex "routing" "loops in"
1480 .cindex "loop" "while routing"
1481 A router that accepts an address may assign it to a local or a remote
1482 transport. However, the transport is not run at this time. Instead, the address
1483 is placed on a list for the particular transport, which will be run later.
1484 Alternatively, the router may generate one or more new addresses (typically
1485 from alias, forward, or filter files). New addresses are fed back into this
1486 process from the top, but in order to avoid loops, a router ignores any address
1487 which has an identically-named ancestor that was processed by itself.
1488 .next
1489 When all the routing has been done, addresses that have been successfully
1490 handled are passed to their assigned transports. When local transports are
1491 doing real local deliveries, they handle only one address at a time, but if a
1492 local transport is being used as a pseudo-remote transport (for example, to
1493 collect batched SMTP messages for transmission by some other means) multiple
1494 addresses can be handled. Remote transports can always handle more than one
1495 address at a time, but can be configured not to do so, or to restrict multiple
1496 addresses to the same domain.
1497 .next
1498 Each local delivery to a file or a pipe runs in a separate process under a
1499 non-privileged uid, and these deliveries are run one at a time. Remote
1500 deliveries also run in separate processes, normally under a uid that is private
1501 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1502 run in parallel. The maximum number of simultaneous remote deliveries for any
1503 one message is set by the &%remote_max_parallel%& option.
1504 The order in which deliveries are done is not defined, except that all local
1505 deliveries happen before any remote deliveries.
1506 .next
1507 .cindex "queue runner"
1508 When it encounters a local delivery during a queue run, Exim checks its retry
1509 database to see if there has been a previous temporary delivery failure for the
1510 address before running the local transport. If there was a previous failure,
1511 Exim does not attempt a new delivery until the retry time for the address is
1512 reached. However, this happens only for delivery attempts that are part of a
1513 queue run. Local deliveries are always attempted when delivery immediately
1514 follows message reception, even if retry times are set for them. This makes for
1515 better behaviour if one particular message is causing problems (for example,
1516 causing quota overflow, or provoking an error in a filter file).
1517 .next
1518 .cindex "delivery" "retry in remote transports"
1519 Remote transports do their own retry handling, since an address may be
1520 deliverable to one of a number of hosts, each of which may have a different
1521 retry time. If there have been previous temporary failures and no host has
1522 reached its retry time, no delivery is attempted, whether in a queue run or
1523 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1524 .next
1525 If there were any permanent errors, a bounce message is returned to an
1526 appropriate address (the sender in the common case), with details of the error
1527 for each failing address. Exim can be configured to send copies of bounce
1528 messages to other addresses.
1529 .next
1530 .cindex "delivery" "deferral"
1531 If one or more addresses suffered a temporary failure, the message is left on
1532 the queue, to be tried again later. Delivery of these addresses is said to be
1533 &'deferred'&.
1534 .next
1535 When all the recipient addresses have either been delivered or bounced,
1536 handling of the message is complete. The spool files and message log are
1537 deleted, though the message log can optionally be preserved if required.
1538 .endlist
1539
1540
1541
1542
1543 .section "Retry mechanism" "SECID19"
1544 .cindex "delivery" "retry mechanism"
1545 .cindex "retry" "description of mechanism"
1546 .cindex "queue runner"
1547 Exim's mechanism for retrying messages that fail to get delivered at the first
1548 attempt is the queue runner process. You must either run an Exim daemon that
1549 uses the &%-q%& option with a time interval to start queue runners at regular
1550 intervals or use some other means (such as &'cron'&) to start them. If you do
1551 not arrange for queue runners to be run, messages that fail temporarily at the
1552 first attempt will remain in your queue forever. A queue runner process works
1553 its way through the queue, one message at a time, trying each delivery that has
1554 passed its retry time.
1555 You can run several queue runners at once.
1556
1557 Exim uses a set of configured rules to determine when next to retry the failing
1558 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1559 should give up trying to deliver to the address, at which point it generates a
1560 bounce message. If no retry rules are set for a particular host, address, and
1561 error combination, no retries are attempted, and temporary errors are treated
1562 as permanent.
1563
1564
1565
1566 .section "Temporary delivery failure" "SECID20"
1567 .cindex "delivery" "temporary failure"
1568 There are many reasons why a message may not be immediately deliverable to a
1569 particular address. Failure to connect to a remote machine (because it, or the
1570 connection to it, is down) is one of the most common. Temporary failures may be
1571 detected during routing as well as during the transport stage of delivery.
1572 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1573 is on a file system where the user is over quota. Exim can be configured to
1574 impose its own quotas on local mailboxes; where system quotas are set they will
1575 also apply.
1576
1577 If a host is unreachable for a period of time, a number of messages may be
1578 waiting for it by the time it recovers, and sending them in a single SMTP
1579 connection is clearly beneficial. Whenever a delivery to a remote host is
1580 deferred,
1581 .cindex "hints database" "deferred deliveries"
1582 Exim makes a note in its hints database, and whenever a successful
1583 SMTP delivery has happened, it looks to see if any other messages are waiting
1584 for the same host. If any are found, they are sent over the same SMTP
1585 connection, subject to a configuration limit as to the maximum number in any
1586 one connection.
1587
1588
1589
1590 .section "Permanent delivery failure" "SECID21"
1591 .cindex "delivery" "permanent failure"
1592 .cindex "bounce message" "when generated"
1593 When a message cannot be delivered to some or all of its intended recipients, a
1594 bounce message is generated. Temporary delivery failures turn into permanent
1595 errors when their timeout expires. All the addresses that fail in a given
1596 delivery attempt are listed in a single message. If the original message has
1597 many recipients, it is possible for some addresses to fail in one delivery
1598 attempt and others to fail subsequently, giving rise to more than one bounce
1599 message. The wording of bounce messages can be customized by the administrator.
1600 See chapter &<<CHAPemsgcust>>& for details.
1601
1602 .cindex "&'X-Failed-Recipients:'& header line"
1603 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1604 failed addresses, for the benefit of programs that try to analyse such messages
1605 automatically.
1606
1607 .cindex "bounce message" "recipient of"
1608 A bounce message is normally sent to the sender of the original message, as
1609 obtained from the message's envelope. For incoming SMTP messages, this is the
1610 address given in the MAIL command. However, when an address is expanded via a
1611 forward or alias file, an alternative address can be specified for delivery
1612 failures of the generated addresses. For a mailing list expansion (see section
1613 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1614 of the list.
1615
1616
1617
1618 .section "Failures to deliver bounce messages" "SECID22"
1619 .cindex "bounce message" "failure to deliver"
1620 If a bounce message (either locally generated or received from a remote host)
1621 itself suffers a permanent delivery failure, the message is left in the queue,
1622 but it is frozen, awaiting the attention of an administrator. There are options
1623 that can be used to make Exim discard such failed messages, or to keep them
1624 for only a short time (see &%timeout_frozen_after%& and
1625 &%ignore_bounce_errors_after%&).
1626
1627
1628
1629
1630
1631 . ////////////////////////////////////////////////////////////////////////////
1632 . ////////////////////////////////////////////////////////////////////////////
1633
1634 .chapter "Building and installing Exim" "CHID3"
1635 .scindex IIDbuex "building Exim"
1636
1637 .section "Unpacking" "SECID23"
1638 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1639 creates a directory with the name of the current release (for example,
1640 &_exim-&version()_&) into which the following files are placed:
1641
1642 .table2 140pt
1643 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1644 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1645   documented"
1646 .irow &_LICENCE_&         "the GNU General Public Licence"
1647 .irow &_Makefile_&        "top-level make file"
1648 .irow &_NOTICE_&          "conditions for the use of Exim"
1649 .irow &_README_&          "list of files, directories and simple build &&&
1650   instructions"
1651 .endtable
1652
1653 Other files whose names begin with &_README_& may also be present. The
1654 following subdirectories are created:
1655
1656 .table2 140pt
1657 .irow &_Local_&           "an empty directory for local configuration files"
1658 .irow &_OS_&              "OS-specific files"
1659 .irow &_doc_&             "documentation files"
1660 .irow &_exim_monitor_&    "source files for the Exim monitor"
1661 .irow &_scripts_&         "scripts used in the build process"
1662 .irow &_src_&             "remaining source files"
1663 .irow &_util_&            "independent utilities"
1664 .endtable
1665
1666 The main utility programs are contained in the &_src_& directory and are built
1667 with the Exim binary. The &_util_& directory contains a few optional scripts
1668 that may be useful to some sites.
1669
1670
1671 .section "Multiple machine architectures and operating systems" "SECID24"
1672 .cindex "building Exim" "multiple OS/architectures"
1673 The building process for Exim is arranged to make it easy to build binaries for
1674 a number of different architectures and operating systems from the same set of
1675 source files. Compilation does not take place in the &_src_& directory.
1676 Instead, a &'build directory'& is created for each architecture and operating
1677 system.
1678 .cindex "symbolic link" "to build directory"
1679 Symbolic links to the sources are installed in this directory, which is where
1680 the actual building takes place. In most cases, Exim can discover the machine
1681 architecture and operating system for itself, but the defaults can be
1682 overridden if necessary.
1683 .cindex compiler requirements
1684 .cindex compiler version
1685 A C99-capable compiler will be required for the build.
1686
1687
1688 .section "PCRE library" "SECTpcre"
1689 .cindex "PCRE library"
1690 Exim no longer has an embedded PCRE library as the vast majority of
1691 modern systems include PCRE as a system library, although you may need to
1692 install the PCRE package or the PCRE development package for your operating
1693 system. If your system has a normal PCRE installation the Exim build
1694 process will need no further configuration. If the library or the
1695 headers are in an unusual location you will need to either set the PCRE_LIBS
1696 and INCLUDE directives appropriately,
1697 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1698 If your operating system has no
1699 PCRE support then you will need to obtain and build the current PCRE
1700 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1701 More information on PCRE is available at &url(https://www.pcre.org/).
1702
1703 .section "DBM libraries" "SECTdb"
1704 .cindex "DBM libraries" "discussion of"
1705 .cindex "hints database" "DBM files used for"
1706 Even if you do not use any DBM files in your configuration, Exim still needs a
1707 DBM library in order to operate, because it uses indexed files for its hints
1708 databases. Unfortunately, there are a number of DBM libraries in existence, and
1709 different operating systems often have different ones installed.
1710
1711 .cindex "Solaris" "DBM library for"
1712 .cindex "IRIX, DBM library for"
1713 .cindex "BSD, DBM library for"
1714 .cindex "Linux, DBM library for"
1715 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1716 Linux distribution, the DBM configuration should happen automatically, and you
1717 may be able to ignore this section. Otherwise, you may have to learn more than
1718 you would like about DBM libraries from what follows.
1719
1720 .cindex "&'ndbm'& DBM library"
1721 Licensed versions of Unix normally contain a library of DBM functions operating
1722 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1723 versions of Unix seem to vary in what they contain as standard. In particular,
1724 some early versions of Linux have no default DBM library, and different
1725 distributors have chosen to bundle different libraries with their packaged
1726 versions. However, the more recent releases seem to have standardized on the
1727 Berkeley DB library.
1728
1729 Different DBM libraries have different conventions for naming the files they
1730 use. When a program opens a file called &_dbmfile_&, there are several
1731 possibilities:
1732
1733 .olist
1734 A traditional &'ndbm'& implementation, such as that supplied as part of
1735 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1736 .next
1737 .cindex "&'gdbm'& DBM library"
1738 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1739 compatibility interface it makes two different hard links to it with names
1740 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1741 filename is used unmodified.
1742 .next
1743 .cindex "Berkeley DB library"
1744 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1745 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1746 programmer exactly the same as the traditional &'ndbm'& implementation.
1747 .next
1748 If the Berkeley package is used in its native mode, it operates on a single
1749 file called &_dbmfile_&; the programmer's interface is somewhat different to
1750 the traditional &'ndbm'& interface.
1751 .next
1752 To complicate things further, there are several very different versions of the
1753 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1754 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1755 Maintenance of some of the earlier releases has ceased. All versions of
1756 Berkeley DB could be obtained from
1757 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1758 page with far newer versions listed.
1759 It is probably wise to plan to move your storage configurations away from
1760 Berkeley DB format, as today there are smaller and simpler alternatives more
1761 suited to Exim's usage model.
1762 .next
1763 .cindex "&'tdb'& DBM library"
1764 Yet another DBM library, called &'tdb'&, is available from
1765 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1766 operates on a single file.
1767 .endlist
1768
1769 .cindex "USE_DB"
1770 .cindex "DBM libraries" "configuration for building"
1771 Exim and its utilities can be compiled to use any of these interfaces. In order
1772 to use any version of the Berkeley DB package in native mode, you must set
1773 USE_DB in an appropriate configuration file (typically
1774 &_Local/Makefile_&). For example:
1775 .code
1776 USE_DB=yes
1777 .endd
1778 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1779 error is diagnosed if you set more than one of these.
1780
1781 At the lowest level, the build-time configuration sets none of these options,
1782 thereby assuming an interface of type (1). However, some operating system
1783 configuration files (for example, those for the BSD operating systems and
1784 Linux) assume type (4) by setting USE_DB as their default, and the
1785 configuration files for Cygwin set USE_GDBM. Anything you set in
1786 &_Local/Makefile_&, however, overrides these system defaults.
1787
1788 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1789 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1790 in one of these lines:
1791 .code
1792 DBMLIB = -ldb
1793 DBMLIB = -ltdb
1794 .endd
1795 Settings like that will work if the DBM library is installed in the standard
1796 place. Sometimes it is not, and the library's header file may also not be in
1797 the default path. You may need to set INCLUDE to specify where the header
1798 file is, and to specify the path to the library more fully in DBMLIB, as in
1799 this example:
1800 .code
1801 INCLUDE=-I/usr/local/include/db-4.1
1802 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1803 .endd
1804 There is further detailed discussion about the various DBM libraries in the
1805 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1806
1807
1808
1809 .section "Pre-building configuration" "SECID25"
1810 .cindex "building Exim" "pre-building configuration"
1811 .cindex "configuration for building Exim"
1812 .cindex "&_Local/Makefile_&"
1813 .cindex "&_src/EDITME_&"
1814 Before building Exim, a local configuration file that specifies options
1815 independent of any operating system has to be created with the name
1816 &_Local/Makefile_&. A template for this file is supplied as the file
1817 &_src/EDITME_&, and it contains full descriptions of all the option settings
1818 therein. These descriptions are therefore not repeated here. If you are
1819 building Exim for the first time, the simplest thing to do is to copy
1820 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1821
1822 There are three settings that you must supply, because Exim will not build
1823 without them. They are the location of the runtime configuration file
1824 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1825 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1826 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1827 a colon-separated list of filenames; Exim uses the first of them that exists.
1828
1829 There are a few other parameters that can be specified either at build time or
1830 at runtime, to enable the same binary to be used on a number of different
1831 machines. However, if the locations of Exim's spool directory and log file
1832 directory (if not within the spool directory) are fixed, it is recommended that
1833 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1834 detected early in Exim's execution (such as a malformed configuration file) can
1835 be logged.
1836
1837 .cindex "content scanning" "specifying at build time"
1838 Exim's interfaces for calling virus and spam scanning software directly from
1839 access control lists are not compiled by default. If you want to include these
1840 facilities, you need to set
1841 .code
1842 WITH_CONTENT_SCAN=yes
1843 .endd
1844 in your &_Local/Makefile_&. For details of the facilities themselves, see
1845 chapter &<<CHAPexiscan>>&.
1846
1847
1848 .cindex "&_Local/eximon.conf_&"
1849 .cindex "&_exim_monitor/EDITME_&"
1850 If you are going to build the Exim monitor, a similar configuration process is
1851 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1852 your installation and saved under the name &_Local/eximon.conf_&. If you are
1853 happy with the default settings described in &_exim_monitor/EDITME_&,
1854 &_Local/eximon.conf_& can be empty, but it must exist.
1855
1856 This is all the configuration that is needed in straightforward cases for known
1857 operating systems. However, the building process is set up so that it is easy
1858 to override options that are set by default or by operating-system-specific
1859 configuration files, for example, to change the C compiler, which
1860 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1861 do this.
1862
1863
1864
1865 .section "Support for iconv()" "SECID26"
1866 .cindex "&[iconv()]& support"
1867 .cindex "RFC 2047"
1868 The contents of header lines in messages may be encoded according to the rules
1869 described RFC 2047. This makes it possible to transmit characters that are not
1870 in the ASCII character set, and to label them as being in a particular
1871 character set. When Exim is inspecting header lines by means of the &%$h_%&
1872 mechanism, it decodes them, and translates them into a specified character set
1873 (default is set at build time). The translation is possible only if the operating system
1874 supports the &[iconv()]& function.
1875
1876 However, some of the operating systems that supply &[iconv()]& do not support
1877 very many conversions. The GNU &%libiconv%& library (available from
1878 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1879 systems to remedy this deficiency, as well as on systems that do not supply
1880 &[iconv()]& at all. After installing &%libiconv%&, you should add
1881 .code
1882 HAVE_ICONV=yes
1883 .endd
1884 to your &_Local/Makefile_& and rebuild Exim.
1885
1886
1887
1888 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1889 .cindex "TLS" "including support for TLS"
1890 .cindex "encryption" "including support for"
1891 .cindex "OpenSSL" "building Exim with"
1892 .cindex "GnuTLS" "building Exim with"
1893 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1894 command as per RFC 2487. It can also support clients that expect to
1895 start a TLS session immediately on connection to a non-standard port (see the
1896 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1897 line option).
1898
1899 If you want to build Exim with TLS support, you must first install either the
1900 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1901 implementing SSL.
1902
1903 If you do not want TLS support you should set
1904 .code
1905 DISABLE_TLS=yes
1906 .endd
1907 in &_Local/Makefile_&.
1908
1909 If OpenSSL is installed, you should set
1910 .code
1911 USE_OPENSL=yes
1912 TLS_LIBS=-lssl -lcrypto
1913 .endd
1914 in &_Local/Makefile_&. You may also need to specify the locations of the
1915 OpenSSL library and include files. For example:
1916 .code
1917 USE_OPENSSL=yes
1918 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1919 TLS_INCLUDE=-I/usr/local/openssl/include/
1920 .endd
1921 .cindex "pkg-config" "OpenSSL"
1922 If you have &'pkg-config'& available, then instead you can just use:
1923 .code
1924 USE_OPENSSL=yes
1925 USE_OPENSSL_PC=openssl
1926 .endd
1927 .cindex "USE_GNUTLS"
1928 If GnuTLS is installed, you should set
1929 .code
1930 USE_GNUTLS=yes
1931 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1932 .endd
1933 in &_Local/Makefile_&, and again you may need to specify the locations of the
1934 library and include files. For example:
1935 .code
1936 USE_GNUTLS=yes
1937 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1938 TLS_INCLUDE=-I/usr/gnu/include
1939 .endd
1940 .cindex "pkg-config" "GnuTLS"
1941 If you have &'pkg-config'& available, then instead you can just use:
1942 .code
1943 USE_GNUTLS=yes
1944 USE_GNUTLS_PC=gnutls
1945 .endd
1946
1947 You do not need to set TLS_INCLUDE if the relevant directory is already
1948 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1949 given in chapter &<<CHAPTLS>>&.
1950
1951
1952
1953
1954 .section "Use of tcpwrappers" "SECID27"
1955
1956 .cindex "tcpwrappers, building Exim to support"
1957 .cindex "USE_TCP_WRAPPERS"
1958 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1959 .cindex "tcp_wrappers_daemon_name"
1960 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1961 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1962 alternative to Exim's own checking facilities for installations that are
1963 already making use of &'tcpwrappers'& for other purposes. To do this, you
1964 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1965 &_tcpd.h_& to be available at compile time, and also ensure that the library
1966 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1967 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1968 you might have
1969 .code
1970 USE_TCP_WRAPPERS=yes
1971 CFLAGS=-O -I/usr/local/include
1972 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1973 .endd
1974 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1975 files is &"exim"&. For example, the line
1976 .code
1977 exim : LOCAL  192.168.1.  .friendly.domain.example
1978 .endd
1979 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1980 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1981 All other connections are denied. The daemon name used by &'tcpwrappers'&
1982 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1983 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1984 configure file. Consult the &'tcpwrappers'& documentation for
1985 further details.
1986
1987
1988 .section "Including support for IPv6" "SECID28"
1989 .cindex "IPv6" "including support for"
1990 Exim contains code for use on systems that have IPv6 support. Setting
1991 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1992 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1993 where the IPv6 support is not fully integrated into the normal include and
1994 library files.
1995
1996 Two different types of DNS record for handling IPv6 addresses have been
1997 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1998 currently seen as the mainstream. Another record type called A6 was proposed
1999 as better than AAAA because it had more flexibility. However, it was felt to be
2000 over-complex, and its status was reduced to &"experimental"&.
2001 Exim used to
2002 have a compile option for including A6 record support but this has now been
2003 withdrawn.
2004
2005
2006
2007 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2008 .cindex "lookup modules"
2009 .cindex "dynamic modules"
2010 .cindex ".so building"
2011 On some platforms, Exim supports not compiling all lookup types directly into
2012 the main binary, instead putting some into external modules which can be loaded
2013 on demand.
2014 This permits packagers to build Exim with support for lookups with extensive
2015 library dependencies without requiring all users to install all of those
2016 dependencies.
2017 Most, but not all, lookup types can be built this way.
2018
2019 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2020 installed; Exim will only load modules from that directory, as a security
2021 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2022 for your OS; see &_OS/Makefile-Linux_& for an example.
2023 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2024 see &_src/EDITME_& for details.
2025
2026 Then, for each module to be loaded dynamically, define the relevant
2027 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2028 For example, this will build in lsearch but load sqlite and mysql support
2029 on demand:
2030 .code
2031 LOOKUP_LSEARCH=yes
2032 LOOKUP_SQLITE=2
2033 LOOKUP_MYSQL=2
2034 .endd
2035
2036
2037 .section "The building process" "SECID29"
2038 .cindex "build directory"
2039 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2040 created, run &'make'& at the top level. It determines the architecture and
2041 operating system types, and creates a build directory if one does not exist.
2042 For example, on a Sun system running Solaris 8, the directory
2043 &_build-SunOS5-5.8-sparc_& is created.
2044 .cindex "symbolic link" "to source files"
2045 Symbolic links to relevant source files are installed in the build directory.
2046
2047 If this is the first time &'make'& has been run, it calls a script that builds
2048 a make file inside the build directory, using the configuration files from the
2049 &_Local_& directory. The new make file is then passed to another instance of
2050 &'make'&. This does the real work, building a number of utility scripts, and
2051 then compiling and linking the binaries for the Exim monitor (if configured), a
2052 number of utility programs, and finally Exim itself. The command &`make
2053 makefile`& can be used to force a rebuild of the make file in the build
2054 directory, should this ever be necessary.
2055
2056 If you have problems building Exim, check for any comments there may be in the
2057 &_README_& file concerning your operating system, and also take a look at the
2058 FAQ, where some common problems are covered.
2059
2060
2061
2062 .section 'Output from &"make"&' "SECID283"
2063 The output produced by the &'make'& process for compile lines is often very
2064 unreadable, because these lines can be very long. For this reason, the normal
2065 output is suppressed by default, and instead output similar to that which
2066 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2067 each module that is being compiled or linked. However, it is still possible to
2068 get the full output, by calling &'make'& like this:
2069 .code
2070 FULLECHO='' make -e
2071 .endd
2072 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2073 command reflection in &'make'&. When you ask for the full output, it is
2074 given in addition to the short output.
2075
2076
2077
2078 .section "Overriding build-time options for Exim" "SECToverride"
2079 .cindex "build-time options, overriding"
2080 The main make file that is created at the beginning of the building process
2081 consists of the concatenation of a number of files which set configuration
2082 values, followed by a fixed set of &'make'& instructions. If a value is set
2083 more than once, the last setting overrides any previous ones. This provides a
2084 convenient way of overriding defaults. The files that are concatenated are, in
2085 order:
2086 .display
2087 &_OS/Makefile-Default_&
2088 &_OS/Makefile-_&<&'ostype'&>
2089 &_Local/Makefile_&
2090 &_Local/Makefile-_&<&'ostype'&>
2091 &_Local/Makefile-_&<&'archtype'&>
2092 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2093 &_OS/Makefile-Base_&
2094 .endd
2095 .cindex "&_Local/Makefile_&"
2096 .cindex "building Exim" "operating system type"
2097 .cindex "building Exim" "architecture type"
2098 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2099 architecture type. &_Local/Makefile_& is required to exist, and the building
2100 process fails if it is absent. The other three &_Local_& files are optional,
2101 and are often not needed.
2102
2103 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2104 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2105 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2106 values are used, thereby providing a means of forcing particular settings.
2107 Otherwise, the scripts try to get values from the &%uname%& command. If this
2108 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2109 of &'ad hoc'& transformations are then applied, to produce the standard names
2110 that Exim expects. You can run these scripts directly from the shell in order
2111 to find out what values are being used on your system.
2112
2113
2114 &_OS/Makefile-Default_& contains comments about the variables that are set
2115 therein. Some (but not all) are mentioned below. If there is something that
2116 needs changing, review the contents of this file and the contents of the make
2117 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2118 default values are.
2119
2120
2121 .cindex "building Exim" "overriding default settings"
2122 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2123 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2124 need to change the original files. Instead, you should make the changes by
2125 putting the new values in an appropriate &_Local_& file. For example,
2126 .cindex "Tru64-Unix build-time settings"
2127 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2128 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2129 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2130 called with the option &%-std1%&, to make it recognize some of the features of
2131 Standard C that Exim uses. (Most other compilers recognize Standard C by
2132 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2133 containing the lines
2134 .code
2135 CC=cc
2136 CFLAGS=-std1
2137 .endd
2138 If you are compiling for just one operating system, it may be easier to put
2139 these lines directly into &_Local/Makefile_&.
2140
2141 Keeping all your local configuration settings separate from the distributed
2142 files makes it easy to transfer them to new versions of Exim simply by copying
2143 the contents of the &_Local_& directory.
2144
2145
2146 .cindex "NIS lookup type" "including support for"
2147 .cindex "NIS+ lookup type" "including support for"
2148 .cindex "LDAP" "including support for"
2149 .cindex "lookup" "inclusion in binary"
2150 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2151 lookup, but not all systems have these components installed, so the default is
2152 not to include the relevant code in the binary. All the different kinds of file
2153 and database lookup that Exim supports are implemented as separate code modules
2154 which are included only if the relevant compile-time options are set. In the
2155 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2156 .code
2157 LOOKUP_LDAP=yes
2158 LOOKUP_NIS=yes
2159 LOOKUP_NISPLUS=yes
2160 .endd
2161 and similar settings apply to the other lookup types. They are all listed in
2162 &_src/EDITME_&. In many cases the relevant include files and interface
2163 libraries need to be installed before compiling Exim.
2164 .cindex "cdb" "including support for"
2165 However, there are some optional lookup types (such as cdb) for which
2166 the code is entirely contained within Exim, and no external include
2167 files or libraries are required. When a lookup type is not included in the
2168 binary, attempts to configure Exim to use it cause runtime configuration
2169 errors.
2170
2171 .cindex "pkg-config" "lookups"
2172 .cindex "pkg-config" "authenticators"
2173 Many systems now use a tool called &'pkg-config'& to encapsulate information
2174 about how to compile against a library; Exim has some initial support for
2175 being able to use pkg-config for lookups and authenticators.  For any given
2176 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2177 variable with the &`_PC`& suffix in the name and assign as the value the
2178 name of the package to be queried.  The results of querying via the
2179 &'pkg-config'& command will be added to the appropriate Makefile variables
2180 with &`+=`& directives, so your version of &'make'& will need to support that
2181 syntax.  For instance:
2182 .code
2183 LOOKUP_SQLITE=yes
2184 LOOKUP_SQLITE_PC=sqlite3
2185 AUTH_GSASL=yes
2186 AUTH_GSASL_PC=libgsasl
2187 AUTH_HEIMDAL_GSSAPI=yes
2188 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2189 .endd
2190
2191 .cindex "Perl" "including support for"
2192 Exim can be linked with an embedded Perl interpreter, allowing Perl
2193 subroutines to be called during string expansion. To enable this facility,
2194 .code
2195 EXIM_PERL=perl.o
2196 .endd
2197 must be defined in &_Local/Makefile_&. Details of this facility are given in
2198 chapter &<<CHAPperl>>&.
2199
2200 .cindex "X11 libraries, location of"
2201 The location of the X11 libraries is something that varies a lot between
2202 operating systems, and there may be different versions of X11 to cope
2203 with. Exim itself makes no use of X11, but if you are compiling the Exim
2204 monitor, the X11 libraries must be available.
2205 The following three variables are set in &_OS/Makefile-Default_&:
2206 .code
2207 X11=/usr/X11R6
2208 XINCLUDE=-I$(X11)/include
2209 XLFLAGS=-L$(X11)/lib
2210 .endd
2211 These are overridden in some of the operating-system configuration files. For
2212 example, in &_OS/Makefile-SunOS5_& there is
2213 .code
2214 X11=/usr/openwin
2215 XINCLUDE=-I$(X11)/include
2216 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2217 .endd
2218 If you need to override the default setting for your operating system, place a
2219 definition of all three of these variables into your
2220 &_Local/Makefile-<ostype>_& file.
2221
2222 .cindex "EXTRALIBS"
2223 If you need to add any extra libraries to the link steps, these can be put in a
2224 variable called EXTRALIBS, which appears in all the link commands, but by
2225 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2226 command for linking the main Exim binary, and not for any associated utilities.
2227
2228 .cindex "DBM libraries" "configuration for building"
2229 There is also DBMLIB, which appears in the link commands for binaries that
2230 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2231 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2232 binary, and which can be used, for example, to include additional X11
2233 libraries.
2234
2235 .cindex "configuration file" "editing"
2236 The make file copes with rebuilding Exim correctly if any of the configuration
2237 files are edited. However, if an optional configuration file is deleted, it is
2238 necessary to touch the associated non-optional file (that is,
2239 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2240
2241
2242 .section "OS-specific header files" "SECID30"
2243 .cindex "&_os.h_&"
2244 .cindex "building Exim" "OS-specific C header files"
2245 The &_OS_& directory contains a number of files with names of the form
2246 &_os.h-<ostype>_&. These are system-specific C header files that should not
2247 normally need to be changed. There is a list of macro settings that are
2248 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2249 are porting Exim to a new operating system.
2250
2251
2252
2253 .section "Overriding build-time options for the monitor" "SECID31"
2254 .cindex "building Eximon"
2255 A similar process is used for overriding things when building the Exim monitor,
2256 where the files that are involved are
2257 .display
2258 &_OS/eximon.conf-Default_&
2259 &_OS/eximon.conf-_&<&'ostype'&>
2260 &_Local/eximon.conf_&
2261 &_Local/eximon.conf-_&<&'ostype'&>
2262 &_Local/eximon.conf-_&<&'archtype'&>
2263 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2264 .endd
2265 .cindex "&_Local/eximon.conf_&"
2266 As with Exim itself, the final three files need not exist, and in this case the
2267 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2268 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2269 variables of the same name, preceded by EXIMON_. For example, setting
2270 EXIMON_LOG_DEPTH in the environment overrides the value of
2271 LOG_DEPTH at runtime.
2272 .ecindex IIDbuex
2273
2274
2275 .section "Installing Exim binaries and scripts" "SECID32"
2276 .cindex "installing Exim"
2277 .cindex "BIN_DIRECTORY"
2278 The command &`make install`& runs the &(exim_install)& script with no
2279 arguments. The script copies binaries and utility scripts into the directory
2280 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2281 .cindex "setuid" "installing Exim with"
2282 The install script copies files only if they are newer than the files they are
2283 going to replace. The Exim binary is required to be owned by root and have the
2284 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2285 install`& as root so that it can set up the Exim binary in this way. However, in
2286 some special situations (for example, if a host is doing no local deliveries)
2287 it may be possible to run Exim without making the binary setuid root (see
2288 chapter &<<CHAPsecurity>>& for details).
2289
2290 .cindex "CONFIGURE_FILE"
2291 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2292 in &_Local/Makefile_&. If this names a single file, and the file does not
2293 exist, the default configuration file &_src/configure.default_& is copied there
2294 by the installation script. If a runtime configuration file already exists, it
2295 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2296 alternative files, no default is installed.
2297
2298 .cindex "system aliases file"
2299 .cindex "&_/etc/aliases_&"
2300 One change is made to the default configuration file when it is installed: the
2301 default configuration contains a router that references a system aliases file.
2302 The path to this file is set to the value specified by
2303 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2304 If the system aliases file does not exist, the installation script creates it,
2305 and outputs a comment to the user.
2306
2307 The created file contains no aliases, but it does contain comments about the
2308 aliases a site should normally have. Mail aliases have traditionally been
2309 kept in &_/etc/aliases_&. However, some operating systems are now using
2310 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2311 Exim's configuration if necessary.
2312
2313 The default configuration uses the local host's name as the only local domain,
2314 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2315 running as the local user. System aliases and &_.forward_& files in users' home
2316 directories are supported, but no NIS or NIS+ support is configured. Domains
2317 other than the name of the local host are routed using the DNS, with delivery
2318 over SMTP.
2319
2320 It is possible to install Exim for special purposes (such as building a binary
2321 distribution) in a private part of the file system. You can do this by a
2322 command such as
2323 .code
2324 make DESTDIR=/some/directory/ install
2325 .endd
2326 This has the effect of pre-pending the specified directory to all the file
2327 paths, except the name of the system aliases file that appears in the default
2328 configuration. (If a default alias file is created, its name &'is'& modified.)
2329 For backwards compatibility, ROOT is used if DESTDIR is not set,
2330 but this usage is deprecated.
2331
2332 .cindex "installing Exim" "what is not installed"
2333 Running &'make install'& does not copy the Exim 4 conversion script
2334 &'convert4r4'&. You will probably run this only once if you are
2335 upgrading from Exim 3. None of the documentation files in the &_doc_&
2336 directory are copied, except for the info files when you have set
2337 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2338
2339 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2340 to their names. The Exim binary itself, however, is handled differently. It is
2341 installed under a name that includes the version number and the compile number,
2342 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2343 called &_exim_& to point to the binary. If you are updating a previous version
2344 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2345 from the directory (as seen by other processes).
2346
2347 .cindex "installing Exim" "testing the script"
2348 If you want to see what the &'make install'& will do before running it for
2349 real, you can pass the &%-n%& option to the installation script by this
2350 command:
2351 .code
2352 make INSTALL_ARG=-n install
2353 .endd
2354 The contents of the variable INSTALL_ARG are passed to the installation
2355 script. You do not need to be root to run this test. Alternatively, you can run
2356 the installation script directly, but this must be from within the build
2357 directory. For example, from the top-level Exim directory you could use this
2358 command:
2359 .code
2360 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2361 .endd
2362 .cindex "installing Exim" "install script options"
2363 There are two other options that can be supplied to the installation script.
2364
2365 .ilist
2366 &%-no_chown%& bypasses the call to change the owner of the installed binary
2367 to root, and the call to make it a setuid binary.
2368 .next
2369 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2370 installed binary.
2371 .endlist
2372
2373 INSTALL_ARG can be used to pass these options to the script. For example:
2374 .code
2375 make INSTALL_ARG=-no_symlink install
2376 .endd
2377 The installation script can also be given arguments specifying which files are
2378 to be copied. For example, to install just the Exim binary, and nothing else,
2379 without creating the symbolic link, you could use:
2380 .code
2381 make INSTALL_ARG='-no_symlink exim' install
2382 .endd
2383
2384
2385
2386 .section "Installing info documentation" "SECTinsinfdoc"
2387 .cindex "installing Exim" "&'info'& documentation"
2388 Not all systems use the GNU &'info'& system for documentation, and for this
2389 reason, the Texinfo source of Exim's documentation is not included in the main
2390 distribution. Instead it is available separately from the FTP site (see section
2391 &<<SECTavail>>&).
2392
2393 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2394 source of the documentation is found in the source tree, running &`make
2395 install`& automatically builds the info files and installs them.
2396
2397
2398
2399 .section "Setting up the spool directory" "SECID33"
2400 .cindex "spool directory" "creating"
2401 When it starts up, Exim tries to create its spool directory if it does not
2402 exist. The Exim uid and gid are used for the owner and group of the spool
2403 directory. Sub-directories are automatically created in the spool directory as
2404 necessary.
2405
2406
2407
2408
2409 .section "Testing" "SECID34"
2410 .cindex "testing" "installation"
2411 Having installed Exim, you can check that the runtime configuration file is
2412 syntactically valid by running the following command, which assumes that the
2413 Exim binary directory is within your PATH environment variable:
2414 .code
2415 exim -bV
2416 .endd
2417 If there are any errors in the configuration file, Exim outputs error messages.
2418 Otherwise it outputs the version number and build date,
2419 the DBM library that is being used, and information about which drivers and
2420 other optional code modules are included in the binary.
2421 Some simple routing tests can be done by using the address testing option. For
2422 example,
2423 .display
2424 &`exim -bt`& <&'local username'&>
2425 .endd
2426 should verify that it recognizes a local mailbox, and
2427 .display
2428 &`exim -bt`& <&'remote address'&>
2429 .endd
2430 a remote one. Then try getting it to deliver mail, both locally and remotely.
2431 This can be done by passing messages directly to Exim, without going through a
2432 user agent. For example:
2433 .code
2434 exim -v postmaster@your.domain.example
2435 From: user@your.domain.example
2436 To: postmaster@your.domain.example
2437 Subject: Testing Exim
2438
2439 This is a test message.
2440 ^D
2441 .endd
2442 The &%-v%& option causes Exim to output some verification of what it is doing.
2443 In this case you should see copies of three log lines, one for the message's
2444 arrival, one for its delivery, and one containing &"Completed"&.
2445
2446 .cindex "delivery" "problems with"
2447 If you encounter problems, look at Exim's log files (&'mainlog'& and
2448 &'paniclog'&) to see if there is any relevant information there. Another source
2449 of information is running Exim with debugging turned on, by specifying the
2450 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2451 with debugging turned on by a command of the form
2452 .display
2453 &`exim -d -M`& <&'exim-message-id'&>
2454 .endd
2455 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2456 produces rather a lot of output, but you can cut this down to specific areas.
2457 For example, if you use &%-d-all+route%& only the debugging information
2458 relevant to routing is included. (See the &%-d%& option in chapter
2459 &<<CHAPcommandline>>& for more details.)
2460
2461 .cindex '&"sticky"& bit'
2462 .cindex "lock files"
2463 One specific problem that has shown up on some sites is the inability to do
2464 local deliveries into a shared mailbox directory, because it does not have the
2465 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2466 writing to a mailbox file, and if it cannot create the lock file, the delivery
2467 is deferred. You can get round this either by setting the &"sticky bit"& on the
2468 directory, or by setting a specific group for local deliveries and allowing
2469 that group to create files in the directory (see the comments above the
2470 &(local_delivery)& transport in the default configuration file). Another
2471 approach is to configure Exim not to use lock files, but just to rely on
2472 &[fcntl()]& locking instead. However, you should do this only if all user
2473 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2474 see chapter &<<CHAPappendfile>>&.
2475
2476 One thing that cannot be tested on a system that is already running an MTA is
2477 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2478 &%-oX%& option can be used to run an Exim daemon that listens on some other
2479 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2480 &'exim_checkaccess'& utility can be used to check out policy controls on
2481 incoming SMTP mail.
2482
2483 Testing a new version on a system that is already running Exim can most easily
2484 be done by building a binary with a different CONFIGURE_FILE setting. From
2485 within the runtime configuration, all other file and directory names
2486 that Exim uses can be altered, in order to keep it entirely clear of the
2487 production version.
2488
2489
2490 .section "Replacing another MTA with Exim" "SECID35"
2491 .cindex "replacing another MTA"
2492 Building and installing Exim for the first time does not of itself put it in
2493 general use. The name by which the system's MTA is called by mail user agents
2494 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2495 operating system), and it is necessary to make this name point to the &'exim'&
2496 binary in order to get the user agents to pass messages to Exim. This is
2497 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2498 or &_/usr/lib/sendmail_&
2499 .cindex "symbolic link" "to &'exim'& binary"
2500 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2501 privilege and executable status from the old MTA. It is then necessary to stop
2502 and restart the mailer daemon, if one is running.
2503
2504 .cindex "FreeBSD, MTA indirection"
2505 .cindex "&_/etc/mail/mailer.conf_&"
2506 Some operating systems have introduced alternative ways of switching MTAs. For
2507 example, if you are running FreeBSD, you need to edit the file
2508 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2509 described. A typical example of the contents of this file for running Exim is
2510 as follows:
2511 .code
2512 sendmail            /usr/exim/bin/exim
2513 send-mail           /usr/exim/bin/exim
2514 mailq               /usr/exim/bin/exim -bp
2515 newaliases          /usr/bin/true
2516 .endd
2517 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2518 your Exim installation is &"live"&. Check it by sending a message from your
2519 favourite user agent.
2520
2521 You should consider what to tell your users about the change of MTA. Exim may
2522 have different capabilities to what was previously running, and there are
2523 various operational differences such as the text of messages produced by
2524 command line options and in bounce messages. If you allow your users to make
2525 use of Exim's filtering capabilities, you should make the document entitled
2526 &'Exim's interface to mail filtering'& available to them.
2527
2528
2529
2530 .section "Upgrading Exim" "SECID36"
2531 .cindex "upgrading Exim"
2532 If you are already running Exim on your host, building and installing a new
2533 version automatically makes it available to MUAs, or any other programs that
2534 call the MTA directly. However, if you are running an Exim daemon, you do need
2535 .cindex restart "on HUP signal"
2536 .cindex signal "HUP, to restart"
2537 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2538 new binary. You do not need to stop processing mail in order to install a new
2539 version of Exim. The install script does not modify an existing runtime
2540 configuration file.
2541
2542
2543
2544
2545 .section "Stopping the Exim daemon on Solaris" "SECID37"
2546 .cindex "Solaris" "stopping Exim on"
2547 The standard command for stopping the mailer daemon on Solaris is
2548 .code
2549 /etc/init.d/sendmail stop
2550 .endd
2551 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2552 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2553 for the text &"sendmail"&; this is not present because the actual program name
2554 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2555 solution is to replace the line that finds the process id with something like
2556 .code
2557 pid=`cat /var/spool/exim/exim-daemon.pid`
2558 .endd
2559 to obtain the daemon's pid directly from the file that Exim saves it in.
2560
2561 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2562 still be received from local processes, and if automatic delivery is configured
2563 (the normal case), deliveries will still occur.
2564
2565
2566
2567
2568 . ////////////////////////////////////////////////////////////////////////////
2569 . ////////////////////////////////////////////////////////////////////////////
2570
2571 .chapter "The Exim command line" "CHAPcommandline"
2572 .scindex IIDclo1 "command line" "options"
2573 .scindex IIDclo2 "options" "command line"
2574 Exim's command line takes the standard Unix form of a sequence of options,
2575 each starting with a hyphen character, followed by a number of arguments. The
2576 options are compatible with the main options of Sendmail, and there are also
2577 some additional options, some of which are compatible with Smail 3. Certain
2578 combinations of options do not make sense, and provoke an error if used.
2579 The form of the arguments depends on which options are set.
2580
2581
2582 .section "Setting options by program name" "SECID38"
2583 .cindex "&'mailq'&"
2584 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2585 were present before any other options.
2586 The &%-bp%& option requests a listing of the contents of the mail queue on the
2587 standard output.
2588 This feature is for compatibility with some systems that contain a command of
2589 that name in one of the standard libraries, symbolically linked to
2590 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2591
2592 .cindex "&'rsmtp'&"
2593 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2594 were present before any other options, for compatibility with Smail. The
2595 &%-bS%& option is used for reading in a number of messages in batched SMTP
2596 format.
2597
2598 .cindex "&'rmail'&"
2599 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2600 &%-oee%& options were present before any other options, for compatibility with
2601 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2602
2603 .cindex "&'runq'&"
2604 .cindex "queue runner"
2605 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2606 were present before any other options, for compatibility with Smail. The &%-q%&
2607 option causes a single queue runner process to be started.
2608
2609 .cindex "&'newaliases'&"
2610 .cindex "alias file" "building"
2611 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2612 If Exim is called under the name &'newaliases'& it behaves as if the option
2613 &%-bi%& were present before any other options, for compatibility with Sendmail.
2614 This option is used for rebuilding Sendmail's alias file. Exim does not have
2615 the concept of a single alias file, but can be configured to run a given
2616 command if called with the &%-bi%& option.
2617
2618
2619 .section "Trusted and admin users" "SECTtrustedadmin"
2620 Some Exim options are available only to &'trusted users'& and others are
2621 available only to &'admin users'&. In the description below, the phrases &"Exim
2622 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2623 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2624 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2625
2626 .ilist
2627 .cindex "trusted users" "definition of"
2628 .cindex "user" "trusted definition of"
2629 The trusted users are root, the Exim user, any user listed in the
2630 &%trusted_users%& configuration option, and any user whose current group or any
2631 supplementary group is one of those listed in the &%trusted_groups%&
2632 configuration option. Note that the Exim group is not automatically trusted.
2633
2634 .cindex '&"From"& line'
2635 .cindex "envelope from"
2636 .cindex "envelope sender"
2637 Trusted users are always permitted to use the &%-f%& option or a leading
2638 &"From&~"& line to specify the envelope sender of a message that is passed to
2639 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2640 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2641 users to set envelope senders.
2642
2643 .cindex "&'From:'& header line"
2644 .cindex "&'Sender:'& header line"
2645 .cindex "header lines" "From:"
2646 .cindex "header lines" "Sender:"
2647 For a trusted user, there is never any check on the contents of the &'From:'&
2648 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2649 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2650
2651 Trusted users may also specify a host name, host address, interface address,
2652 protocol name, ident value, and authentication data when submitting a message
2653 locally. Thus, they are able to insert messages into Exim's queue locally that
2654 have the characteristics of messages received from a remote host. Untrusted
2655 users may in some circumstances use &%-f%&, but can never set the other values
2656 that are available to trusted users.
2657 .next
2658 .cindex "user" "admin definition of"
2659 .cindex "admin user" "definition of"
2660 The admin users are root, the Exim user, and any user that is a member of the
2661 Exim group or of any group listed in the &%admin_groups%& configuration option.
2662 The current group does not have to be one of these groups.
2663
2664 Admin users are permitted to list the queue, and to carry out certain
2665 operations on messages, for example, to force delivery failures. It is also
2666 necessary to be an admin user in order to see the full information provided by
2667 the Exim monitor, and full debugging output.
2668
2669 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2670 Exim to attempt delivery of messages on its queue is restricted to admin users.
2671 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2672 option false (that is, specifying &%no_prod_requires_admin%&).
2673
2674 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2675 is restricted to admin users unless &%queue_list_requires_admin%& is set
2676 false.
2677 .endlist
2678
2679
2680 &*Warning*&: If you configure your system so that admin users are able to
2681 edit Exim's configuration file, you are giving those users an easy way of
2682 getting root. There is further discussion of this issue at the start of chapter
2683 &<<CHAPconf>>&.
2684
2685
2686
2687
2688 .section "Command line options" "SECID39"
2689 Exim's command line options are described in alphabetical order below. If none
2690 of the options that specifies a specific action (such as starting the daemon or
2691 a queue runner, or testing an address, or receiving a message in a specific
2692 format, or listing the queue) are present, and there is at least one argument
2693 on the command line, &%-bm%& (accept a local message on the standard input,
2694 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2695 outputs a brief message about itself and exits.
2696
2697 . ////////////////////////////////////////////////////////////////////////////
2698 . Insert a stylized XML comment here, to identify the start of the command line
2699 . options. This is for the benefit of the Perl script that automatically
2700 . creates a man page for the options.
2701 . ////////////////////////////////////////////////////////////////////////////
2702
2703 .literal xml
2704 <!-- === Start of command line options === -->
2705 .literal off
2706
2707
2708 .vlist
2709 .vitem &%--%&
2710 .oindex "--"
2711 .cindex "options" "command line; terminating"
2712 This is a pseudo-option whose only purpose is to terminate the options and
2713 therefore to cause subsequent command line items to be treated as arguments
2714 rather than options, even if they begin with hyphens.
2715
2716 .vitem &%--help%&
2717 .oindex "&%--help%&"
2718 This option causes Exim to output a few sentences stating what it is.
2719 The same output is generated if the Exim binary is called with no options and
2720 no arguments.
2721
2722 .vitem &%--version%&
2723 .oindex "&%--version%&"
2724 This option is an alias for &%-bV%& and causes version information to be
2725 displayed.
2726
2727 .vitem &%-Ac%& &&&
2728        &%-Am%&
2729 .oindex "&%-Ac%&"
2730 .oindex "&%-Am%&"
2731 These options are used by Sendmail for selecting configuration files and are
2732 ignored by Exim.
2733
2734 .vitem &%-B%&<&'type'&>
2735 .oindex "&%-B%&"
2736 .cindex "8-bit characters"
2737 .cindex "Sendmail compatibility" "8-bit characters"
2738 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2739 clean; it ignores this option.
2740
2741 .vitem &%-bd%&
2742 .oindex "&%-bd%&"
2743 .cindex "daemon"
2744 .cindex "SMTP" "listener"
2745 .cindex "queue runner"
2746 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2747 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2748 that the daemon should also initiate periodic queue runs.
2749
2750 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2751 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2752 disconnect from the controlling terminal. When running this way, it can be
2753 stopped by pressing ctrl-C.
2754
2755 By default, Exim listens for incoming connections to the standard SMTP port on
2756 all the host's running interfaces. However, it is possible to listen on other
2757 ports, on multiple ports, and only on specific interfaces. Chapter
2758 &<<CHAPinterfaces>>& contains a description of the options that control this.
2759
2760 When a listening daemon
2761 .cindex "daemon" "process id (pid)"
2762 .cindex "pid (process id)" "of daemon"
2763 is started without the use of &%-oX%& (that is, without overriding the normal
2764 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2765 in Exim's spool directory. This location can be overridden by setting
2766 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2767 running as root.
2768
2769 When &%-oX%& is used on the command line to start a listening daemon, the
2770 process id is not written to the normal pid file path. However, &%-oP%& can be
2771 used to specify a path on the command line if a pid file is required.
2772
2773 The SIGHUP signal
2774 .cindex "SIGHUP"
2775 .cindex restart "on HUP signal"
2776 .cindex signal "HUP, to restart"
2777 .cindex "daemon" "restarting"
2778 .cindex signal "to reload configuration"
2779 .cindex daemon "reload configuration"
2780 .cindex reload configuration
2781 can be used to cause the daemon to re-execute itself. This should be done
2782 whenever Exim's configuration file, or any file that is incorporated into it by
2783 means of the &%.include%& facility, is changed, and also whenever a new version
2784 of Exim is installed. It is not necessary to do this when other files that are
2785 referenced from the configuration (for example, alias files) are changed,
2786 because these are reread each time they are used.
2787
2788 .vitem &%-bdf%&
2789 .oindex "&%-bdf%&"
2790 This option has the same effect as &%-bd%& except that it never disconnects
2791 from the controlling terminal, even when no debugging is specified.
2792
2793 .vitem &%-be%&
2794 .oindex "&%-be%&"
2795 .cindex "testing" "string expansion"
2796 .cindex "expansion" "testing"
2797 Run Exim in expansion testing mode. Exim discards its root privilege, to
2798 prevent ordinary users from using this mode to read otherwise inaccessible
2799 files. If no arguments are given, Exim runs interactively, prompting for lines
2800 of data. Otherwise, it processes each argument in turn.
2801
2802 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2803 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2804 used without command line arguments. If successful, it uses the &[readline()]&
2805 function, which provides extensive line-editing facilities, for reading the
2806 test data. A line history is supported.
2807
2808 Long expansion expressions can be split over several lines by using backslash
2809 continuations. As in Exim's runtime configuration, white space at the start of
2810 continuation lines is ignored. Each argument or data line is passed through the
2811 string expansion mechanism, and the result is output. Variable values from the
2812 configuration file (for example, &$qualify_domain$&) are available, but no
2813 message-specific values (such as &$message_exim_id$&) are set, because no message
2814 is being processed (but see &%-bem%& and &%-Mset%&).
2815
2816 &*Note*&: If you use this mechanism to test lookups, and you change the data
2817 files or databases you are using, you must exit and restart Exim before trying
2818 the same lookup again. Otherwise, because each Exim process caches the results
2819 of lookups, you will just get the same result as before.
2820
2821 Macro processing is done on lines before string-expansion: new macros can be
2822 defined and macros will be expanded.
2823 Because macros in the config file are often used for secrets, those are only
2824 available to admin users.
2825
2826 .vitem &%-bem%&&~<&'filename'&>
2827 .oindex "&%-bem%&"
2828 .cindex "testing" "string expansion"
2829 .cindex "expansion" "testing"
2830 This option operates like &%-be%& except that it must be followed by the name
2831 of a file. For example:
2832 .code
2833 exim -bem /tmp/testmessage
2834 .endd
2835 The file is read as a message (as if receiving a locally-submitted non-SMTP
2836 message) before any of the test expansions are done. Thus, message-specific
2837 variables such as &$message_size$& and &$header_from:$& are available. However,
2838 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2839 recipients are read from the headers in the normal way, and are shown in the
2840 &$recipients$& variable. Note that recipients cannot be given on the command
2841 line, because further arguments are taken as strings to expand (just like
2842 &%-be%&).
2843
2844 .vitem &%-bF%&&~<&'filename'&>
2845 .oindex "&%-bF%&"
2846 .cindex "system filter" "testing"
2847 .cindex "testing" "system filter"
2848 This option is the same as &%-bf%& except that it assumes that the filter being
2849 tested is a system filter. The additional commands that are available only in
2850 system filters are recognized.
2851
2852 .vitem &%-bf%&&~<&'filename'&>
2853 .oindex "&%-bf%&"
2854 .cindex "filter" "testing"
2855 .cindex "testing" "filter file"
2856 .cindex "forward file" "testing"
2857 .cindex "testing" "forward file"
2858 .cindex "Sieve filter" "testing"
2859 This option runs Exim in user filter testing mode; the file is the filter file
2860 to be tested, and a test message must be supplied on the standard input. If
2861 there are no message-dependent tests in the filter, an empty file can be
2862 supplied.
2863
2864 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2865 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2866 filter and a user filter in the same run. For example:
2867 .code
2868 exim -bF /system/filter -bf /user/filter </test/message
2869 .endd
2870 This is helpful when the system filter adds header lines or sets filter
2871 variables that are used by the user filter.
2872
2873 If the test filter file does not begin with one of the special lines
2874 .code
2875 # Exim filter
2876 # Sieve filter
2877 .endd
2878 it is taken to be a normal &_.forward_& file, and is tested for validity under
2879 that interpretation. See sections &<<SECTitenonfilred>>& to
2880 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2881 redirection lists.
2882
2883 The result of an Exim command that uses &%-bf%&, provided no errors are
2884 detected, is a list of the actions that Exim would try to take if presented
2885 with the message for real. More details of filter testing are given in the
2886 separate document entitled &'Exim's interfaces to mail filtering'&.
2887
2888 When testing a filter file,
2889 .cindex "&""From""& line"
2890 .cindex "envelope from"
2891 .cindex "envelope sender"
2892 .oindex "&%-f%&" "for filter testing"
2893 the envelope sender can be set by the &%-f%& option,
2894 or by a &"From&~"& line at the start of the test message. Various parameters
2895 that would normally be taken from the envelope recipient address of the message
2896 can be set by means of additional command line options (see the next four
2897 options).
2898
2899 .vitem &%-bfd%&&~<&'domain'&>
2900 .oindex "&%-bfd%&"
2901 .vindex "&$qualify_domain$&"
2902 This sets the domain of the recipient address when a filter file is being
2903 tested by means of the &%-bf%& option. The default is the value of
2904 &$qualify_domain$&.
2905
2906 .vitem &%-bfl%&&~<&'local&~part'&>
2907 .oindex "&%-bfl%&"
2908 This sets the local part of the recipient address when a filter file is being
2909 tested by means of the &%-bf%& option. The default is the username of the
2910 process that calls Exim. A local part should be specified with any prefix or
2911 suffix stripped, because that is how it appears to the filter when a message is
2912 actually being delivered.
2913
2914 .vitem &%-bfp%&&~<&'prefix'&>
2915 .oindex "&%-bfp%&"
2916 .cindex affix "filter testing"
2917 This sets the prefix of the local part of the recipient address when a filter
2918 file is being tested by means of the &%-bf%& option. The default is an empty
2919 prefix.
2920
2921 .vitem &%-bfs%&&~<&'suffix'&>
2922 .oindex "&%-bfs%&"
2923 .cindex affix "filter testing"
2924 This sets the suffix of the local part of the recipient address when a filter
2925 file is being tested by means of the &%-bf%& option. The default is an empty
2926 suffix.
2927
2928 .vitem &%-bh%&&~<&'IP&~address'&>
2929 .oindex "&%-bh%&"
2930 .cindex "testing" "incoming SMTP"
2931 .cindex "SMTP" "testing incoming"
2932 .cindex "testing" "relay control"
2933 .cindex "relaying" "testing configuration"
2934 .cindex "policy control" "testing"
2935 .cindex "debugging" "&%-bh%& option"
2936 This option runs a fake SMTP session as if from the given IP address, using the
2937 standard input and output. The IP address may include a port number at the end,
2938 after a full stop. For example:
2939 .code
2940 exim -bh 10.9.8.7.1234
2941 exim -bh fe80::a00:20ff:fe86:a061.5678
2942 .endd
2943 When an IPv6 address is given, it is converted into canonical form. In the case
2944 of the second example above, the value of &$sender_host_address$& after
2945 conversion to the canonical form is
2946 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2947
2948 Comments as to what is going on are written to the standard error file. These
2949 include lines beginning with &"LOG"& for anything that would have been logged.
2950 This facility is provided for testing configuration options for incoming
2951 messages, to make sure they implement the required policy. For example, you can
2952 test your relay controls using &%-bh%&.
2953
2954 &*Warning 1*&:
2955 .cindex "RFC 1413"
2956 You can test features of the configuration that rely on ident (RFC 1413)
2957 information by using the &%-oMt%& option. However, Exim cannot actually perform
2958 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2959 connection.
2960
2961 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2962 are also skipped when testing using &%-bh%&. If you want these callouts to
2963 occur, use &%-bhc%& instead.
2964
2965 Messages supplied during the testing session are discarded, and nothing is
2966 written to any of the real log files. There may be pauses when DNS (and other)
2967 lookups are taking place, and of course these may time out. The &%-oMi%& option
2968 can be used to specify a specific IP interface and port if this is important,
2969 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2970 session were authenticated.
2971
2972 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2973 output just states whether a given recipient address from a given host is
2974 acceptable or not. See section &<<SECTcheckaccess>>&.
2975
2976 Features such as authentication and encryption, where the client input is not
2977 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2978 specialized SMTP test program such as
2979 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2980
2981 .vitem &%-bhc%&&~<&'IP&~address'&>
2982 .oindex "&%-bhc%&"
2983 This option operates in the same way as &%-bh%&, except that address
2984 verification callouts are performed if required. This includes consulting and
2985 updating the callout cache database.
2986
2987 .vitem &%-bi%&
2988 .oindex "&%-bi%&"
2989 .cindex "alias file" "building"
2990 .cindex "building alias file"
2991 .cindex "Sendmail compatibility" "&%-bi%& option"
2992 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2993 Exim does not have the concept of a single alias file, and so it cannot mimic
2994 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2995 tend to appear in various scripts such as NIS make files, so the option must be
2996 recognized.
2997
2998 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2999 configuration option is run, under the uid and gid of the caller of Exim. If
3000 the &%-oA%& option is used, its value is passed to the command as an argument.
3001 The command set by &%bi_command%& may not contain arguments. The command can
3002 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3003 if this is required. If the &%bi_command%& option is not set, calling Exim with
3004 &%-bi%& is a no-op.
3005
3006 . // Keep :help first, then the rest in alphabetical order
3007 .vitem &%-bI:help%&
3008 .oindex "&%-bI:help%&"
3009 .cindex "querying exim information"
3010 We shall provide various options starting &`-bI:`& for querying Exim for
3011 information.  The output of many of these will be intended for machine
3012 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3013 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3014 options shall cause Exim to exit after producing the requested output.
3015
3016 .vitem &%-bI:dscp%&
3017 .oindex "&%-bI:dscp%&"
3018 .cindex "DSCP" "values"
3019 This option causes Exim to emit an alphabetically sorted list of all
3020 recognised DSCP names.
3021
3022 .vitem &%-bI:sieve%&
3023 .oindex "&%-bI:sieve%&"
3024 .cindex "Sieve filter" "capabilities"
3025 This option causes Exim to emit an alphabetically sorted list of all supported
3026 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3027 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3028 &`SIEVE`& capability response line.  As the precise list may depend upon
3029 compile-time build options, which this option will adapt to, this is the only
3030 way to guarantee a correct response.
3031
3032 .vitem &%-bm%&
3033 .oindex "&%-bm%&"
3034 .cindex "local message reception"
3035 This option runs an Exim receiving process that accepts an incoming,
3036 locally-generated message on the standard input. The recipients are given as the
3037 command arguments (except when &%-t%& is also present &-- see below). Each
3038 argument can be a comma-separated list of RFC 2822 addresses. This is the
3039 default option for selecting the overall action of an Exim call; it is assumed
3040 if no other conflicting option is present.
3041
3042 If any addresses in the message are unqualified (have no domain), they are
3043 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3044 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3045 suppressing this for special cases.
3046
3047 Policy checks on the contents of local messages can be enforced by means of
3048 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3049
3050 .cindex "return code" "for &%-bm%&"
3051 The return code is zero if the message is successfully accepted. Otherwise, the
3052 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3053
3054 The format
3055 .cindex "message" "format"
3056 .cindex "format" "message"
3057 .cindex "&""From""& line"
3058 .cindex "UUCP" "&""From""& line"
3059 .cindex "Sendmail compatibility" "&""From""& line"
3060 of the message must be as defined in RFC 2822, except that, for
3061 compatibility with Sendmail and Smail, a line in one of the forms
3062 .code
3063 From sender Fri Jan  5 12:55 GMT 1997
3064 From sender Fri, 5 Jan 97 12:55:01
3065 .endd
3066 (with the weekday optional, and possibly with additional text after the date)
3067 is permitted to appear at the start of the message. There appears to be no
3068 authoritative specification of the format of this line. Exim recognizes it by
3069 matching against the regular expression defined by the &%uucp_from_pattern%&
3070 option, which can be changed if necessary.
3071
3072 .oindex "&%-f%&" "overriding &""From""& line"
3073 The specified sender is treated as if it were given as the argument to the
3074 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3075 preference to the address taken from the message. The caller of Exim must be a
3076 trusted user for the sender of a message to be set in this way.
3077
3078 .vitem &%-bmalware%&&~<&'filename'&>
3079 .oindex "&%-bmalware%&"
3080 .cindex "testing", "malware"
3081 .cindex "malware scan test"
3082 This debugging option causes Exim to scan the given file or directory
3083 (depending on the used scanner interface),
3084 using the malware scanning framework.  The option of &%av_scanner%& influences
3085 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3086 the expansion should have defaults which apply to this invocation.  ACLs are
3087 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3088 will never be populated and &%-bmalware%& will fail.
3089
3090 Exim will have changed working directory before resolving the filename, so
3091 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3092 user when it tries to open the file, rather than as the invoking user.
3093 This option requires admin privileges.
3094
3095 The &%-bmalware%& option will not be extended to be more generally useful,
3096 there are better tools for file-scanning.  This option exists to help
3097 administrators verify their Exim and AV scanner configuration.
3098
3099 .vitem &%-bnq%&
3100 .oindex "&%-bnq%&"
3101 .cindex "address qualification, suppressing"
3102 By default, Exim automatically qualifies unqualified addresses (those
3103 without domains) that appear in messages that are submitted locally (that
3104 is, not over TCP/IP). This qualification applies both to addresses in
3105 envelopes, and addresses in header lines. Sender addresses are qualified using
3106 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3107 defaults to the value of &%qualify_domain%&).
3108
3109 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3110 being used to re-submit messages that originally came from remote hosts after
3111 content scanning, you probably do not want to qualify unqualified addresses in
3112 header lines. (Such lines will be present only if you have not enabled a header
3113 syntax check in the appropriate ACL.)
3114
3115 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3116 messages that originate on the local host. When this is used, unqualified
3117 addresses in the envelope provoke errors (causing message rejection) and
3118 unqualified addresses in header lines are left alone.
3119
3120
3121 .vitem &%-bP%&
3122 .oindex "&%-bP%&"
3123 .cindex "configuration options" "extracting"
3124 .cindex "options" "configuration &-- extracting"
3125 If this option is given with no arguments, it causes the values of all Exim's
3126 main configuration options to be written to the standard output. The values
3127 of one or more specific options can be requested by giving their names as
3128 arguments, for example:
3129 .code
3130 exim -bP qualify_domain hold_domains
3131 .endd
3132 .cindex "hiding configuration option values"
3133 .cindex "configuration options" "hiding value of"
3134 .cindex "options" "hiding value of"
3135 However, any option setting that is preceded by the word &"hide"& in the
3136 configuration file is not shown in full, except to an admin user. For other
3137 users, the output is as in this example:
3138 .code
3139 mysql_servers = <value not displayable>
3140 .endd
3141 If &%config%& is given as an argument, the config is
3142 output, as it was parsed, any include file resolved, any comment removed.
3143
3144 If &%config_file%& is given as an argument, the name of the runtime
3145 configuration file is output. (&%configure_file%& works too, for
3146 backward compatibility.)
3147 If a list of configuration files was supplied, the value that is output here
3148 is the name of the file that was actually used.
3149
3150 .cindex "options" "hiding name of"
3151 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3152 name will not be output.
3153
3154 .cindex "daemon" "process id (pid)"
3155 .cindex "pid (process id)" "of daemon"
3156 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3157 directories where log files and daemon pid files are written are output,
3158 respectively. If these values are unset, log files are written in a
3159 sub-directory of the spool directory called &%log%&, and the pid file is
3160 written directly into the spool directory.
3161
3162 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3163 .code
3164 exim -bP +local_domains
3165 .endd
3166 it searches for a matching named list of any type (domain, host, address, or
3167 local part) and outputs what it finds.
3168
3169 .cindex "options" "router &-- extracting"
3170 .cindex "options" "transport &-- extracting"
3171 .cindex "options" "authenticator &-- extracting"
3172 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3173 followed by the name of an appropriate driver instance, the option settings for
3174 that driver are output. For example:
3175 .code
3176 exim -bP transport local_delivery
3177 .endd
3178 The generic driver options are output first, followed by the driver's private
3179 options. A list of the names of drivers of a particular type can be obtained by
3180 using one of the words &%router_list%&, &%transport_list%&, or
3181 &%authenticator_list%&, and a complete list of all drivers with their option
3182 settings can be obtained by using &%routers%&, &%transports%&, or
3183 &%authenticators%&.
3184
3185 .cindex "environment"
3186 If &%environment%& is given as an argument, the set of environment
3187 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3188 variables.
3189
3190 .cindex "options" "macro &-- extracting"
3191 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3192 are available, similarly to the drivers.  Because macros are sometimes used
3193 for storing passwords, this option is restricted.
3194 The output format is one item per line.
3195 For the "-bP macro <name>" form, if no such macro is found
3196 the exit status will be nonzero.
3197
3198 .vitem &%-bp%&
3199 .oindex "&%-bp%&"
3200 .cindex "queue" "listing messages in"
3201 .cindex "listing" "messages in the queue"
3202 This option requests a listing of the contents of the mail queue on the
3203 standard output. If the &%-bp%& option is followed by a list of message ids,
3204 just those messages are listed. By default, this option can be used only by an
3205 admin user. However, the &%queue_list_requires_admin%& option can be set false
3206 to allow any user to see the queue.
3207
3208 Each message in the queue is displayed as in the following example:
3209 .code
3210 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3211           red.king@looking-glass.fict.example
3212           <other addresses>
3213 .endd
3214 .cindex "message" "size in queue listing"
3215 .cindex "size" "of message"
3216 The first line contains the length of time the message has been in the queue
3217 (in this case 25 minutes), the size of the message (2.9K), the unique local
3218 identifier for the message, and the message sender, as contained in the
3219 envelope. For bounce messages, the sender address is empty, and appears as
3220 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3221 the default sender address, the user's login name is shown in parentheses
3222 before the sender address.
3223
3224 .cindex "frozen messages" "in queue listing"
3225 If the message is frozen (attempts to deliver it are suspended) then the text
3226 &"*** frozen ***"& is displayed at the end of this line.
3227
3228 The recipients of the message (taken from the envelope, not the headers) are
3229 displayed on subsequent lines. Those addresses to which the message has already
3230 been delivered are marked with the letter D. If an original address gets
3231 expanded into several addresses via an alias or forward file, the original is
3232 displayed with a D only when deliveries for all of its child addresses are
3233 complete.
3234
3235
3236 .vitem &%-bpa%&
3237 .oindex "&%-bpa%&"
3238 This option operates like &%-bp%&, but in addition it shows delivered addresses
3239 that were generated from the original top level address(es) in each message by
3240 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3241 of just &"D"&.
3242
3243
3244 .vitem &%-bpc%&
3245 .oindex "&%-bpc%&"
3246 .cindex "queue" "count of messages on"
3247 This option counts the number of messages in the queue, and writes the total
3248 to the standard output. It is restricted to admin users, unless
3249 &%queue_list_requires_admin%& is set false.
3250
3251
3252 .vitem &%-bpr%&
3253 .oindex "&%-bpr%&"
3254 This option operates like &%-bp%&, but the output is not sorted into
3255 chronological order of message arrival. This can speed it up when there are
3256 lots of messages in the queue, and is particularly useful if the output is
3257 going to be post-processed in a way that doesn't need the sorting.
3258
3259 .vitem &%-bpra%&
3260 .oindex "&%-bpra%&"
3261 This option is a combination of &%-bpr%& and &%-bpa%&.
3262
3263 .vitem &%-bpru%&
3264 .oindex "&%-bpru%&"
3265 This option is a combination of &%-bpr%& and &%-bpu%&.
3266
3267
3268 .vitem &%-bpu%&
3269 .oindex "&%-bpu%&"
3270 This option operates like &%-bp%& but shows only undelivered top-level
3271 addresses for each message displayed. Addresses generated by aliasing or
3272 forwarding are not shown, unless the message was deferred after processing by a
3273 router with the &%one_time%& option set.
3274
3275
3276 .vitem &%-brt%&
3277 .oindex "&%-brt%&"
3278 .cindex "testing" "retry configuration"
3279 .cindex "retry" "configuration testing"
3280 This option is for testing retry rules, and it must be followed by up to three
3281 arguments. It causes Exim to look for a retry rule that matches the values
3282 and to write it to the standard output. For example:
3283 .code
3284 exim -brt bach.comp.mus.example
3285 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3286 .endd
3287 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3288 argument, which is required, can be a complete address in the form
3289 &'local_part@domain'&, or it can be just a domain name. If the second argument
3290 contains a dot, it is interpreted as an optional second domain name; if no
3291 retry rule is found for the first argument, the second is tried. This ties in
3292 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3293 rule is found that matches the host, one that matches the mail domain is
3294 sought. Finally, an argument that is the name of a specific delivery error, as
3295 used in setting up retry rules, can be given. For example:
3296 .code
3297 exim -brt haydn.comp.mus.example quota_3d
3298 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3299 .endd
3300
3301 .vitem &%-brw%&
3302 .oindex "&%-brw%&"
3303 .cindex "testing" "rewriting"
3304 .cindex "rewriting" "testing"
3305 This option is for testing address rewriting rules, and it must be followed by
3306 a single argument, consisting of either a local part without a domain, or a
3307 complete address with a fully qualified domain. Exim outputs how this address
3308 would be rewritten for each possible place it might appear. See chapter
3309 &<<CHAPrewrite>>& for further details.
3310
3311 .vitem &%-bS%&
3312 .oindex "&%-bS%&"
3313 .cindex "SMTP" "batched incoming"
3314 .cindex "batched SMTP input"
3315 This option is used for batched SMTP input, which is an alternative interface
3316 for non-interactive local message submission. A number of messages can be
3317 submitted in a single run. However, despite its name, this is not really SMTP
3318 input. Exim reads each message's envelope from SMTP commands on the standard
3319 input, but generates no responses. If the caller is trusted, or
3320 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3321 believed; otherwise the sender is always the caller of Exim.
3322
3323 The message itself is read from the standard input, in SMTP format (leading
3324 dots doubled), terminated by a line containing just a single dot. An error is
3325 provoked if the terminating dot is missing. A further message may then follow.
3326
3327 As for other local message submissions, the contents of incoming batch SMTP
3328 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3329 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3330 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3331
3332 Some other SMTP commands are recognized in the input. HELO and EHLO act
3333 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3334 QUIT quits, ignoring the rest of the standard input.
3335
3336 .cindex "return code" "for &%-bS%&"
3337 If any error is encountered, reports are written to the standard output and
3338 error streams, and Exim gives up immediately. The return code is 0 if no error
3339 was detected; it is 1 if one or more messages were accepted before the error
3340 was detected; otherwise it is 2.
3341
3342 More details of input using batched SMTP are given in section
3343 &<<SECTincomingbatchedSMTP>>&.
3344
3345 .vitem &%-bs%&
3346 .oindex "&%-bs%&"
3347 .cindex "SMTP" "local input"
3348 .cindex "local SMTP input"
3349 This option causes Exim to accept one or more messages by reading SMTP commands
3350 on the standard input, and producing SMTP replies on the standard output. SMTP
3351 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3352 Some user agents use this interface as a way of passing locally-generated
3353 messages to the MTA.
3354
3355 In
3356 .cindex "sender" "source of"
3357 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3358 set, the senders of messages are taken from the SMTP MAIL commands.
3359 Otherwise the content of these commands is ignored and the sender is set up as
3360 the calling user. Unqualified addresses are automatically qualified using
3361 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3362 &%-bnq%& option is used.
3363
3364 .cindex "inetd"
3365 The
3366 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3367 using a listening daemon. Exim can distinguish the two cases by checking
3368 whether the standard input is a TCP/IP socket. When Exim is called from
3369 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3370 above concerning senders and qualification do not apply. In this situation,
3371 Exim behaves in exactly the same way as it does when receiving a message via
3372 the listening daemon.
3373
3374 .vitem &%-bt%&
3375 .oindex "&%-bt%&"
3376 .cindex "testing" "addresses"
3377 .cindex "address" "testing"
3378 This option runs Exim in address testing mode, in which each argument is taken
3379 as a recipient address to be tested for deliverability. The results are
3380 written to the standard output. If a test fails, and the caller is not an admin
3381 user, no details of the failure are output, because these might contain
3382 sensitive information such as usernames and passwords for database lookups.
3383
3384 If no arguments are given, Exim runs in an interactive manner, prompting with a
3385 right angle bracket for addresses to be tested.
3386
3387 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3388 &[readline()]& function, because it is running as &'root'& and there are
3389 security issues.
3390
3391 Each address is handled as if it were the recipient address of a message
3392 (compare the &%-bv%& option). It is passed to the routers and the result is
3393 written to the standard output. However, any router that has
3394 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3395 genuine routing tests if your first router passes everything to a scanner
3396 program.
3397
3398 .cindex "return code" "for &%-bt%&"
3399 The return code is 2 if any address failed outright; it is 1 if no address
3400 failed outright but at least one could not be resolved for some reason. Return
3401 code 0 is given only when all addresses succeed.
3402
3403 .cindex "duplicate addresses"
3404 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3405 addresses after routing is complete, so that only one delivery takes place.
3406 This does not happen when testing with &%-bt%&; the full results of routing are
3407 always shown.
3408
3409 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3410 routers in the configuration makes any tests on the sender address of a
3411 message,
3412 .oindex "&%-f%&" "for address testing"
3413 you can use the &%-f%& option to set an appropriate sender when running
3414 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3415 default qualifying domain. However, if you have set up (for example) routers
3416 whose behaviour depends on the contents of an incoming message, you cannot test
3417 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3418 doing such tests.
3419
3420 .vitem &%-bV%&
3421 .oindex "&%-bV%&"
3422 .cindex "version number of Exim"
3423 This option causes Exim to write the current version number, compilation
3424 number, and compilation date of the &'exim'& binary to the standard output.
3425 It also lists the DBM library that is being used, the optional modules (such as
3426 specific lookup types), the drivers that are included in the binary, and the
3427 name of the runtime configuration file that is in use.
3428
3429 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3430 configuration file. However, this is a static check only. It cannot check
3431 values that are to be expanded. For example, although a misspelt ACL verb is
3432 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3433 alone to discover (for example) all the typos in the configuration; some
3434 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3435 dynamic testing facilities.
3436
3437 .vitem &%-bv%&
3438 .oindex "&%-bv%&"
3439 .cindex "verifying address" "using &%-bv%&"
3440 .cindex "address" "verification"
3441 This option runs Exim in address verification mode, in which each argument is
3442 taken as a recipient address to be verified by the routers. (This does
3443 not involve any verification callouts). During normal operation, verification
3444 happens mostly as a consequence processing a &%verify%& condition in an ACL
3445 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3446 including callouts, see the &%-bh%& and &%-bhc%& options.
3447
3448 If verification fails, and the caller is not an admin user, no details of the
3449 failure are output, because these might contain sensitive information such as
3450 usernames and passwords for database lookups.
3451
3452 If no arguments are given, Exim runs in an interactive manner, prompting with a
3453 right angle bracket for addresses to be verified.
3454
3455 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3456 &[readline()]& function, because it is running as &'exim'& and there are
3457 security issues.
3458
3459 Verification differs from address testing (the &%-bt%& option) in that routers
3460 that have &%no_verify%& set are skipped, and if the address is accepted by a
3461 router that has &%fail_verify%& set, verification fails. The address is
3462 verified as a recipient if &%-bv%& is used; to test verification for a sender
3463 address, &%-bvs%& should be used.
3464
3465 If the &%-v%& option is not set, the output consists of a single line for each
3466 address, stating whether it was verified or not, and giving a reason in the
3467 latter case. Without &%-v%&, generating more than one address by redirection
3468 causes verification to end successfully, without considering the generated
3469 addresses. However, if just one address is generated, processing continues,
3470 and the generated address must verify successfully for the overall verification
3471 to succeed.
3472
3473 When &%-v%& is set, more details are given of how the address has been handled,
3474 and in the case of address redirection, all the generated addresses are also
3475 considered. Verification may succeed for some and fail for others.
3476
3477 The
3478 .cindex "return code" "for &%-bv%&"
3479 return code is 2 if any address failed outright; it is 1 if no address
3480 failed outright but at least one could not be resolved for some reason. Return
3481 code 0 is given only when all addresses succeed.
3482
3483 If any of the routers in the configuration makes any tests on the sender
3484 address of a message, you should use the &%-f%& option to set an appropriate
3485 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3486 calling user at the default qualifying domain.
3487
3488 .vitem &%-bvs%&
3489 .oindex "&%-bvs%&"
3490 This option acts like &%-bv%&, but verifies the address as a sender rather
3491 than a recipient address. This affects any rewriting and qualification that
3492 might happen.
3493
3494 .vitem &%-bw%&
3495 .oindex "&%-bw%&"
3496 .cindex "daemon"
3497 .cindex "inetd"
3498 .cindex "inetd" "wait mode"
3499 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3500 similarly to the &%-bd%& option.  All port specifications on the command-line
3501 and in the configuration file are ignored.  Queue-running may not be specified.
3502
3503 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3504 listening for connections.  This permits the system to start up and have
3505 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3506 each port only when the first connection is received.
3507
3508 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3509 which the daemon will exit, which should cause inetd to listen once more.
3510
3511 .vitem &%-C%&&~<&'filelist'&>
3512 .oindex "&%-C%&"
3513 .cindex "configuration file" "alternate"
3514 .cindex "CONFIGURE_FILE"
3515 .cindex "alternate configuration file"
3516 This option causes Exim to find the runtime configuration file from the given
3517 list instead of from the list specified by the CONFIGURE_FILE
3518 compile-time setting. Usually, the list will consist of just a single filename,
3519 but it can be a colon-separated list of names. In this case, the first
3520 file that exists is used. Failure to open an existing file stops Exim from
3521 proceeding any further along the list, and an error is generated.
3522
3523 When this option is used by a caller other than root, and the list is different
3524 from the compiled-in list, Exim gives up its root privilege immediately, and
3525 runs with the real and effective uid and gid set to those of the caller.
3526 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3527 file contains a list of full pathnames, one per line, for configuration files
3528 which are trusted. Root privilege is retained for any configuration file so
3529 listed, as long as the caller is the Exim user (or the user specified in the
3530 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3531 not writeable by inappropriate users or groups.
3532
3533 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3534 configuration using &%-C%& right through message reception and delivery,
3535 even if the caller is root. The reception works, but by that time, Exim is
3536 running as the Exim user, so when it re-executes to regain privilege for the
3537 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3538 test reception and delivery using two separate commands (one to put a message
3539 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3540
3541 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3542 prefix string with which any file named in a &%-C%& command line option
3543 must start. In addition, the filename must not contain the sequence &`/../`&.
3544 However, if the value of the &%-C%& option is identical to the value of
3545 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3546 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3547 unset, any filename can be used with &%-C%&.
3548
3549 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3550 to a directory to which only root has access. This prevents someone who has
3551 broken into the Exim account from running a privileged Exim with an arbitrary
3552 configuration file.
3553
3554 The &%-C%& facility is useful for ensuring that configuration files are
3555 syntactically correct, but cannot be used for test deliveries, unless the
3556 caller is privileged, or unless it is an exotic configuration that does not
3557 require privilege. No check is made on the owner or group of the files
3558 specified by this option.
3559
3560
3561 .vitem &%-D%&<&'macro'&>=<&'value'&>
3562 .oindex "&%-D%&"
3563 .cindex "macro" "setting on command line"
3564 This option can be used to override macro definitions in the configuration file
3565 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3566 unprivileged caller, it causes Exim to give up its root privilege.
3567 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3568 completely disabled, and its use causes an immediate error exit.
3569
3570 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3571 colon-separated list of macros which are considered safe and, if &%-D%& only
3572 supplies macros from this list, and the values are acceptable, then Exim will
3573 not give up root privilege if the caller is root, the Exim run-time user, or
3574 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3575 to be removed in the future.  Acceptable values for the macros satisfy the
3576 regexp: &`^[A-Za-z0-9_/.-]*$`&
3577
3578 The entire option (including equals sign if present) must all be within one
3579 command line item. &%-D%& can be used to set the value of a macro to the empty
3580 string, in which case the equals sign is optional. These two commands are
3581 synonymous:
3582 .code
3583 exim -DABC  ...
3584 exim -DABC= ...
3585 .endd
3586 To include spaces in a macro definition item, quotes must be used. If you use
3587 quotes, spaces are permitted around the macro name and the equals sign. For
3588 example:
3589 .code
3590 exim '-D ABC = something' ...
3591 .endd
3592 &%-D%& may be repeated up to 10 times on a command line.
3593 Only macro names up to 22 letters long can be set.
3594
3595
3596 .vitem &%-d%&<&'debug&~options'&>
3597 .oindex "&%-d%&"
3598 .cindex "debugging" "list of selectors"
3599 .cindex "debugging" "&%-d%& option"
3600 This option causes debugging information to be written to the standard
3601 error stream. It is restricted to admin users because debugging output may show
3602 database queries that contain password information. Also, the details of users'
3603 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3604 writes an error message to the standard error stream and exits with a non-zero
3605 return code.
3606
3607 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3608 standard debugging data is output. This can be reduced, or increased to include
3609 some more rarely needed information, by directly following &%-d%& with a string
3610 made up of names preceded by plus or minus characters. These add or remove sets
3611 of debugging data, respectively. For example, &%-d+filter%& adds filter
3612 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3613 no spaces are allowed in the debug setting. The available debugging categories
3614 are:
3615 .display
3616 &`acl            `& ACL interpretation
3617 &`auth           `& authenticators
3618 &`deliver        `& general delivery logic
3619 &`dns            `& DNS lookups (see also resolver)
3620 &`dnsbl          `& DNS black list (aka RBL) code
3621 &`exec           `& arguments for &[execv()]& calls
3622 &`expand         `& detailed debugging for string expansions
3623 &`filter         `& filter handling
3624 &`hints_lookup   `& hints data lookups
3625 &`host_lookup    `& all types of name-to-IP address handling
3626 &`ident          `& ident lookup
3627 &`interface      `& lists of local interfaces
3628 &`lists          `& matching things in lists
3629 &`load           `& system load checks
3630 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3631                     &<<CHAPlocalscan>>&)
3632 &`lookup         `& general lookup code and all lookups
3633 &`memory         `& memory handling
3634 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3635 &`pid            `& modifier: add pid to debug output lines
3636 &`process_info   `& setting info for the process log
3637 &`queue_run      `& queue runs
3638 &`receive        `& general message reception logic
3639 &`resolver       `& turn on the DNS resolver's debugging output
3640 &`retry          `& retry handling
3641 &`rewrite        `& address rewriting
3642 &`route          `& address routing
3643 &`timestamp      `& modifier: add timestamp to debug output lines
3644 &`tls            `& TLS logic
3645 &`transport      `& transports
3646 &`uid            `& changes of uid/gid and looking up uid/gid
3647 &`verify         `& address verification logic
3648 &`all            `& almost all of the above (see below), and also &%-v%&
3649 .endd
3650 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3651 for &`-all`&. The reason for this is that &`+all`& is something that people
3652 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3653 is included, an awful lot of output that is very rarely of interest is
3654 generated, so it now has to be explicitly requested. However, &`-all`& does
3655 turn everything off.
3656
3657 .cindex "resolver, debugging output"
3658 .cindex "DNS resolver, debugging output"
3659 The &`resolver`& option produces output only if the DNS resolver was compiled
3660 with DEBUG enabled. This is not the case in some operating systems. Also,
3661 unfortunately, debugging output from the DNS resolver is written to stdout
3662 rather than stderr.
3663
3664 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3665 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3666 However, the &`pid`& selector is forced when debugging is turned on for a
3667 daemon, which then passes it on to any re-executed Exims. Exim also
3668 automatically adds the pid to debug lines when several remote deliveries are
3669 run in parallel.
3670
3671 The &`timestamp`& selector causes the current time to be inserted at the start
3672 of all debug output lines. This can be useful when trying to track down delays
3673 in processing.
3674
3675 .cindex debugging "UTF-8 in"
3676 .cindex UTF-8 "in debug output"
3677 The &`noutf8`& selector disables the use of
3678 UTF-8 line-drawing characters to group related information.
3679 When disabled. ascii-art is used instead.
3680 Using the &`+all`& option does not set this modifier,
3681
3682 If the &%debug_print%& option is set in any driver, it produces output whenever
3683 any debugging is selected, or if &%-v%& is used.
3684
3685 .vitem &%-dd%&<&'debug&~options'&>
3686 .oindex "&%-dd%&"
3687 This option behaves exactly like &%-d%& except when used on a command that
3688 starts a daemon process. In that case, debugging is turned off for the
3689 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3690 behaviour of the daemon without creating as much output as full debugging does.
3691
3692 .vitem &%-dropcr%&
3693 .oindex "&%-dropcr%&"
3694 This is an obsolete option that is now a no-op. It used to affect the way Exim
3695 handled CR and LF characters in incoming messages. What happens now is
3696 described in section &<<SECTlineendings>>&.
3697
3698 .vitem &%-E%&
3699 .oindex "&%-E%&"
3700 .cindex "bounce message" "generating"
3701 This option specifies that an incoming message is a locally-generated delivery
3702 failure report. It is used internally by Exim when handling delivery failures
3703 and is not intended for external use. Its only effect is to stop Exim
3704 generating certain messages to the postmaster, as otherwise message cascades
3705 could occur in some situations. As part of the same option, a message id may
3706 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3707 new message contains the id, following &"R="&, as a cross-reference.
3708
3709 .vitem &%-e%&&'x'&
3710 .oindex "&%-e%&&'x'&"
3711 There are a number of Sendmail options starting with &%-oe%& which seem to be
3712 called by various programs without the leading &%o%& in the option. For
3713 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3714 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3715
3716 .vitem &%-F%&&~<&'string'&>
3717 .oindex "&%-F%&"
3718 .cindex "sender" "name"
3719 .cindex "name" "of sender"
3720 This option sets the sender's full name for use when a locally-generated
3721 message is being accepted. In the absence of this option, the user's &'gecos'&
3722 entry from the password data is used. As users are generally permitted to alter
3723 their &'gecos'& entries, no security considerations are involved. White space
3724 between &%-F%& and the <&'string'&> is optional.
3725
3726 .vitem &%-f%&&~<&'address'&>
3727 .oindex "&%-f%&"
3728 .cindex "sender" "address"
3729 .cindex "address" "sender"
3730 .cindex "trusted users"
3731 .cindex "envelope from"
3732 .cindex "envelope sender"
3733 .cindex "user" "trusted"
3734 This option sets the address of the envelope sender of a locally-generated
3735 message (also known as the return path). The option can normally be used only
3736 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3737 users to use it.
3738
3739 Processes running as root or the Exim user are always trusted. Other
3740 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3741 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3742 of a local message is set to the caller's login name at the default qualify
3743 domain.
3744
3745 There is one exception to the restriction on the use of &%-f%&: an empty sender
3746 can be specified by any user, trusted or not, to create a message that can
3747 never provoke a bounce. An empty sender can be specified either as an empty
3748 string, or as a pair of angle brackets with nothing between them, as in these
3749 examples of shell commands:
3750 .code
3751 exim -f '<>' user@domain
3752 exim -f "" user@domain
3753 .endd
3754 In addition, the use of &%-f%& is not restricted when testing a filter file
3755 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3756 &%-bv%& options.
3757
3758 Allowing untrusted users to change the sender address does not of itself make
3759 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3760 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3761 though this can be overridden by setting &%no_local_from_check%&.
3762
3763 White
3764 .cindex "&""From""& line"
3765 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3766 given as two arguments or one combined argument). The sender of a
3767 locally-generated message can also be set (when permitted) by an initial
3768 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3769 if &%-f%& is also present, it overrides &"From&~"&.
3770
3771 .vitem &%-G%&
3772 .oindex "&%-G%&"
3773 .cindex "submission fixups, suppressing (command-line)"
3774 This option is equivalent to an ACL applying:
3775 .code
3776 control = suppress_local_fixups
3777 .endd
3778 for every message received.  Note that Sendmail will complain about such
3779 bad formatting, where Exim silently just does not fix it up.  This may change
3780 in future.
3781
3782 As this affects audit information, the caller must be a trusted user to use
3783 this option.
3784
3785 .vitem &%-h%&&~<&'number'&>
3786 .oindex "&%-h%&"
3787 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3788 This option is accepted for compatibility with Sendmail, but has no effect. (In
3789 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3790 headers.)
3791
3792 .vitem &%-i%&
3793 .oindex "&%-i%&"
3794 .cindex "Solaris" "&'mail'& command"
3795 .cindex "dot" "in incoming non-SMTP message"
3796 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3797 line by itself should not terminate an incoming, non-SMTP message. I can find
3798 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3799 command in Solaris 2.4 uses it. See also &%-ti%&.
3800
3801 .vitem &%-L%&&~<&'tag'&>
3802 .oindex "&%-L%&"
3803 .cindex "syslog" "process name; set with flag"
3804 This option is equivalent to setting &%syslog_processname%& in the config
3805 file and setting &%log_file_path%& to &`syslog`&.
3806 Its use is restricted to administrators.  The configuration file has to be
3807 read and parsed, to determine access rights, before this is set and takes
3808 effect, so early configuration file errors will not honour this flag.
3809
3810 The tag should not be longer than 32 characters.
3811
3812 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3813 .oindex "&%-M%&"
3814 .cindex "forcing delivery"
3815 .cindex "delivery" "forcing attempt"
3816 .cindex "frozen messages" "forcing delivery"
3817 This option requests Exim to run a delivery attempt on each message in turn. If
3818 any of the messages are frozen, they are automatically thawed before the
3819 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3820 and &%hold_domains%& are ignored.
3821
3822 Retry
3823 .cindex "hints database" "overriding retry hints"
3824 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3825 the normal retry time has not yet been reached. This option requires the caller
3826 to be an admin user. However, there is an option called &%prod_requires_admin%&
3827 which can be set false to relax this restriction (and also the same requirement
3828 for the &%-q%&, &%-R%&, and &%-S%& options).
3829
3830 The deliveries happen synchronously, that is, the original Exim process does
3831 not terminate until all the delivery attempts have finished. No output is
3832 produced unless there is a serious error. If you want to see what is happening,
3833 use the &%-v%& option as well, or inspect Exim's main log.
3834
3835 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3836 .oindex "&%-Mar%&"
3837 .cindex "message" "adding recipients"
3838 .cindex "recipient" "adding"
3839 This option requests Exim to add the addresses to the list of recipients of the
3840 message (&"ar"& for &"add recipients"&). The first argument must be a message
3841 id, and the remaining ones must be email addresses. However, if the message is
3842 active (in the middle of a delivery attempt), it is not altered. This option
3843 can be used only by an admin user.
3844
3845 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3846         &~<&'message&~id'&>"
3847 .oindex "&%-MC%&"
3848 .cindex "SMTP" "passed connection"
3849 .cindex "SMTP" "multiple deliveries"
3850 .cindex "multiple SMTP deliveries"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim to invoke another instance of itself to deliver a waiting message using
3853 an existing SMTP connection, which is passed as the standard input. Details are
3854 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3855 must be root or the Exim user in order to use it.
3856
3857 .vitem &%-MCA%&
3858 .oindex "&%-MCA%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that the
3861 connection to the remote host has been authenticated.
3862
3863 .vitem &%-MCD%&
3864 .oindex "&%-MCD%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that the
3867 remote host supports the ESMTP &_DSN_& extension.
3868
3869 .vitem &%-MCG%&&~<&'queue&~name'&>
3870 .oindex "&%-MCG%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that an
3873 alternate queue is used, named by the following argument.
3874
3875 .vitem &%-MCK%&
3876 .oindex "&%-MCK%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option. It signifies that a
3879 remote host supports the ESMTP &_CHUNKING_& extension.
3880
3881 .vitem &%-MCP%&
3882 .oindex "&%-MCP%&"
3883 This option is not intended for use by external callers. It is used internally
3884 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3885 which Exim is connected supports pipelining.
3886
3887 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3888 .oindex "&%-MCQ%&"
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-MC%& option when the original delivery was
3891 started by a queue runner. It passes on the process id of the queue runner,
3892 together with the file descriptor number of an open pipe. Closure of the pipe
3893 signals the final completion of the sequence of processes that are passing
3894 messages through the same SMTP connection.
3895
3896 .vitem &%-MCS%&
3897 .oindex "&%-MCS%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3900 SMTP SIZE option should be used on messages delivered down the existing
3901 connection.
3902
3903 .vitem &%-MCT%&
3904 .oindex "&%-MCT%&"
3905 This option is not intended for use by external callers. It is used internally
3906 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3907 host to which Exim is connected supports TLS encryption.
3908
3909 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3910 .oindex "&%-MCt%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 connection is being proxied by a parent process for handling TLS encryption.
3914 The arguments give the local address and port being proxied, and the TLS cipher.
3915
3916 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mc%&"
3918 .cindex "hints database" "not overridden by &%-Mc%&"
3919 .cindex "delivery" "manually started &-- not forced"
3920 This option requests Exim to run a delivery attempt on each message, in turn,
3921 but unlike the &%-M%& option, it does check for retry hints, and respects any
3922 that are found. This option is not very useful to external callers. It is
3923 provided mainly for internal use by Exim when it needs to re-invoke itself in
3924 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3925 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3926 respects retry times and other options such as &%hold_domains%& that are
3927 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3928 If you want to run a specific delivery as if in a queue run, you should use
3929 &%-q%& with a message id argument. A distinction between queue run deliveries
3930 and other deliveries is made in one or two places.
3931
3932 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3933 .oindex "&%-Mes%&"
3934 .cindex "message" "changing sender"
3935 .cindex "sender" "changing"
3936 This option requests Exim to change the sender address in the message to the
3937 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3938 &"edit sender"&). There must be exactly two arguments. The first argument must
3939 be a message id, and the second one an email address. However, if the message
3940 is active (in the middle of a delivery attempt), its status is not altered.
3941 This option can be used only by an admin user.
3942
3943 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3944 .oindex "&%-Mf%&"
3945 .cindex "freezing messages"
3946 .cindex "message" "manually freezing"
3947 This option requests Exim to mark each listed message as &"frozen"&. This
3948 prevents any delivery attempts taking place until the message is &"thawed"&,
3949 either manually or as a result of the &%auto_thaw%& configuration option.
3950 However, if any of the messages are active (in the middle of a delivery
3951 attempt), their status is not altered. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mg%&"
3956 .cindex "giving up on messages"
3957 .cindex "message" "abandoning delivery attempts"
3958 .cindex "delivery" "abandoning further attempts"
3959 This option requests Exim to give up trying to deliver the listed messages,
3960 including any that are frozen. However, if any of the messages are active,
3961 their status is not altered. For non-bounce messages, a delivery error message
3962 is sent to the sender, containing the text &"cancelled by administrator"&.
3963 Bounce messages are just discarded. This option can be used only by an admin
3964 user.
3965
3966 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3967 .oindex "&%-MG%&"
3968 .cindex queue named
3969 .cindex "named queues" "moving messages"
3970 .cindex "queue" "moving messages"
3971 This option requests that each listed message be moved from its current
3972 queue to the given named queue.
3973 The destination queue name argument is required, but can be an empty
3974 string to define the default queue.
3975 If the messages are not currently located in the default queue,
3976 a &%-qG<name>%& option will be required to define the source queue.
3977
3978 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3979 .oindex "&%-Mmad%&"
3980 .cindex "delivery" "cancelling all"
3981 This option requests Exim to mark all the recipient addresses in the messages
3982 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3983 message is active (in the middle of a delivery attempt), its status is not
3984 altered. This option can be used only by an admin user.
3985
3986 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3987 .oindex "&%-Mmd%&"
3988 .cindex "delivery" "cancelling by address"
3989 .cindex "recipient" "removing"
3990 .cindex "removing recipients"
3991 This option requests Exim to mark the given addresses as already delivered
3992 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3993 the remaining ones must be email addresses. These are matched to recipient
3994 addresses in the message in a case-sensitive manner. If the message is active
3995 (in the middle of a delivery attempt), its status is not altered. This option
3996 can be used only by an admin user.
3997
3998 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3999 .oindex "&%-Mrm%&"
4000 .cindex "removing messages"
4001 .cindex "abandoning mail"
4002 .cindex "message" "manually discarding"
4003 This option requests Exim to remove the given messages from the queue. No
4004 bounce messages are sent; each message is simply forgotten. However, if any of
4005 the messages are active, their status is not altered. This option can be used
4006 only by an admin user or by the user who originally caused the message to be
4007 placed in the queue.
4008
4009 . .new
4010 . .vitem &%-MS%&
4011 . .oindex "&%-MS%&"
4012 . .cindex REQUIRETLS
4013 . This option is used to request REQUIRETLS processing on the message.
4014 . It is used internally by Exim in conjunction with -E when generating
4015 . a bounce message.
4016 . .wen
4017
4018 .vitem &%-Mset%&&~<&'message&~id'&>
4019 .oindex "&%-Mset%&"
4020 .cindex "testing" "string expansion"
4021 .cindex "expansion" "testing"
4022 This option is useful only in conjunction with &%-be%& (that is, when testing
4023 string expansions). Exim loads the given message from its spool before doing
4024 the test expansions, thus setting message-specific variables such as
4025 &$message_size$& and the header variables. The &$recipients$& variable is made
4026 available. This feature is provided to make it easier to test expansions that
4027 make use of these variables. However, this option can be used only by an admin
4028 user. See also &%-bem%&.
4029
4030 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4031 .oindex "&%-Mt%&"
4032 .cindex "thawing messages"
4033 .cindex "unfreezing messages"
4034 .cindex "frozen messages" "thawing"
4035 .cindex "message" "thawing frozen"
4036 This option requests Exim to &"thaw"& any of the listed messages that are
4037 &"frozen"&, so that delivery attempts can resume. However, if any of the
4038 messages are active, their status is not altered. This option can be used only
4039 by an admin user.
4040
4041 .vitem &%-Mvb%&&~<&'message&~id'&>
4042 .oindex "&%-Mvb%&"
4043 .cindex "listing" "message body"
4044 .cindex "message" "listing body of"
4045 This option causes the contents of the message body (-D) spool file to be
4046 written to the standard output. This option can be used only by an admin user.
4047
4048 .vitem &%-Mvc%&&~<&'message&~id'&>
4049 .oindex "&%-Mvc%&"
4050 .cindex "message" "listing in RFC 2822 format"
4051 .cindex "listing" "message in RFC 2822 format"
4052 This option causes a copy of the complete message (header lines plus body) to
4053 be written to the standard output in RFC 2822 format. This option can be used
4054 only by an admin user.
4055
4056 .vitem &%-Mvh%&&~<&'message&~id'&>
4057 .oindex "&%-Mvh%&"
4058 .cindex "listing" "message headers"
4059 .cindex "header lines" "listing"
4060 .cindex "message" "listing header lines"
4061 This option causes the contents of the message headers (-H) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvl%&&~<&'message&~id'&>
4065 .oindex "&%-Mvl%&"
4066 .cindex "listing" "message log"
4067 .cindex "message" "listing message log"
4068 This option causes the contents of the message log spool file to be written to
4069 the standard output. This option can be used only by an admin user.
4070
4071 .vitem &%-m%&
4072 .oindex "&%-m%&"
4073 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4074 treats it that way too.
4075
4076 .vitem &%-N%&
4077 .oindex "&%-N%&"
4078 .cindex "debugging" "&%-N%& option"
4079 .cindex "debugging" "suppressing delivery"
4080 This is a debugging option that inhibits delivery of a message at the transport
4081 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4082 it just doesn't actually transport the message, but instead behaves as if it
4083 had successfully done so. However, it does not make any updates to the retry
4084 database, and the log entries for deliveries are flagged with &"*>"& rather
4085 than &"=>"&.
4086
4087 Because &%-N%& discards any message to which it applies, only root or the Exim
4088 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4089 words, an ordinary user can use it only when supplying an incoming message to
4090 which it will apply. Although transportation never fails when &%-N%& is set, an
4091 address may be deferred because of a configuration problem on a transport, or a
4092 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4093 the message, and applies to any subsequent delivery attempts that may happen
4094 for that message.
4095
4096 .vitem &%-n%&
4097 .oindex "&%-n%&"
4098 This option is interpreted by Sendmail to mean &"no aliasing"&.
4099 For normal modes of operation, it is ignored by Exim.
4100 When combined with &%-bP%& it makes the output more terse (suppresses
4101 option names, environment values and config pretty printing).
4102
4103 .vitem &%-O%&&~<&'data'&>
4104 .oindex "&%-O%&"
4105 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4106 Exim.
4107
4108 .vitem &%-oA%&&~<&'file&~name'&>
4109 .oindex "&%-oA%&"
4110 .cindex "Sendmail compatibility" "&%-oA%& option"
4111 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4112 alternative alias filename. Exim handles &%-bi%& differently; see the
4113 description above.
4114
4115 .vitem &%-oB%&&~<&'n'&>
4116 .oindex "&%-oB%&"
4117 .cindex "SMTP" "passed connection"
4118 .cindex "SMTP" "multiple deliveries"
4119 .cindex "multiple SMTP deliveries"
4120 This is a debugging option which limits the maximum number of messages that can
4121 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4122 transport. If <&'n'&> is omitted, the limit is set to 1.
4123
4124 .vitem &%-odb%&
4125 .oindex "&%-odb%&"
4126 .cindex "background delivery"
4127 .cindex "delivery" "in the background"
4128 This option applies to all modes in which Exim accepts incoming messages,
4129 including the listening daemon. It requests &"background"& delivery of such
4130 messages, which means that the accepting process automatically starts a
4131 delivery process for each message received, but does not wait for the delivery
4132 processes to finish.
4133
4134 When all the messages have been received, the reception process exits,
4135 leaving the delivery processes to finish in their own time. The standard output
4136 and error streams are closed at the start of each delivery process.
4137 This is the default action if none of the &%-od%& options are present.
4138
4139 If one of the queueing options in the configuration file
4140 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4141 overrides it if &%queue_only_override%& is set true, which is the default
4142 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4143
4144 .vitem &%-odf%&
4145 .oindex "&%-odf%&"
4146 .cindex "foreground delivery"
4147 .cindex "delivery" "in the foreground"
4148 This option requests &"foreground"& (synchronous) delivery when Exim has
4149 accepted a locally-generated message. (For the daemon it is exactly the same as
4150 &%-odb%&.) A delivery process is automatically started to deliver the message,
4151 and Exim waits for it to complete before proceeding.
4152
4153 The original Exim reception process does not finish until the delivery
4154 process for the final message has ended. The standard error stream is left open
4155 during deliveries.
4156
4157 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4158 false and one of the queueing options in the configuration file is in effect.
4159
4160 If there is a temporary delivery error during foreground delivery, the
4161 message is left in the queue for later delivery, and the original reception
4162 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4163 restricted configuration that never queues messages.
4164
4165
4166 .vitem &%-odi%&
4167 .oindex "&%-odi%&"
4168 This option is synonymous with &%-odf%&. It is provided for compatibility with
4169 Sendmail.
4170
4171 .vitem &%-odq%&
4172 .oindex "&%-odq%&"
4173 .cindex "non-immediate delivery"
4174 .cindex "delivery" "suppressing immediate"
4175 .cindex "queueing incoming messages"
4176 This option applies to all modes in which Exim accepts incoming messages,
4177 including the listening daemon. It specifies that the accepting process should
4178 not automatically start a delivery process for each message received. Messages
4179 are placed in the queue, and remain there until a subsequent queue runner
4180 process encounters them. There are several configuration options (such as
4181 &%queue_only%&) that can be used to queue incoming messages under certain
4182 conditions. This option overrides all of them and also &%-odqs%&. It always
4183 forces queueing.
4184
4185 .vitem &%-odqs%&
4186 .oindex "&%-odqs%&"
4187 .cindex "SMTP" "delaying delivery"
4188 .cindex "first pass routing"
4189 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4190 However, like &%-odb%& and &%-odi%&, this option has no effect if
4191 &%queue_only_override%& is false and one of the queueing options in the
4192 configuration file is in effect.
4193
4194 When &%-odqs%& does operate, a delivery process is started for each incoming
4195 message, in the background by default, but in the foreground if &%-odi%& is
4196 also present. The recipient addresses are routed, and local deliveries are done
4197 in the normal way. However, if any SMTP deliveries are required, they are not
4198 done at this time, so the message remains in the queue until a subsequent queue
4199 runner process encounters it. Because routing was done, Exim knows which
4200 messages are waiting for which hosts, and so a number of messages for the same
4201 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4202 configuration option has the same effect for specific domains. See also the
4203 &%-qq%& option.
4204
4205 .vitem &%-oee%&
4206 .oindex "&%-oee%&"
4207 .cindex "error" "reporting"
4208 If an error is detected while a non-SMTP message is being received (for
4209 example, a malformed address), the error is reported to the sender in a mail
4210 message.
4211
4212 .cindex "return code" "for &%-oee%&"
4213 Provided
4214 this error message is successfully sent, the Exim receiving process
4215 exits with a return code of zero. If not, the return code is 2 if the problem
4216 is that the original message has no recipients, or 1 for any other error.
4217 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4218
4219 .vitem &%-oem%&
4220 .oindex "&%-oem%&"
4221 .cindex "error" "reporting"
4222 .cindex "return code" "for &%-oem%&"
4223 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4224 return code, whether or not the error message was successfully sent.
4225 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4226
4227 .vitem &%-oep%&
4228 .oindex "&%-oep%&"
4229 .cindex "error" "reporting"
4230 If an error is detected while a non-SMTP message is being received, the
4231 error is reported by writing a message to the standard error file (stderr).
4232 .cindex "return code" "for &%-oep%&"
4233 The return code is 1 for all errors.
4234
4235 .vitem &%-oeq%&
4236 .oindex "&%-oeq%&"
4237 .cindex "error" "reporting"
4238 This option is supported for compatibility with Sendmail, but has the same
4239 effect as &%-oep%&.
4240
4241 .vitem &%-oew%&
4242 .oindex "&%-oew%&"
4243 .cindex "error" "reporting"
4244 This option is supported for compatibility with Sendmail, but has the same
4245 effect as &%-oem%&.
4246
4247 .vitem &%-oi%&
4248 .oindex "&%-oi%&"
4249 .cindex "dot" "in incoming non-SMTP message"
4250 This option, which has the same effect as &%-i%&, specifies that a dot on a
4251 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4252 single dot does terminate, though Exim does no special processing for other
4253 lines that start with a dot. This option is set by default if Exim is called as
4254 &'rmail'&. See also &%-ti%&.
4255
4256 .vitem &%-oitrue%&
4257 .oindex "&%-oitrue%&"
4258 This option is treated as synonymous with &%-oi%&.
4259
4260 .vitem &%-oMa%&&~<&'host&~address'&>
4261 .oindex "&%-oMa%&"
4262 .cindex "sender" "host address, specifying for local message"
4263 A number of options starting with &%-oM%& can be used to set values associated
4264 with remote hosts on locally-submitted messages (that is, messages not received
4265 over TCP/IP). These options can be used by any caller in conjunction with the
4266 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4267 other circumstances, they are ignored unless the caller is trusted.
4268
4269 The &%-oMa%& option sets the sender host address. This may include a port
4270 number at the end, after a full stop (period). For example:
4271 .code
4272 exim -bs -oMa 10.9.8.7.1234
4273 .endd
4274 An alternative syntax is to enclose the IP address in square brackets,
4275 followed by a colon and the port number:
4276 .code
4277 exim -bs -oMa [10.9.8.7]:1234
4278 .endd
4279 The IP address is placed in the &$sender_host_address$& variable, and the
4280 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4281 are present on the command line, the sender host IP address is taken from
4282 whichever one is last.
4283
4284 .vitem &%-oMaa%&&~<&'name'&>
4285 .oindex "&%-oMaa%&"
4286 .cindex "authentication" "name, specifying for local message"
4287 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4288 option sets the value of &$sender_host_authenticated$& (the authenticator
4289 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4290 This option can be used with &%-bh%& and &%-bs%& to set up an
4291 authenticated SMTP session without actually using the SMTP AUTH command.
4292
4293 .vitem &%-oMai%&&~<&'string'&>
4294 .oindex "&%-oMai%&"
4295 .cindex "authentication" "id, specifying for local message"
4296 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4297 option sets the value of &$authenticated_id$& (the id that was authenticated).
4298 This overrides the default value (the caller's login id, except with &%-bh%&,
4299 where there is no default) for messages from local sources. See chapter
4300 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4301
4302 .vitem &%-oMas%&&~<&'address'&>
4303 .oindex "&%-oMas%&"
4304 .cindex "authentication" "sender, specifying for local message"
4305 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4306 option sets the authenticated sender value in &$authenticated_sender$&. It
4307 overrides the sender address that is created from the caller's login id for
4308 messages from local sources, except when &%-bh%& is used, when there is no
4309 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4310 specified on a MAIL command overrides this value. See chapter
4311 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4312
4313 .vitem &%-oMi%&&~<&'interface&~address'&>
4314 .oindex "&%-oMi%&"
4315 .cindex "interface" "address, specifying for local message"
4316 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4317 option sets the IP interface address value. A port number may be included,
4318 using the same syntax as for &%-oMa%&. The interface address is placed in
4319 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4320
4321 .vitem &%-oMm%&&~<&'message&~reference'&>
4322 .oindex "&%-oMm%&"
4323 .cindex "message reference" "message reference, specifying for local message"
4324 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4325 option sets the message reference, e.g. message-id, and is logged during
4326 delivery. This is useful when some kind of audit trail is required to tie
4327 messages together. The format of the message reference is checked and will
4328 abort if the format is invalid. The option will only be accepted if exim is
4329 running in trusted mode, not as any regular user.
4330
4331 The best example of a message reference is when Exim sends a bounce message.
4332 The message reference is the message-id of the original message for which Exim
4333 is sending the bounce.
4334
4335 .vitem &%-oMr%&&~<&'protocol&~name'&>
4336 .oindex "&%-oMr%&"
4337 .cindex "protocol, specifying for local message"
4338 .vindex "&$received_protocol$&"
4339 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4340 option sets the received protocol value that is stored in
4341 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4342 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4343 SMTP protocol names (see the description of &$received_protocol$& in section
4344 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4345 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4346 be set by &%-oMr%&. Repeated use of this option is not supported.
4347
4348 .vitem &%-oMs%&&~<&'host&~name'&>
4349 .oindex "&%-oMs%&"
4350 .cindex "sender" "host name, specifying for local message"
4351 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4352 option sets the sender host name in &$sender_host_name$&. When this option is
4353 present, Exim does not attempt to look up a host name from an IP address; it
4354 uses the name it is given.
4355
4356 .vitem &%-oMt%&&~<&'ident&~string'&>
4357 .oindex "&%-oMt%&"
4358 .cindex "sender" "ident string, specifying for local message"
4359 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4360 option sets the sender ident value in &$sender_ident$&. The default setting for
4361 local callers is the login id of the calling process, except when &%-bh%& is
4362 used, when there is no default.
4363
4364 .vitem &%-om%&
4365 .oindex "&%-om%&"
4366 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4367 In Sendmail, this option means &"me too"&, indicating that the sender of a
4368 message should receive a copy of the message if the sender appears in an alias
4369 expansion. Exim always does this, so the option does nothing.
4370
4371 .vitem &%-oo%&
4372 .oindex "&%-oo%&"
4373 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4374 This option is ignored. In Sendmail it specifies &"old style headers"&,
4375 whatever that means.
4376
4377 .vitem &%-oP%&&~<&'path'&>
4378 .oindex "&%-oP%&"
4379 .cindex "pid (process id)" "of daemon"
4380 .cindex "daemon" "process id (pid)"
4381 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4382 value. The option specifies the file to which the process id of the daemon is
4383 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4384 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4385 because in those cases, the normal pid file is not used.
4386
4387 .new
4388 .vitem &%-oPX%&
4389 .oindex "&%-oPX%&"
4390 .cindex "pid (process id)" "of daemon"
4391 .cindex "daemon" "process id (pid)"
4392 This option is not intended for general use.
4393 The daemon uses it when terminating due to a SIGTEM, possibly in
4394 combination with &%-oP%&&~<&'path'&>.
4395 It causes the pid file to be removed.
4396 .wen
4397
4398 .vitem &%-or%&&~<&'time'&>
4399 .oindex "&%-or%&"
4400 .cindex "timeout" "for non-SMTP input"
4401 This option sets a timeout value for incoming non-SMTP messages. If it is not
4402 set, Exim will wait forever for the standard input. The value can also be set
4403 by the &%receive_timeout%& option. The format used for specifying times is
4404 described in section &<<SECTtimeformat>>&.
4405
4406 .vitem &%-os%&&~<&'time'&>
4407 .oindex "&%-os%&"
4408 .cindex "timeout" "for SMTP input"
4409 .cindex "SMTP" "input timeout"
4410 This option sets a timeout value for incoming SMTP messages. The timeout
4411 applies to each SMTP command and block of data. The value can also be set by
4412 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4413 for specifying times is described in section &<<SECTtimeformat>>&.
4414
4415 .vitem &%-ov%&
4416 .oindex "&%-ov%&"
4417 This option has exactly the same effect as &%-v%&.
4418
4419 .vitem &%-oX%&&~<&'number&~or&~string'&>
4420 .oindex "&%-oX%&"
4421 .cindex "TCP/IP" "setting listening ports"
4422 .cindex "TCP/IP" "setting listening interfaces"
4423 .cindex "port" "receiving TCP/IP"
4424 This option is relevant only when the &%-bd%& (start listening daemon) option
4425 is also given. It controls which ports and interfaces the daemon uses. Details
4426 of the syntax, and how it interacts with configuration file options, are given
4427 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4428 file is written unless &%-oP%& is also present to specify a pid filename.
4429
4430 .vitem &%-pd%&
4431 .oindex "&%-pd%&"
4432 .cindex "Perl" "starting the interpreter"
4433 This option applies when an embedded Perl interpreter is linked with Exim (see
4434 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4435 option, forcing the starting of the interpreter to be delayed until it is
4436 needed.
4437
4438 .vitem &%-ps%&
4439 .oindex "&%-ps%&"
4440 .cindex "Perl" "starting the interpreter"
4441 This option applies when an embedded Perl interpreter is linked with Exim (see
4442 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4443 option, forcing the starting of the interpreter to occur as soon as Exim is
4444 started.
4445
4446 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4447 .oindex "&%-p%&"
4448 For compatibility with Sendmail, this option is equivalent to
4449 .display
4450 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4451 .endd
4452 It sets the incoming protocol and host name (for trusted callers). The
4453 host name and its colon can be omitted when only the protocol is to be set.
4454 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4455 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4456 or &`s`& using this option (but that does not seem a real limitation).
4457 Repeated use of this option is not supported.
4458
4459 .vitem &%-q%&
4460 .oindex "&%-q%&"
4461 .cindex "queue runner" "starting manually"
4462 This option is normally restricted to admin users. However, there is a
4463 configuration option called &%prod_requires_admin%& which can be set false to
4464 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4465 and &%-S%& options).
4466
4467 .cindex "queue runner" "description of operation"
4468 If other commandline options do not specify an action,
4469 the &%-q%& option starts one queue runner process. This scans the queue of
4470 waiting messages, and runs a delivery process for each one in turn. It waits
4471 for each delivery process to finish before starting the next one. A delivery
4472 process may not actually do any deliveries if the retry times for the addresses
4473 have not been reached. Use &%-qf%& (see below) if you want to override this.
4474
4475 If
4476 .cindex "SMTP" "passed connection"
4477 .cindex "SMTP" "multiple deliveries"
4478 .cindex "multiple SMTP deliveries"
4479 the delivery process spawns other processes to deliver other messages down
4480 passed SMTP connections, the queue runner waits for these to finish before
4481 proceeding.
4482
4483 When all the queued messages have been considered, the original queue runner
4484 process terminates. In other words, a single pass is made over the waiting
4485 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4486 this to be repeated periodically.
4487
4488 Exim processes the waiting messages in an unpredictable order. It isn't very
4489 random, but it is likely to be different each time, which is all that matters.
4490 If one particular message screws up a remote MTA, other messages to the same
4491 MTA have a chance of getting through if they get tried first.
4492
4493 It is possible to cause the messages to be processed in lexical message id
4494 order, which is essentially the order in which they arrived, by setting the
4495 &%queue_run_in_order%& option, but this is not recommended for normal use.
4496
4497 .vitem &%-q%&<&'qflags'&>
4498 The &%-q%& option may be followed by one or more flag letters that change its
4499 behaviour. They are all optional, but if more than one is present, they must
4500 appear in the correct order. Each flag is described in a separate item below.
4501
4502 .vitem &%-qq...%&
4503 .oindex "&%-qq%&"
4504 .cindex "queue" "double scanning"
4505 .cindex "queue" "routing"
4506 .cindex "routing" "whole queue before delivery"
4507 .cindex "first pass routing"
4508 An option starting with &%-qq%& requests a two-stage queue run. In the first
4509 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4510 every domain. Addresses are routed, local deliveries happen, but no remote
4511 transports are run.
4512
4513 .new
4514 Performance will be best if the &%queue_run_in_order%& option is false.
4515 .wen
4516
4517 .cindex "hints database" "remembering routing"
4518 The hints database that remembers which messages are waiting for specific hosts
4519 is updated, as if delivery to those hosts had been deferred. After this is
4520 complete, a second, normal queue scan happens, with routing and delivery taking
4521 place as normal. Messages that are routed to the same host should mostly be
4522 delivered down a single SMTP
4523 .cindex "SMTP" "passed connection"
4524 .cindex "SMTP" "multiple deliveries"
4525 .cindex "multiple SMTP deliveries"
4526 connection because of the hints that were set up during the first queue scan.
4527 This option may be useful for hosts that are connected to the Internet
4528 intermittently.
4529
4530 .vitem &%-q[q]i...%&
4531 .oindex "&%-qi%&"
4532 .cindex "queue" "initial delivery"
4533 If the &'i'& flag is present, the queue runner runs delivery processes only for
4534 those messages that haven't previously been tried. (&'i'& stands for &"initial
4535 delivery"&.) This can be helpful if you are putting messages in the queue using
4536 &%-odq%& and want a queue runner just to process the new messages.
4537
4538 .vitem &%-q[q][i]f...%&
4539 .oindex "&%-qf%&"
4540 .cindex "queue" "forcing delivery"
4541 .cindex "delivery" "forcing in queue run"
4542 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4543 message, whereas without &'f'& only those non-frozen addresses that have passed
4544 their retry times are tried.
4545
4546 .vitem &%-q[q][i]ff...%&
4547 .oindex "&%-qff%&"
4548 .cindex "frozen messages" "forcing delivery"
4549 If &'ff'& is present, a delivery attempt is forced for every message, whether
4550 frozen or not.
4551
4552 .vitem &%-q[q][i][f[f]]l%&
4553 .oindex "&%-ql%&"
4554 .cindex "queue" "local deliveries only"
4555 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4556 be done. If a message requires any remote deliveries, it remains in the queue
4557 for later delivery.
4558
4559 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4560 .oindex "&%-qG%&"
4561 .cindex queue named
4562 .cindex "named queues"  "deliver from"
4563 .cindex "queue" "delivering specific messages"
4564 If the &'G'& flag and a name is present, the queue runner operates on the
4565 queue with the given name rather than the default queue.
4566 The name should not contain a &'/'& character.
4567 For a periodic queue run (see below)
4568 append to the name a slash and a time value.
4569
4570 If other commandline options specify an action, a &'-qG<name>'& option
4571 will specify a queue to operate on.
4572 For example:
4573 .code
4574 exim -bp -qGquarantine
4575 mailq -qGquarantine
4576 exim -qGoffpeak -Rf @special.domain.example
4577 .endd
4578
4579 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4580 When scanning the queue, Exim can be made to skip over messages whose ids are
4581 lexically less than a given value by following the &%-q%& option with a
4582 starting message id. For example:
4583 .code
4584 exim -q 0t5C6f-0000c8-00
4585 .endd
4586 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4587 second message id is given, messages whose ids are lexically greater than it
4588 are also skipped. If the same id is given twice, for example,
4589 .code
4590 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4591 .endd
4592 just one delivery process is started, for that message. This differs from
4593 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4594 that it counts as a delivery from a queue run. Note that the selection
4595 mechanism does not affect the order in which the messages are scanned. There
4596 are also other ways of selecting specific sets of messages for delivery in a
4597 queue run &-- see &%-R%& and &%-S%&.
4598
4599 .vitem &%-q%&<&'qflags'&><&'time'&>
4600 .cindex "queue runner" "starting periodically"
4601 .cindex "periodic queue running"
4602 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4603 starting a queue runner process at intervals specified by the given time value
4604 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4605 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4606 single daemon process handles both functions. A common way of starting up a
4607 combined daemon at system boot time is to use a command such as
4608 .code
4609 /usr/exim/bin/exim -bd -q30m
4610 .endd
4611 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4612 process every 30 minutes.
4613
4614 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4615 pid file is written unless one is explicitly requested by the &%-oP%& option.
4616
4617 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4618 .oindex "&%-qR%&"
4619 This option is synonymous with &%-R%&. It is provided for Sendmail
4620 compatibility.
4621
4622 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4623 .oindex "&%-qS%&"
4624 This option is synonymous with &%-S%&.
4625
4626 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4627 .oindex "&%-R%&"
4628 .cindex "queue runner" "for specific recipients"
4629 .cindex "delivery" "to given domain"
4630 .cindex "domain" "delivery to"
4631 The <&'rsflags'&> may be empty, in which case the white space before the string
4632 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4633 which are the possible values for <&'rsflags'&>. White space is required if
4634 <&'rsflags'&> is not empty.
4635
4636 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4637 perform a single queue run, except that, when scanning the messages on the
4638 queue, Exim processes only those that have at least one undelivered recipient
4639 address containing the given string, which is checked in a case-independent
4640 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4641 regular expression; otherwise it is a literal string.
4642
4643 If you want to do periodic queue runs for messages with specific recipients,
4644 you can combine &%-R%& with &%-q%& and a time value. For example:
4645 .code
4646 exim -q25m -R @special.domain.example
4647 .endd
4648 This example does a queue run for messages with recipients in the given domain
4649 every 25 minutes. Any additional flags that are specified with &%-q%& are
4650 applied to each queue run.
4651
4652 Once a message is selected for delivery by this mechanism, all its addresses
4653 are processed. For the first selected message, Exim overrides any retry
4654 information and forces a delivery attempt for each undelivered address. This
4655 means that if delivery of any address in the first message is successful, any
4656 existing retry information is deleted, and so delivery attempts for that
4657 address in subsequently selected messages (which are processed without forcing)
4658 will run. However, if delivery of any address does not succeed, the retry
4659 information is updated, and in subsequently selected messages, the failing
4660 address will be skipped.
4661
4662 .cindex "frozen messages" "forcing delivery"
4663 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4664 all selected messages, not just the first; frozen messages are included when
4665 &'ff'& is present.
4666
4667 The &%-R%& option makes it straightforward to initiate delivery of all messages
4668 to a given domain after a host has been down for some time. When the SMTP
4669 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4670 effect is to run Exim with the &%-R%& option, but it can be configured to run
4671 an arbitrary command instead.
4672
4673 .vitem &%-r%&
4674 .oindex "&%-r%&"
4675 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4676
4677 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4678 .oindex "&%-S%&"
4679 .cindex "delivery" "from given sender"
4680 .cindex "queue runner" "for specific senders"
4681 This option acts like &%-R%& except that it checks the string against each
4682 message's sender instead of against the recipients. If &%-R%& is also set, both
4683 conditions must be met for a message to be selected. If either of the options
4684 has &'f'& or &'ff'& in its flags, the associated action is taken.
4685
4686 .vitem &%-Tqt%&&~<&'times'&>
4687 .oindex "&%-Tqt%&"
4688 This is an option that is exclusively for use by the Exim testing suite. It is not
4689 recognized when Exim is run normally. It allows for the setting up of explicit
4690 &"queue times"& so that various warning/retry features can be tested.
4691
4692 .vitem &%-t%&
4693 .oindex "&%-t%&"
4694 .cindex "recipient" "extracting from header lines"
4695 .cindex "&'Bcc:'& header line"
4696 .cindex "&'Cc:'& header line"
4697 .cindex "&'To:'& header line"
4698 When Exim is receiving a locally-generated, non-SMTP message on its standard
4699 input, the &%-t%& option causes the recipients of the message to be obtained
4700 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4701 from the command arguments. The addresses are extracted before any rewriting
4702 takes place and the &'Bcc:'& header line, if present, is then removed.
4703
4704 .cindex "Sendmail compatibility" "&%-t%& option"
4705 If the command has any arguments, they specify addresses to which the message
4706 is &'not'& to be delivered. That is, the argument addresses are removed from
4707 the recipients list obtained from the headers. This is compatible with Smail 3
4708 and in accordance with the documented behaviour of several versions of
4709 Sendmail, as described in man pages on a number of operating systems (e.g.
4710 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4711 argument addresses to those obtained from the headers, and the O'Reilly
4712 Sendmail book documents it that way. Exim can be made to add argument addresses
4713 instead of subtracting them by setting the option
4714 &%extract_addresses_remove_arguments%& false.
4715
4716 .cindex "&%Resent-%& header lines" "with &%-t%&"
4717 If there are any &%Resent-%& header lines in the message, Exim extracts
4718 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4719 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4720 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4721 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4722
4723 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4724 message is resent several times). The RFC also specifies that they should be
4725 added at the front of the message, and separated by &'Received:'& lines. It is
4726 not at all clear how &%-t%& should operate in the present of multiple sets,
4727 nor indeed exactly what constitutes a &"set"&.
4728 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4729 are often added at the end of the header, and if a message is resent more than
4730 once, it is common for the original set of &%Resent-%& headers to be renamed as
4731 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4732
4733 .vitem &%-ti%&
4734 .oindex "&%-ti%&"
4735 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4736 compatibility with Sendmail.
4737
4738 .vitem &%-tls-on-connect%&
4739 .oindex "&%-tls-on-connect%&"
4740 .cindex "TLS" "use without STARTTLS"
4741 .cindex "TLS" "automatic start"
4742 This option is available when Exim is compiled with TLS support. It forces all
4743 incoming SMTP connections to behave as if the incoming port is listed in the
4744 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4745 &<<CHAPTLS>>& for further details.
4746
4747
4748 .vitem &%-U%&
4749 .oindex "&%-U%&"
4750 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4751 Sendmail uses this option for &"initial message submission"&, and its
4752 documentation states that in future releases, it may complain about
4753 syntactically invalid messages rather than fixing them when this flag is not
4754 set. Exim ignores this option.
4755
4756 .vitem &%-v%&
4757 .oindex "&%-v%&"
4758 This option causes Exim to write information to the standard error stream,
4759 describing what it is doing. In particular, it shows the log lines for
4760 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4761 dialogue is shown. Some of the log lines shown may not actually be written to
4762 the log if the setting of &%log_selector%& discards them. Any relevant
4763 selectors are shown with each log line. If none are shown, the logging is
4764 unconditional.
4765
4766 .vitem &%-x%&
4767 .oindex "&%-x%&"
4768 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4769 National Language Support extended characters in the body of the mail item"&).
4770 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4771 this option.
4772
4773 .vitem &%-X%&&~<&'logfile'&>
4774 .oindex "&%-X%&"
4775 This option is interpreted by Sendmail to cause debug information to be sent
4776 to the named file.  It is ignored by Exim.
4777
4778 .vitem &%-z%&&~<&'log-line'&>
4779 .oindex "&%-z%&"
4780 This option writes its argument to Exim's logfile.
4781 Use is restricted to administrators; the intent is for operational notes.
4782 Quotes should be used to maintain a multi-word item as a single argument,
4783 under most shells.
4784 .endlist
4785
4786 .ecindex IIDclo1
4787 .ecindex IIDclo2
4788
4789
4790 . ////////////////////////////////////////////////////////////////////////////
4791 . Insert a stylized DocBook comment here, to identify the end of the command
4792 . line options. This is for the benefit of the Perl script that automatically
4793 . creates a man page for the options.
4794 . ////////////////////////////////////////////////////////////////////////////
4795
4796 .literal xml
4797 <!-- === End of command line options === -->
4798 .literal off
4799
4800
4801
4802
4803
4804 . ////////////////////////////////////////////////////////////////////////////
4805 . ////////////////////////////////////////////////////////////////////////////
4806
4807
4808 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4809          "The runtime configuration file"
4810
4811 .cindex "runtime configuration"
4812 .cindex "configuration file" "general description"
4813 .cindex "CONFIGURE_FILE"
4814 .cindex "configuration file" "errors in"
4815 .cindex "error" "in configuration file"
4816 .cindex "return code" "for bad configuration"
4817 Exim uses a single runtime configuration file that is read whenever an Exim
4818 binary is executed. Note that in normal operation, this happens frequently,
4819 because Exim is designed to operate in a distributed manner, without central
4820 control.
4821
4822 If a syntax error is detected while reading the configuration file, Exim
4823 writes a message on the standard error, and exits with a non-zero return code.
4824 The message is also written to the panic log. &*Note*&: Only simple syntax
4825 errors can be detected at this time. The values of any expanded options are
4826 not checked until the expansion happens, even when the expansion does not
4827 actually alter the string.
4828
4829 The name of the configuration file is compiled into the binary for security
4830 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4831 most configurations, this specifies a single file. However, it is permitted to
4832 give a colon-separated list of filenames, in which case Exim uses the first
4833 existing file in the list.
4834
4835 .cindex "EXIM_USER"
4836 .cindex "EXIM_GROUP"
4837 .cindex "CONFIGURE_OWNER"
4838 .cindex "CONFIGURE_GROUP"
4839 .cindex "configuration file" "ownership"
4840 .cindex "ownership" "configuration file"
4841 The runtime configuration file must be owned by root or by the user that is
4842 specified at compile time by the CONFIGURE_OWNER option (if set). The
4843 configuration file must not be world-writeable, or group-writeable unless its
4844 group is the root group or the one specified at compile time by the
4845 CONFIGURE_GROUP option.
4846
4847 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4848 to root, anybody who is able to edit the runtime configuration file has an
4849 easy way to run commands as root. If you specify a user or group in the
4850 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4851 who are members of that group will trivially be able to obtain root privileges.
4852
4853 Up to Exim version 4.72, the runtime configuration file was also permitted to
4854 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4855 since it offered a simple privilege escalation for any attacker who managed to
4856 compromise the Exim user account.
4857
4858 A default configuration file, which will work correctly in simple situations,
4859 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4860 defines just one filename, the installation process copies the default
4861 configuration to a new file of that name if it did not previously exist. If
4862 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4863 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4864 configuration.
4865
4866
4867
4868 .section "Using a different configuration file" "SECID40"
4869 .cindex "configuration file" "alternate"
4870 A one-off alternate configuration can be specified by the &%-C%& command line
4871 option, which may specify a single file or a list of files. However, when
4872 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4873 unless the argument for &%-C%& is identical to the built-in value from
4874 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4875 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4876 is useful mainly for checking the syntax of configuration files before
4877 installing them. No owner or group checks are done on a configuration file
4878 specified by &%-C%&, if root privilege has been dropped.
4879
4880 Even the Exim user is not trusted to specify an arbitrary configuration file
4881 with the &%-C%& option to be used with root privileges, unless that file is
4882 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4883 testing a configuration using &%-C%& right through message reception and
4884 delivery, even if the caller is root. The reception works, but by that time,
4885 Exim is running as the Exim user, so when it re-execs to regain privilege for
4886 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4887 can test reception and delivery using two separate commands (one to put a
4888 message in the queue, using &%-odq%&, and another to do the delivery, using
4889 &%-M%&).
4890
4891 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4892 prefix string with which any file named in a &%-C%& command line option must
4893 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4894 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4895 filename can be used with &%-C%&.
4896
4897 One-off changes to a configuration can be specified by the &%-D%& command line
4898 option, which defines and overrides values for macros used inside the
4899 configuration file. However, like &%-C%&, the use of this option by a
4900 non-privileged user causes Exim to discard its root privilege.
4901 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4902 completely disabled, and its use causes an immediate error exit.
4903
4904 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4905 to declare certain macro names trusted, such that root privilege will not
4906 necessarily be discarded.
4907 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4908 considered safe and, if &%-D%& only supplies macros from this list, and the
4909 values are acceptable, then Exim will not give up root privilege if the caller
4910 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4911 transition mechanism and is expected to be removed in the future.  Acceptable
4912 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4913
4914 Some sites may wish to use the same Exim binary on different machines that
4915 share a file system, but to use different configuration files on each machine.
4916 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4917 looks for a file whose name is the configuration filename followed by a dot
4918 and the machine's node name, as obtained from the &[uname()]& function. If this
4919 file does not exist, the standard name is tried. This processing occurs for
4920 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4921
4922 In some esoteric situations different versions of Exim may be run under
4923 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4924 help with this. See the comments in &_src/EDITME_& for details.
4925
4926
4927
4928 .section "Configuration file format" "SECTconffilfor"
4929 .cindex "configuration file" "format of"
4930 .cindex "format" "configuration file"
4931 Exim's configuration file is divided into a number of different parts. General
4932 option settings must always appear at the start of the file. The other parts
4933 are all optional, and may appear in any order. Each part other than the first
4934 is introduced by the word &"begin"& followed by at least one literal
4935 space, and the name of the part. The optional parts are:
4936
4937 .ilist
4938 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4939 &<<CHAPACL>>&).
4940 .next
4941 .cindex "AUTH" "configuration"
4942 &'authenticators'&: Configuration settings for the authenticator drivers. These
4943 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4944 .next
4945 &'routers'&: Configuration settings for the router drivers. Routers process
4946 addresses and determine how the message is to be delivered (see chapters
4947 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4948 .next
4949 &'transports'&: Configuration settings for the transport drivers. Transports
4950 define mechanisms for copying messages to destinations (see chapters
4951 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4952 .next
4953 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4954 If there is no retry section, or if it is empty (that is, no retry rules are
4955 defined), Exim will not retry deliveries. In this situation, temporary errors
4956 are treated the same as permanent errors. Retry rules are discussed in chapter
4957 &<<CHAPretry>>&.
4958 .next
4959 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4960 when new addresses are generated during delivery. Rewriting is discussed in
4961 chapter &<<CHAPrewrite>>&.
4962 .next
4963 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4964 want to use this feature, you must set
4965 .code
4966 LOCAL_SCAN_HAS_OPTIONS=yes
4967 .endd
4968 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4969 facility are given in chapter &<<CHAPlocalscan>>&.
4970 .endlist
4971
4972 .cindex "configuration file" "leading white space in"
4973 .cindex "configuration file" "trailing white space in"
4974 .cindex "white space" "in configuration file"
4975 Leading and trailing white space in configuration lines is always ignored.
4976
4977 Blank lines in the file, and lines starting with a # character (ignoring
4978 leading white space) are treated as comments and are ignored. &*Note*&: A
4979 # character other than at the beginning of a line is not treated specially,
4980 and does not introduce a comment.
4981
4982 Any non-comment line can be continued by ending it with a backslash. Note that
4983 the general rule for white space means that trailing white space after the
4984 backslash and leading white space at the start of continuation
4985 lines is ignored. Comment lines beginning with # (but not empty lines) may
4986 appear in the middle of a sequence of continuation lines.
4987
4988 A convenient way to create a configuration file is to start from the
4989 default, which is supplied in &_src/configure.default_&, and add, delete, or
4990 change settings as required.
4991
4992 The ACLs, retry rules, and rewriting rules have their own syntax which is
4993 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4994 respectively. The other parts of the configuration file have some syntactic
4995 items in common, and these are described below, from section &<<SECTcos>>&
4996 onwards. Before that, the inclusion, macro, and conditional facilities are
4997 described.
4998
4999
5000
5001 .section "File inclusions in the configuration file" "SECID41"
5002 .cindex "inclusions in configuration file"
5003 .cindex "configuration file" "including other files"
5004 .cindex "&`.include`& in configuration file"
5005 .cindex "&`.include_if_exists`& in configuration file"
5006 You can include other files inside Exim's runtime configuration file by
5007 using this syntax:
5008 .display
5009 &`.include`& <&'filename'&>
5010 &`.include_if_exists`& <&'filename'&>
5011 .endd
5012 on a line by itself. Double quotes round the filename are optional. If you use
5013 the first form, a configuration error occurs if the file does not exist; the
5014 second form does nothing for non-existent files.
5015 The first form allows a relative name. It is resolved relative to
5016 the directory of the including file. For the second form an absolute filename
5017 is required.
5018
5019 Includes may be nested to any depth, but remember that Exim reads its
5020 configuration file often, so it is a good idea to keep them to a minimum.
5021 If you change the contents of an included file, you must HUP the daemon,
5022 because an included file is read only when the configuration itself is read.
5023
5024 The processing of inclusions happens early, at a physical line level, so, like
5025 comment lines, an inclusion can be used in the middle of an option setting,
5026 for example:
5027 .code
5028 hosts_lookup = a.b.c \
5029                .include /some/file
5030 .endd
5031 Include processing happens after macro processing (see below). Its effect is to
5032 process the lines of the included file as if they occurred inline where the
5033 inclusion appears.
5034
5035
5036
5037 .section "Macros in the configuration file" "SECTmacrodefs"
5038 .cindex "macro" "description of"
5039 .cindex "configuration file" "macros"
5040 If a line in the main part of the configuration (that is, before the first
5041 &"begin"& line) begins with an upper case letter, it is taken as a macro
5042 definition, and must be of the form
5043 .display
5044 <&'name'&> = <&'rest of line'&>
5045 .endd
5046 The name must consist of letters, digits, and underscores, and need not all be
5047 in upper case, though that is recommended. The rest of the line, including any
5048 continuations, is the replacement text, and has leading and trailing white
5049 space removed. Quotes are not removed. The replacement text can never end with
5050 a backslash character, but this doesn't seem to be a serious limitation.
5051
5052 Macros may also be defined between router, transport, authenticator, or ACL
5053 definitions. They may not, however, be defined within an individual driver or
5054 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5055
5056 .section "Macro substitution" "SECID42"
5057 Once a macro is defined, all subsequent lines in the file (and any included
5058 files) are scanned for the macro name; if there are several macros, the line is
5059 scanned for each, in turn, in the order in which the macros are defined. The
5060 replacement text is not re-scanned for the current macro, though it is scanned
5061 for subsequently defined macros. For this reason, a macro name may not contain
5062 the name of a previously defined macro as a substring. You could, for example,
5063 define
5064 .display
5065 &`ABCD_XYZ = `&<&'something'&>
5066 &`ABCD = `&<&'something else'&>
5067 .endd
5068 but putting the definitions in the opposite order would provoke a configuration
5069 error. Macro expansion is applied to individual physical lines from the file,
5070 before checking for line continuation or file inclusion (see above). If a line
5071 consists solely of a macro name, and the expansion of the macro is empty, the
5072 line is ignored. A macro at the start of a line may turn the line into a
5073 comment line or a &`.include`& line.
5074
5075
5076 .section "Redefining macros" "SECID43"
5077 Once defined, the value of a macro can be redefined later in the configuration
5078 (or in an included file). Redefinition is specified by using &'=='& instead of
5079 &'='&. For example:
5080 .code
5081 MAC =  initial value
5082 ...
5083 MAC == updated value
5084 .endd
5085 Redefinition does not alter the order in which the macros are applied to the
5086 subsequent lines of the configuration file. It is still the same order in which
5087 the macros were originally defined. All that changes is the macro's value.
5088 Redefinition makes it possible to accumulate values. For example:
5089 .code
5090 MAC =  initial value
5091 ...
5092 MAC == MAC and something added
5093 .endd
5094 This can be helpful in situations where the configuration file is built
5095 from a number of other files.
5096
5097 .section "Overriding macro values" "SECID44"
5098 The values set for macros in the configuration file can be overridden by the
5099 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5100 used, unless called by root or the Exim user. A definition on the command line
5101 using the &%-D%& option causes all definitions and redefinitions within the
5102 file to be ignored.
5103
5104
5105
5106 .section "Example of macro usage" "SECID45"
5107 As an example of macro usage, consider a configuration where aliases are looked
5108 up in a MySQL database. It helps to keep the file less cluttered if long
5109 strings such as SQL statements are defined separately as macros, for example:
5110 .code
5111 ALIAS_QUERY = select mailbox from user where \
5112               login='${quote_mysql:$local_part}';
5113 .endd
5114 This can then be used in a &(redirect)& router setting like this:
5115 .code
5116 data = ${lookup mysql{ALIAS_QUERY}}
5117 .endd
5118 In earlier versions of Exim macros were sometimes used for domain, host, or
5119 address lists. In Exim 4 these are handled better by named lists &-- see
5120 section &<<SECTnamedlists>>&.
5121
5122
5123 .section "Builtin macros" "SECTbuiltinmacros"
5124 Exim defines some macros depending on facilities available, which may
5125 differ due to build-time definitions and from one release to another.
5126 All of these macros start with an underscore.
5127 They can be used to conditionally include parts of a configuration
5128 (see below).
5129
5130 The following classes of macros are defined:
5131 .display
5132 &` _HAVE_*                    `&  build-time defines
5133 &` _DRIVER_ROUTER_*           `&  router drivers
5134 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5135 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5136 &` _LOG_*                     `&  log_selector values
5137 &` _OPT_MAIN_*                `&  main config options
5138 &` _OPT_ROUTERS_*             `&  generic router options
5139 &` _OPT_TRANSPORTS_*          `&  generic transport options
5140 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5141 &` _OPT_ROUTER_*_*            `&  private router options
5142 &` _OPT_TRANSPORT_*_*         `&  private transport options
5143 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5144 .endd
5145
5146 Use an &"exim -bP macros"& command to get the list of macros.
5147
5148
5149 .section "Conditional skips in the configuration file" "SECID46"
5150 .cindex "configuration file" "conditional skips"
5151 .cindex "&`.ifdef`&"
5152 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5153 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5154 portions of the configuration file. The processing happens whenever the file is
5155 read (that is, when an Exim binary starts to run).
5156
5157 The implementation is very simple. Instances of the first four directives must
5158 be followed by text that includes the names of one or macros. The condition
5159 that is tested is whether or not any macro substitution has taken place in the
5160 line. Thus:
5161 .code
5162 .ifdef AAA
5163 message_size_limit = 50M
5164 .else
5165 message_size_limit = 100M
5166 .endif
5167 .endd
5168 sets a message size limit of 50M if the macro &`AAA`& is defined
5169 (or &`A`& or &`AA`&), and 100M
5170 otherwise. If there is more than one macro named on the line, the condition
5171 is true if any of them are defined. That is, it is an &"or"& condition. To
5172 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5173
5174 Although you can use a macro expansion to generate one of these directives,
5175 it is not very useful, because the condition &"there was a macro substitution
5176 in this line"& will always be true.
5177
5178 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5179 to clarify complicated nestings.
5180
5181
5182
5183 .section "Common option syntax" "SECTcos"
5184 .cindex "common option syntax"
5185 .cindex "syntax of common options"
5186 .cindex "configuration file" "common option syntax"
5187 For the main set of options, driver options, and &[local_scan()]& options,
5188 each setting is on a line by itself, and starts with a name consisting of
5189 lower-case letters and underscores. Many options require a data value, and in
5190 these cases the name must be followed by an equals sign (with optional white
5191 space) and then the value. For example:
5192 .code
5193 qualify_domain = mydomain.example.com
5194 .endd
5195 .cindex "hiding configuration option values"
5196 .cindex "configuration options" "hiding value of"
5197 .cindex "options" "hiding value of"
5198 Some option settings may contain sensitive data, for example, passwords for
5199 accessing databases. To stop non-admin users from using the &%-bP%& command
5200 line option to read these values, you can precede the option settings with the
5201 word &"hide"&. For example:
5202 .code
5203 hide mysql_servers = localhost/users/admin/secret-password
5204 .endd
5205 For non-admin users, such options are displayed like this:
5206 .code
5207 mysql_servers = <value not displayable>
5208 .endd
5209 If &"hide"& is used on a driver option, it hides the value of that option on
5210 all instances of the same driver.
5211
5212 The following sections describe the syntax used for the different data types
5213 that are found in option settings.
5214
5215
5216 .section "Boolean options" "SECID47"
5217 .cindex "format" "boolean"
5218 .cindex "boolean configuration values"
5219 .oindex "&%no_%&&'xxx'&"
5220 .oindex "&%not_%&&'xxx'&"
5221 Options whose type is given as boolean are on/off switches. There are two
5222 different ways of specifying such options: with and without a data value. If
5223 the option name is specified on its own without data, the switch is turned on;
5224 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5225 boolean options may be followed by an equals sign and one of the words
5226 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5227 the following two settings have exactly the same effect:
5228 .code
5229 queue_only
5230 queue_only = true
5231 .endd
5232 The following two lines also have the same (opposite) effect:
5233 .code
5234 no_queue_only
5235 queue_only = false
5236 .endd
5237 You can use whichever syntax you prefer.
5238
5239
5240
5241
5242 .section "Integer values" "SECID48"
5243 .cindex "integer configuration values"
5244 .cindex "format" "integer"
5245 If an option's type is given as &"integer"&, the value can be given in decimal,
5246 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5247 number is assumed. Otherwise, it is treated as an octal number unless it starts
5248 with the characters &"0x"&, in which case the remainder is interpreted as a
5249 hexadecimal number.
5250
5251 If an integer value is followed by the letter K, it is multiplied by 1024; if
5252 it is followed by the letter M, it is multiplied by 1024x1024;
5253 if by the letter G, 1024x1024x1024.
5254 When the values
5255 of integer option settings are output, values which are an exact multiple of
5256 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5257 and M. The printing style is independent of the actual input format that was
5258 used.
5259
5260
5261 .section "Octal integer values" "SECID49"
5262 .cindex "integer format"
5263 .cindex "format" "octal integer"
5264 If an option's type is given as &"octal integer"&, its value is always
5265 interpreted as an octal number, whether or not it starts with the digit zero.
5266 Such options are always output in octal.
5267
5268
5269 .section "Fixed point numbers" "SECID50"
5270 .cindex "fixed point configuration values"
5271 .cindex "format" "fixed point"
5272 If an option's type is given as &"fixed-point"&, its value must be a decimal
5273 integer, optionally followed by a decimal point and up to three further digits.
5274
5275
5276
5277 .section "Time intervals" "SECTtimeformat"
5278 .cindex "time interval" "specifying in configuration"
5279 .cindex "format" "time interval"
5280 A time interval is specified as a sequence of numbers, each followed by one of
5281 the following letters, with no intervening white space:
5282
5283 .table2 30pt
5284 .irow &%s%& seconds
5285 .irow &%m%& minutes
5286 .irow &%h%& hours
5287 .irow &%d%& days
5288 .irow &%w%& weeks
5289 .endtable
5290
5291 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5292 intervals are output in the same format. Exim does not restrict the values; it
5293 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5294
5295
5296
5297 .section "String values" "SECTstrings"
5298 .cindex "string" "format of configuration values"
5299 .cindex "format" "string"
5300 If an option's type is specified as &"string"&, the value can be specified with
5301 or without double-quotes. If it does not start with a double-quote, the value
5302 consists of the remainder of the line plus any continuation lines, starting at
5303 the first character after any leading white space, with trailing white space
5304 removed, and with no interpretation of the characters in the string. Because
5305 Exim removes comment lines (those beginning with #) at an early stage, they can
5306 appear in the middle of a multi-line string. The following two settings are
5307 therefore equivalent:
5308 .code
5309 trusted_users = uucp:mail
5310 trusted_users = uucp:\
5311                 # This comment line is ignored
5312                 mail
5313 .endd
5314 .cindex "string" "quoted"
5315 .cindex "escape characters in quoted strings"
5316 If a string does start with a double-quote, it must end with a closing
5317 double-quote, and any backslash characters other than those used for line
5318 continuation are interpreted as escape characters, as follows:
5319
5320 .table2 100pt
5321 .irow &`\\`&                     "single backslash"
5322 .irow &`\n`&                     "newline"
5323 .irow &`\r`&                     "carriage return"
5324 .irow &`\t`&                     "tab"
5325 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5326 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5327                                    character"
5328 .endtable
5329
5330 If a backslash is followed by some other character, including a double-quote
5331 character, that character replaces the pair.
5332
5333 Quoting is necessary only if you want to make use of the backslash escapes to
5334 insert special characters, or if you need to specify a value with leading or
5335 trailing spaces. These cases are rare, so quoting is almost never needed in
5336 current versions of Exim. In versions of Exim before 3.14, quoting was required
5337 in order to continue lines, so you may come across older configuration files
5338 and examples that apparently quote unnecessarily.
5339
5340
5341 .section "Expanded strings" "SECID51"
5342 .cindex "expansion" "definition of"
5343 Some strings in the configuration file are subjected to &'string expansion'&,
5344 by which means various parts of the string may be changed according to the
5345 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5346 is as just described; in particular, the handling of backslashes in quoted
5347 strings is done as part of the input process, before expansion takes place.
5348 However, backslash is also an escape character for the expander, so any
5349 backslashes that are required for that reason must be doubled if they are
5350 within a quoted configuration string.
5351
5352
5353 .section "User and group names" "SECID52"
5354 .cindex "user name" "format of"
5355 .cindex "format" "user name"
5356 .cindex "groups" "name format"
5357 .cindex "format" "group name"
5358 User and group names are specified as strings, using the syntax described
5359 above, but the strings are interpreted specially. A user or group name must
5360 either consist entirely of digits, or be a name that can be looked up using the
5361 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5362
5363
5364 .section "List construction" "SECTlistconstruct"
5365 .cindex "list" "syntax of in configuration"
5366 .cindex "format" "list item in configuration"
5367 .cindex "string" "list, definition of"
5368 The data for some configuration options is a list of items, with colon as the
5369 default separator. Many of these options are shown with type &"string list"& in
5370 the descriptions later in this document. Others are listed as &"domain list"&,
5371 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5372 are all the same; however, those other than &"string list"& are subject to
5373 particular kinds of interpretation, as described in chapter
5374 &<<CHAPdomhosaddlists>>&.
5375
5376 In all these cases, the entire list is treated as a single string as far as the
5377 input syntax is concerned. The &%trusted_users%& setting in section
5378 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5379 in a list, it must be entered as two colons. Leading and trailing white space
5380 on each item in a list is ignored. This makes it possible to include items that
5381 start with a colon, and in particular, certain forms of IPv6 address. For
5382 example, the list
5383 .code
5384 local_interfaces = 127.0.0.1 : ::::1
5385 .endd
5386 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5387
5388 &*Note*&: Although leading and trailing white space is ignored in individual
5389 list items, it is not ignored when parsing the list. The space after the first
5390 colon in the example above is necessary. If it were not there, the list would
5391 be interpreted as the two items 127.0.0.1:: and 1.
5392
5393 .section "Changing list separators" "SECTlistsepchange"
5394 .cindex "list separator" "changing"
5395 .cindex "IPv6" "addresses in lists"
5396 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5397 introduced to allow the separator character to be changed. If a list begins
5398 with a left angle bracket, followed by any punctuation character, that
5399 character is used instead of colon as the list separator. For example, the list
5400 above can be rewritten to use a semicolon separator like this:
5401 .code
5402 local_interfaces = <; 127.0.0.1 ; ::1
5403 .endd
5404 This facility applies to all lists, with the exception of the list in
5405 &%log_file_path%&. It is recommended that the use of non-colon separators be
5406 confined to circumstances where they really are needed.
5407
5408 .cindex "list separator" "newline as"
5409 .cindex "newline" "as list separator"
5410 It is also possible to use newline and other control characters (those with
5411 code values less than 32, plus DEL) as separators in lists. Such separators
5412 must be provided literally at the time the list is processed. For options that
5413 are string-expanded, you can write the separator using a normal escape
5414 sequence. This will be processed by the expander before the string is
5415 interpreted as a list. For example, if a newline-separated list of domains is
5416 generated by a lookup, you can process it directly by a line such as this:
5417 .code
5418 domains = <\n ${lookup mysql{.....}}
5419 .endd
5420 This avoids having to change the list separator in such data. You are unlikely
5421 to want to use a control character as a separator in an option that is not
5422 expanded, because the value is literal text. However, it can be done by giving
5423 the value in quotes. For example:
5424 .code
5425 local_interfaces = "<\n 127.0.0.1 \n ::1"
5426 .endd
5427 Unlike printing character separators, which can be included in list items by
5428 doubling, it is not possible to include a control character as data when it is
5429 set as the separator. Two such characters in succession are interpreted as
5430 enclosing an empty list item.
5431
5432
5433
5434 .section "Empty items in lists" "SECTempitelis"
5435 .cindex "list" "empty item in"
5436 An empty item at the end of a list is always ignored. In other words, trailing
5437 separator characters are ignored. Thus, the list in
5438 .code
5439 senders = user@domain :
5440 .endd
5441 contains only a single item. If you want to include an empty string as one item
5442 in a list, it must not be the last item. For example, this list contains three
5443 items, the second of which is empty:
5444 .code
5445 senders = user1@domain : : user2@domain
5446 .endd
5447 &*Note*&: There must be white space between the two colons, as otherwise they
5448 are interpreted as representing a single colon data character (and the list
5449 would then contain just one item). If you want to specify a list that contains
5450 just one, empty item, you can do it as in this example:
5451 .code
5452 senders = :
5453 .endd
5454 In this case, the first item is empty, and the second is discarded because it
5455 is at the end of the list.
5456
5457
5458
5459
5460 .section "Format of driver configurations" "SECTfordricon"
5461 .cindex "drivers" "configuration format"
5462 There are separate parts in the configuration for defining routers, transports,
5463 and authenticators. In each part, you are defining a number of driver
5464 instances, each with its own set of options. Each driver instance is defined by
5465 a sequence of lines like this:
5466 .display
5467 <&'instance name'&>:
5468   <&'option'&>
5469   ...
5470   <&'option'&>
5471 .endd
5472 In the following example, the instance name is &(localuser)&, and it is
5473 followed by three options settings:
5474 .code
5475 localuser:
5476   driver = accept
5477   check_local_user
5478   transport = local_delivery
5479 .endd
5480 For each driver instance, you specify which Exim code module it uses &-- by the
5481 setting of the &%driver%& option &-- and (optionally) some configuration
5482 settings. For example, in the case of transports, if you want a transport to
5483 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5484 a local file you would use the &(appendfile)& driver. Each of the drivers is
5485 described in detail in its own separate chapter later in this manual.
5486
5487 You can have several routers, transports, or authenticators that are based on
5488 the same underlying driver (each must have a different instance name).
5489
5490 The order in which routers are defined is important, because addresses are
5491 passed to individual routers one by one, in order. The order in which
5492 transports are defined does not matter at all. The order in which
5493 authenticators are defined is used only when Exim, as a client, is searching
5494 them to find one that matches an authentication mechanism offered by the
5495 server.
5496
5497 .cindex "generic options"
5498 .cindex "options" "generic &-- definition of"
5499 Within a driver instance definition, there are two kinds of option: &'generic'&
5500 and &'private'&. The generic options are those that apply to all drivers of the
5501 same type (that is, all routers, all transports or all authenticators). The
5502 &%driver%& option is a generic option that must appear in every definition.
5503 .cindex "private options"
5504 The private options are special for each driver, and none need appear, because
5505 they all have default values.
5506
5507 The options may appear in any order, except that the &%driver%& option must
5508 precede any private options, since these depend on the particular driver. For
5509 this reason, it is recommended that &%driver%& always be the first option.
5510
5511 Driver instance names, which are used for reference in log entries and
5512 elsewhere, can be any sequence of letters, digits, and underscores (starting
5513 with a letter) and must be unique among drivers of the same type. A router and
5514 a transport (for example) can each have the same name, but no two router
5515 instances can have the same name. The name of a driver instance should not be
5516 confused with the name of the underlying driver module. For example, the
5517 configuration lines:
5518 .code
5519 remote_smtp:
5520   driver = smtp
5521 .endd
5522 create an instance of the &(smtp)& transport driver whose name is
5523 &(remote_smtp)&. The same driver code can be used more than once, with
5524 different instance names and different option settings each time. A second
5525 instance of the &(smtp)& transport, with different options, might be defined
5526 thus:
5527 .code
5528 special_smtp:
5529   driver = smtp
5530   port = 1234
5531   command_timeout = 10s
5532 .endd
5533 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5534 these transport instances from routers, and these names would appear in log
5535 lines.
5536
5537 Comment lines may be present in the middle of driver specifications. The full
5538 list of option settings for any particular driver instance, including all the
5539 defaulted values, can be extracted by making use of the &%-bP%& command line
5540 option.
5541
5542
5543
5544
5545
5546
5547 . ////////////////////////////////////////////////////////////////////////////
5548 . ////////////////////////////////////////////////////////////////////////////
5549
5550 .chapter "The default configuration file" "CHAPdefconfil"
5551 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5552 .cindex "default" "configuration file &""walk through""&"
5553 The default configuration file supplied with Exim as &_src/configure.default_&
5554 is sufficient for a host with simple mail requirements. As an introduction to
5555 the way Exim is configured, this chapter &"walks through"& the default
5556 configuration, giving brief explanations of the settings. Detailed descriptions
5557 of the options are given in subsequent chapters. The default configuration file
5558 itself contains extensive comments about ways you might want to modify the
5559 initial settings. However, note that there are many options that are not
5560 mentioned at all in the default configuration.
5561
5562
5563
5564 .section "Macros" "SECTdefconfmacros"
5565 All macros should be defined before any options.
5566
5567 One macro is specified, but commented out, in the default configuration:
5568 .code
5569 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5570 .endd
5571 If all off-site mail is expected to be delivered to a "smarthost", then set the
5572 hostname here and uncomment the macro.  This will affect which router is used
5573 later on.  If this is left commented out, then Exim will perform direct-to-MX
5574 deliveries using a &(dnslookup)& router.
5575
5576 In addition to macros defined here, Exim includes a number of built-in macros
5577 to enable configuration to be guarded by a binary built with support for a
5578 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5579
5580
5581 .section "Main configuration settings" "SECTdefconfmain"
5582 The main (global) configuration option settings section must always come first
5583 in the file, after the macros.
5584 The first thing you'll see in the file, after some initial comments, is the line
5585 .code
5586 # primary_hostname =
5587 .endd
5588 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5589 to know the official, fully qualified name of your host, and this is where you
5590 can specify it. However, in most cases you do not need to set this option. When
5591 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5592
5593 The first three non-comment configuration lines are as follows:
5594 .code
5595 domainlist local_domains    = @
5596 domainlist relay_to_domains =
5597 hostlist   relay_from_hosts = 127.0.0.1
5598 .endd
5599 These are not, in fact, option settings. They are definitions of two named
5600 domain lists and one named host list. Exim allows you to give names to lists of
5601 domains, hosts, and email addresses, in order to make it easier to manage the
5602 configuration file (see section &<<SECTnamedlists>>&).
5603
5604 The first line defines a domain list called &'local_domains'&; this is used
5605 later in the configuration to identify domains that are to be delivered
5606 on the local host.
5607
5608 .cindex "@ in a domain list"
5609 There is just one item in this list, the string &"@"&. This is a special form
5610 of entry which means &"the name of the local host"&. Thus, if the local host is
5611 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5612 be delivered locally. Because the local host's name is referenced indirectly,
5613 the same configuration file can be used on different hosts.
5614
5615 The second line defines a domain list called &'relay_to_domains'&, but the
5616 list itself is empty. Later in the configuration we will come to the part that
5617 controls mail relaying through the local host; it allows relaying to any
5618 domains in this list. By default, therefore, no relaying on the basis of a mail
5619 domain is permitted.
5620
5621 The third line defines a host list called &'relay_from_hosts'&. This list is
5622 used later in the configuration to permit relaying from any host or IP address
5623 that matches the list. The default contains just the IP address of the IPv4
5624 loopback interface, which means that processes on the local host are able to
5625 submit mail for relaying by sending it over TCP/IP to that interface. No other
5626 hosts are permitted to submit messages for relaying.
5627
5628 Just to be sure there's no misunderstanding: at this point in the configuration
5629 we aren't actually setting up any controls. We are just defining some domains
5630 and hosts that will be used in the controls that are specified later.
5631
5632 The next two configuration lines are genuine option settings:
5633 .code
5634 acl_smtp_rcpt = acl_check_rcpt
5635 acl_smtp_data = acl_check_data
5636 .endd
5637 These options specify &'Access Control Lists'& (ACLs) that are to be used
5638 during an incoming SMTP session for every recipient of a message (every RCPT
5639 command), and after the contents of the message have been received,
5640 respectively. The names of the lists are &'acl_check_rcpt'& and
5641 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5642 section of the configuration. The RCPT ACL controls which recipients are
5643 accepted for an incoming message &-- if a configuration does not provide an ACL
5644 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5645 contents of a message to be checked.
5646
5647 Two commented-out option settings are next:
5648 .code
5649 # av_scanner = clamd:/tmp/clamd
5650 # spamd_address = 127.0.0.1 783
5651 .endd
5652 These are example settings that can be used when Exim is compiled with the
5653 content-scanning extension. The first specifies the interface to the virus
5654 scanner, and the second specifies the interface to SpamAssassin. Further
5655 details are given in chapter &<<CHAPexiscan>>&.
5656
5657 Three more commented-out option settings follow:
5658 .code
5659 # tls_advertise_hosts = *
5660 # tls_certificate = /etc/ssl/exim.crt
5661 # tls_privatekey = /etc/ssl/exim.pem
5662 .endd
5663 These are example settings that can be used when Exim is compiled with
5664 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5665 first one specifies the list of clients that are allowed to use TLS when
5666 connecting to this server; in this case, the wildcard means all clients. The
5667 other options specify where Exim should find its TLS certificate and private
5668 key, which together prove the server's identity to any clients that connect.
5669 More details are given in chapter &<<CHAPTLS>>&.
5670
5671 Another two commented-out option settings follow:
5672 .code
5673 # daemon_smtp_ports = 25 : 465 : 587
5674 # tls_on_connect_ports = 465
5675 .endd
5676 .cindex "port" "465 and 587"
5677 .cindex "port" "for message submission"
5678 .cindex "message" "submission, ports for"
5679 .cindex "submissions protocol"
5680 .cindex "smtps protocol"
5681 .cindex "ssmtp protocol"
5682 .cindex "SMTP" "submissions protocol"
5683 .cindex "SMTP" "ssmtp protocol"
5684 .cindex "SMTP" "smtps protocol"
5685 These options provide better support for roaming users who wish to use this
5686 server for message submission. They are not much use unless you have turned on
5687 TLS (as described in the previous paragraph) and authentication (about which
5688 more in section &<<SECTdefconfauth>>&).
5689 Mail submission from mail clients (MUAs) should be separate from inbound mail
5690 to your domain (MX delivery) for various good reasons (eg, ability to impose
5691 much saner TLS protocol and ciphersuite requirements without unintended
5692 consequences).
5693 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5694 which uses STARTTLS, so this is the &"submission"& port.
5695 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5696 which should be used in preference to 587.
5697 You should also consider deploying SRV records to help clients find
5698 these ports.
5699 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5700
5701 Two more commented-out options settings follow:
5702 .code
5703 # qualify_domain =
5704 # qualify_recipient =
5705 .endd
5706 The first of these specifies a domain that Exim uses when it constructs a
5707 complete email address from a local login name. This is often needed when Exim
5708 receives a message from a local process. If you do not set &%qualify_domain%&,
5709 the value of &%primary_hostname%& is used. If you set both of these options,
5710 you can have different qualification domains for sender and recipient
5711 addresses. If you set only the first one, its value is used in both cases.
5712
5713 .cindex "domain literal" "recognizing format"
5714 The following line must be uncommented if you want Exim to recognize
5715 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5716 (an IP address within square brackets) instead of a named domain.
5717 .code
5718 # allow_domain_literals
5719 .endd
5720 The RFCs still require this form, but many people think that in the modern
5721 Internet it makes little sense to permit mail to be sent to specific hosts by
5722 quoting their IP addresses. This ancient format has been used by people who
5723 try to abuse hosts by using them for unwanted relaying. However, some
5724 people believe there are circumstances (for example, messages addressed to
5725 &'postmaster'&) where domain literals are still useful.
5726
5727 The next configuration line is a kind of trigger guard:
5728 .code
5729 never_users = root
5730 .endd
5731 It specifies that no delivery must ever be run as the root user. The normal
5732 convention is to set up &'root'& as an alias for the system administrator. This
5733 setting is a guard against slips in the configuration.
5734 The list of users specified by &%never_users%& is not, however, the complete
5735 list; the build-time configuration in &_Local/Makefile_& has an option called
5736 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5737 contents of &%never_users%& are added to this list. By default
5738 FIXED_NEVER_USERS also specifies root.
5739
5740 When a remote host connects to Exim in order to send mail, the only information
5741 Exim has about the host's identity is its IP address. The next configuration
5742 line,
5743 .code
5744 host_lookup = *
5745 .endd
5746 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5747 in order to get a host name. This improves the quality of the logging
5748 information, but if you feel it is too expensive, you can remove it entirely,
5749 or restrict the lookup to hosts on &"nearby"& networks.
5750 Note that it is not always possible to find a host name from an IP address,
5751 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5752 unreachable.
5753
5754 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5755 1413 (hence their names):
5756 .code
5757 rfc1413_hosts = *
5758 rfc1413_query_timeout = 0s
5759 .endd
5760 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5761 Few hosts offer RFC1413 service these days; calls have to be
5762 terminated by a timeout and this needlessly delays the startup
5763 of an incoming SMTP connection.
5764 If you have hosts for which you trust RFC1413 and need this
5765 information, you can change this.
5766
5767 This line enables an efficiency SMTP option.  It is negotiated by clients
5768 and not expected to cause problems but can be disabled if needed.
5769 .code
5770 prdr_enable = true
5771 .endd
5772
5773 When Exim receives messages over SMTP connections, it expects all addresses to
5774 be fully qualified with a domain, as required by the SMTP definition. However,
5775 if you are running a server to which simple clients submit messages, you may
5776 find that they send unqualified addresses. The two commented-out options:
5777 .code
5778 # sender_unqualified_hosts =
5779 # recipient_unqualified_hosts =
5780 .endd
5781 show how you can specify hosts that are permitted to send unqualified sender
5782 and recipient addresses, respectively.
5783
5784 The &%log_selector%& option is used to increase the detail of logging
5785 over the default:
5786 .code
5787 log_selector = +smtp_protocol_error +smtp_syntax_error \
5788                +tls_certificate_verified
5789 .endd
5790
5791 The &%percent_hack_domains%& option is also commented out:
5792 .code
5793 # percent_hack_domains =
5794 .endd
5795 It provides a list of domains for which the &"percent hack"& is to operate.
5796 This is an almost obsolete form of explicit email routing. If you do not know
5797 anything about it, you can safely ignore this topic.
5798
5799 The next two settings in the main part of the default configuration are
5800 concerned with messages that have been &"frozen"& on Exim's queue. When a
5801 message is frozen, Exim no longer continues to try to deliver it. Freezing
5802 occurs when a bounce message encounters a permanent failure because the sender
5803 address of the original message that caused the bounce is invalid, so the
5804 bounce cannot be delivered. This is probably the most common case, but there
5805 are also other conditions that cause freezing, and frozen messages are not
5806 always bounce messages.
5807 .code
5808 ignore_bounce_errors_after = 2d
5809 timeout_frozen_after = 7d
5810 .endd
5811 The first of these options specifies that failing bounce messages are to be
5812 discarded after 2 days in the queue. The second specifies that any frozen
5813 message (whether a bounce message or not) is to be timed out (and discarded)
5814 after a week. In this configuration, the first setting ensures that no failing
5815 bounce message ever lasts a week.
5816
5817 Exim queues it's messages in a spool directory. If you expect to have
5818 large queues, you may consider using this option. It splits the spool
5819 directory into subdirectories to avoid file system degradation from
5820 many files in a single directory, resulting in better performance.
5821 Manual manipulation of queued messages becomes more complex (though fortunately
5822 not often needed).
5823 .code
5824 # split_spool_directory = true
5825 .endd
5826
5827 In an ideal world everybody follows the standards. For non-ASCII
5828 messages RFC 2047 is a standard, allowing a maximum line length of 76
5829 characters. Exim adheres that standard and won't process messages which
5830 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5831 In particular, the Exim maintainers have had multiple reports of
5832 problems from Russian administrators of issues until they disable this
5833 check, because of some popular, yet buggy, mail composition software.
5834 .code
5835 # check_rfc2047_length = false
5836 .endd
5837
5838 If you need to be strictly RFC compliant you may wish to disable the
5839 8BITMIME advertisement. Use this, if you exchange mails with systems
5840 that are not 8-bit clean.
5841 .code
5842 # accept_8bitmime = false
5843 .endd
5844
5845 Libraries you use may depend on specific environment settings.  This
5846 imposes a security risk (e.g. PATH). There are two lists:
5847 &%keep_environment%& for the variables to import as they are, and
5848 &%add_environment%& for variables we want to set to a fixed value.
5849 Note that TZ is handled separately, by the $%timezone%$ runtime
5850 option and by the TIMEZONE_DEFAULT buildtime option.
5851 .code
5852 # keep_environment = ^LDAP
5853 # add_environment = PATH=/usr/bin::/bin
5854 .endd
5855
5856
5857 .section "ACL configuration" "SECID54"
5858 .cindex "default" "ACLs"
5859 .cindex "&ACL;" "default configuration"
5860 In the default configuration, the ACL section follows the main configuration.
5861 It starts with the line
5862 .code
5863 begin acl
5864 .endd
5865 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5866 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5867 and &%acl_smtp_data%& above.
5868
5869 .cindex "RCPT" "ACL for"
5870 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5871 RCPT command specifies one of the message's recipients. The ACL statements
5872 are considered in order, until the recipient address is either accepted or
5873 rejected. The RCPT command is then accepted or rejected, according to the
5874 result of the ACL processing.
5875 .code
5876 acl_check_rcpt:
5877 .endd
5878 This line, consisting of a name terminated by a colon, marks the start of the
5879 ACL, and names it.
5880 .code
5881 accept  hosts = :
5882 .endd
5883 This ACL statement accepts the recipient if the sending host matches the list.
5884 But what does that strange list mean? It doesn't actually contain any host
5885 names or IP addresses. The presence of the colon puts an empty item in the
5886 list; Exim matches this only if the incoming message did not come from a remote
5887 host, because in that case, the remote hostname is empty. The colon is
5888 important. Without it, the list itself is empty, and can never match anything.
5889
5890 What this statement is doing is to accept unconditionally all recipients in
5891 messages that are submitted by SMTP from local processes using the standard
5892 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5893 manner.
5894 .code
5895 deny    message       = Restricted characters in address
5896         domains       = +local_domains
5897         local_parts   = ^[.] : ^.*[@%!/|]
5898
5899 deny    message       = Restricted characters in address
5900         domains       = !+local_domains
5901         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5902 .endd
5903 These statements are concerned with local parts that contain any of the
5904 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5905 Although these characters are entirely legal in local parts (in the case of
5906 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5907 in Internet mail addresses.
5908
5909 The first three have in the past been associated with explicitly routed
5910 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5911 option). Addresses containing these characters are regularly tried by spammers
5912 in an attempt to bypass relaying restrictions, and also by open relay testing
5913 programs. Unless you really need them it is safest to reject these characters
5914 at this early stage. This configuration is heavy-handed in rejecting these
5915 characters for all messages it accepts from remote hosts. This is a deliberate
5916 policy of being as safe as possible.
5917
5918 The first rule above is stricter, and is applied to messages that are addressed
5919 to one of the local domains handled by this host. This is implemented by the
5920 first condition, which restricts it to domains that are listed in the
5921 &'local_domains'& domain list. The &"+"& character is used to indicate a
5922 reference to a named list. In this configuration, there is just one domain in
5923 &'local_domains'&, but in general there may be many.
5924
5925 The second condition on the first statement uses two regular expressions to
5926 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5927 or &"|"&. If you have local accounts that include these characters, you will
5928 have to modify this rule.
5929
5930 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5931 allows them because they have been encountered in practice. (Consider the
5932 common convention of local parts constructed as
5933 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5934 the author of Exim, who has no second initial.) However, a local part starting
5935 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5936 filename (for example, for a mailing list). This is also true for local parts
5937 that contain slashes. A pipe symbol can also be troublesome if the local part
5938 is incorporated unthinkingly into a shell command line.
5939
5940 The second rule above applies to all other domains, and is less strict. This
5941 allows your own users to send outgoing messages to sites that use slashes
5942 and vertical bars in their local parts. It blocks local parts that begin
5943 with a dot, slash, or vertical bar, but allows these characters within the
5944 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5945 and &"!"& is blocked, as before. The motivation here is to prevent your users
5946 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5947 .code
5948 accept  local_parts   = postmaster
5949         domains       = +local_domains
5950 .endd
5951 This statement, which has two conditions, accepts an incoming address if the
5952 local part is &'postmaster'& and the domain is one of those listed in the
5953 &'local_domains'& domain list. The &"+"& character is used to indicate a
5954 reference to a named list. In this configuration, there is just one domain in
5955 &'local_domains'&, but in general there may be many.
5956
5957 The presence of this statement means that mail to postmaster is never blocked
5958 by any of the subsequent tests. This can be helpful while sorting out problems
5959 in cases where the subsequent tests are incorrectly denying access.
5960 .code
5961 require verify        = sender
5962 .endd
5963 This statement requires the sender address to be verified before any subsequent
5964 ACL statement can be used. If verification fails, the incoming recipient
5965 address is refused. Verification consists of trying to route the address, to
5966 see if a bounce message could be delivered to it. In the case of remote
5967 addresses, basic verification checks only the domain, but &'callouts'& can be
5968 used for more verification if required. Section &<<SECTaddressverification>>&
5969 discusses the details of address verification.
5970 .code
5971 accept  hosts         = +relay_from_hosts
5972         control       = submission
5973 .endd
5974 This statement accepts the address if the message is coming from one of the
5975 hosts that are defined as being allowed to relay through this host. Recipient
5976 verification is omitted here, because in many cases the clients are dumb MUAs
5977 that do not cope well with SMTP error responses. For the same reason, the
5978 second line specifies &"submission mode"& for messages that are accepted. This
5979 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5980 messages that are deficient in some way, for example, because they lack a
5981 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5982 probably add recipient verification here, and disable submission mode.
5983 .code
5984 accept  authenticated = *
5985         control       = submission
5986 .endd
5987 This statement accepts the address if the client host has authenticated itself.
5988 Submission mode is again specified, on the grounds that such messages are most
5989 likely to come from MUAs. The default configuration does not define any
5990 authenticators, though it does include some nearly complete commented-out
5991 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5992 fact authenticate until you complete the authenticator definitions.
5993 .code
5994 require message = relay not permitted
5995         domains = +local_domains : +relay_to_domains
5996 .endd
5997 This statement rejects the address if its domain is neither a local domain nor
5998 one of the domains for which this host is a relay.
5999 .code
6000 require verify = recipient
6001 .endd
6002 This statement requires the recipient address to be verified; if verification
6003 fails, the address is rejected.
6004 .code
6005 # deny    message     = rejected because $sender_host_address \
6006 #                       is in a black list at $dnslist_domain\n\
6007 #                       $dnslist_text
6008 #         dnslists    = black.list.example
6009 #
6010 # warn    dnslists    = black.list.example
6011 #         add_header  = X-Warning: $sender_host_address is in \
6012 #                       a black list at $dnslist_domain
6013 #         log_message = found in $dnslist_domain
6014 .endd
6015 These commented-out lines are examples of how you could configure Exim to check
6016 sending hosts against a DNS black list. The first statement rejects messages
6017 from blacklisted hosts, whereas the second just inserts a warning header
6018 line.
6019 .code
6020 # require verify = csa
6021 .endd
6022 This commented-out line is an example of how you could turn on client SMTP
6023 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6024 records.
6025 .code
6026 accept
6027 .endd
6028 The final statement in the first ACL unconditionally accepts any recipient
6029 address that has successfully passed all the previous tests.
6030 .code
6031 acl_check_data:
6032 .endd
6033 This line marks the start of the second ACL, and names it. Most of the contents
6034 of this ACL are commented out:
6035 .code
6036 # deny    malware   = *
6037 #         message   = This message contains a virus \
6038 #                     ($malware_name).
6039 .endd
6040 These lines are examples of how to arrange for messages to be scanned for
6041 viruses when Exim has been compiled with the content-scanning extension, and a
6042 suitable virus scanner is installed. If the message is found to contain a
6043 virus, it is rejected with the given custom error message.
6044 .code
6045 # warn    spam      = nobody
6046 #         message   = X-Spam_score: $spam_score\n\
6047 #                     X-Spam_score_int: $spam_score_int\n\
6048 #                     X-Spam_bar: $spam_bar\n\
6049 #                     X-Spam_report: $spam_report
6050 .endd
6051 These lines are an example of how to arrange for messages to be scanned by
6052 SpamAssassin when Exim has been compiled with the content-scanning extension,
6053 and SpamAssassin has been installed. The SpamAssassin check is run with
6054 &`nobody`& as its user parameter, and the results are added to the message as a
6055 series of extra header line. In this case, the message is not rejected,
6056 whatever the spam score.
6057 .code
6058 accept
6059 .endd
6060 This final line in the DATA ACL accepts the message unconditionally.
6061
6062
6063 .section "Router configuration" "SECID55"
6064 .cindex "default" "routers"
6065 .cindex "routers" "default"
6066 The router configuration comes next in the default configuration, introduced
6067 by the line
6068 .code
6069 begin routers
6070 .endd
6071 Routers are the modules in Exim that make decisions about where to send
6072 messages. An address is passed to each router, in turn, until it is either
6073 accepted, or failed. This means that the order in which you define the routers
6074 matters. Each router is fully described in its own chapter later in this
6075 manual. Here we give only brief overviews.
6076 .code
6077 # domain_literal:
6078 #   driver = ipliteral
6079 #   domains = !+local_domains
6080 #   transport = remote_smtp
6081 .endd
6082 .cindex "domain literal" "default router"
6083 This router is commented out because the majority of sites do not want to
6084 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6085 you uncomment this router, you also need to uncomment the setting of
6086 &%allow_domain_literals%& in the main part of the configuration.
6087
6088 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6089 macro has been defined, per
6090 .code
6091 .ifdef ROUTER_SMARTHOST
6092 smarthost:
6093 #...
6094 .else
6095 dnslookup:
6096 #...
6097 .endif
6098 .endd
6099
6100 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6101 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6102 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6103 skip these routers because of the &%domains%& option.
6104
6105 .code
6106 smarthost:
6107   driver = manualroute
6108   domains = ! +local_domains
6109   transport = smarthost_smtp
6110   route_data = ROUTER_SMARTHOST
6111   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6112   no_more
6113 .endd
6114 This router only handles mail which is not to any local domains; this is
6115 specified by the line
6116 .code
6117 domains = ! +local_domains
6118 .endd
6119 The &%domains%& option lists the domains to which this router applies, but the
6120 exclamation mark is a negation sign, so the router is used only for domains
6121 that are not in the domain list called &'local_domains'& (which was defined at
6122 the start of the configuration). The plus sign before &'local_domains'&
6123 indicates that it is referring to a named list. Addresses in other domains are
6124 passed on to the following routers.
6125
6126 The name of the router driver is &(manualroute)& because we are manually
6127 specifying how mail should be routed onwards, instead of using DNS MX.
6128 While the name of this router instance is arbitrary, the &%driver%& option must
6129 be one of the driver modules that is in the Exim binary.
6130
6131 With no pre-conditions other than &%domains%&, all mail for non-local domains
6132 will be handled by this router, and the &%no_more%& setting will ensure that no
6133 other routers will be used for messages matching the pre-conditions.  See
6134 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6135 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6136 and the macro supplies the value; the address is then queued for the
6137 &(smarthost_smtp)& transport.
6138
6139 .code
6140 dnslookup:
6141   driver = dnslookup
6142   domains = ! +local_domains
6143   transport = remote_smtp
6144   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6145   no_more
6146 .endd
6147 The &%domains%& option behaves as per smarthost, above.
6148
6149 The name of the router driver is &(dnslookup)&,
6150 and is specified by the &%driver%& option. Do not be confused by the fact that
6151 the name of this router instance is the same as the name of the driver. The
6152 instance name is arbitrary, but the name set in the &%driver%& option must be
6153 one of the driver modules that is in the Exim binary.
6154
6155 The &(dnslookup)& router routes addresses by looking up their domains in the
6156 DNS in order to obtain a list of hosts to which the address is routed. If the
6157 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6158 specified by the &%transport%& option. If the router does not find the domain
6159 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6160 the address fails and is bounced.
6161
6162 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6163 be entirely ignored. This option is present because a number of cases have been
6164 encountered where MX records in the DNS point to host names
6165 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6166 Completely ignoring these IP addresses causes Exim to fail to route the
6167 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6168 continue to try to deliver the message periodically until the address timed
6169 out.
6170 .code
6171 system_aliases:
6172   driver = redirect
6173   allow_fail
6174   allow_defer
6175   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6176 # user = exim
6177   file_transport = address_file
6178   pipe_transport = address_pipe
6179 .endd
6180 Control reaches this and subsequent routers only for addresses in the local
6181 domains. This router checks to see whether the local part is defined as an
6182 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6183 data that it looks up from that file. If no data is found for the local part,
6184 the value of the &%data%& option is empty, causing the address to be passed to
6185 the next router.
6186
6187 &_/etc/aliases_& is a conventional name for the system aliases file that is
6188 often used. That is why it is referenced by from the default configuration
6189 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6190 &_Local/Makefile_& before building Exim.
6191 .code
6192 userforward:
6193   driver = redirect
6194   check_local_user
6195 # local_part_suffix = +* : -*
6196 # local_part_suffix_optional
6197   file = $home/.forward
6198 # allow_filter
6199   no_verify
6200   no_expn
6201   check_ancestor
6202   file_transport = address_file
6203   pipe_transport = address_pipe
6204   reply_transport = address_reply
6205 .endd
6206 This is the most complicated router in the default configuration. It is another
6207 redirection router, but this time it is looking for forwarding data set up by
6208 individual users. The &%check_local_user%& setting specifies a check that the
6209 local part of the address is the login name of a local user. If it is not, the
6210 router is skipped. The two commented options that follow &%check_local_user%&,
6211 namely:
6212 .code
6213 # local_part_suffix = +* : -*
6214 # local_part_suffix_optional
6215 .endd
6216 .vindex "&$local_part_suffix$&"
6217 show how you can specify the recognition of local part suffixes. If the first
6218 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6219 by any sequence of characters, is removed from the local part and placed in the
6220 variable &$local_part_suffix$&. The second suffix option specifies that the
6221 presence of a suffix in the local part is optional. When a suffix is present,
6222 the check for a local login uses the local part with the suffix removed.
6223
6224 When a local user account is found, the file called &_.forward_& in the user's
6225 home directory is consulted. If it does not exist, or is empty, the router
6226 declines. Otherwise, the contents of &_.forward_& are interpreted as
6227 redirection data (see chapter &<<CHAPredirect>>& for more details).
6228
6229 .cindex "Sieve filter" "enabling in default router"
6230 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6231 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6232 is commented out by default), the contents of the file are interpreted as a set
6233 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6234 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6235 separate document entitled &'Exim's interfaces to mail filtering'&.
6236
6237 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6238 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6239 There are two reasons for doing this:
6240
6241 .olist
6242 Whether or not a local user has a &_.forward_& file is not really relevant when
6243 checking an address for validity; it makes sense not to waste resources doing
6244 unnecessary work.
6245 .next
6246 More importantly, when Exim is verifying addresses or handling an EXPN
6247 command during an SMTP session, it is running as the Exim user, not as root.
6248 The group is the Exim group, and no additional groups are set up.
6249 It may therefore not be possible for Exim to read users' &_.forward_& files at
6250 this time.
6251 .endlist
6252
6253 The setting of &%check_ancestor%& prevents the router from generating a new
6254 address that is the same as any previous address that was redirected. (This
6255 works round a problem concerning a bad interaction between aliasing and
6256 forwarding &-- see section &<<SECTredlocmai>>&).
6257
6258 The final three option settings specify the transports that are to be used when
6259 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6260 auto-reply, respectively. For example, if a &_.forward_& file contains
6261 .code
6262 a.nother@elsewhere.example, /home/spqr/archive
6263 .endd
6264 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6265 transport.
6266 .code
6267 localuser:
6268   driver = accept
6269   check_local_user
6270 # local_part_suffix = +* : -*
6271 # local_part_suffix_optional
6272   transport = local_delivery
6273 .endd
6274 The final router sets up delivery into local mailboxes, provided that the local
6275 part is the name of a local login, by accepting the address and assigning it to
6276 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6277 routers, so the address is bounced. The commented suffix settings fulfil the
6278 same purpose as they do for the &(userforward)& router.
6279
6280
6281 .section "Transport configuration" "SECID56"
6282 .cindex "default" "transports"
6283 .cindex "transports" "default"
6284 Transports define mechanisms for actually delivering messages. They operate
6285 only when referenced from routers, so the order in which they are defined does
6286 not matter. The transports section of the configuration starts with
6287 .code
6288 begin transports
6289 .endd
6290 Two remote transports and four local transports are defined.
6291 .code
6292 remote_smtp:
6293   driver = smtp
6294   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6295 .ifdef _HAVE_PRDR
6296   hosts_try_prdr = *
6297 .endif
6298 .endd
6299 This transport is used for delivering messages over SMTP connections.
6300 The list of remote hosts comes from the router.
6301 The &%message_size_limit%& usage is a hack to avoid sending on messages
6302 with over-long lines.
6303
6304 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6305 negotiated between client and server and not expected to cause problems
6306 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6307 use of the &%hosts_try_prdr%& configuration option.
6308
6309 The other remote transport is used when delivering to a specific smarthost
6310 with whom there must be some kind of existing relationship, instead of the
6311 usual federated system.
6312
6313 .code
6314 smarthost_smtp:
6315   driver = smtp
6316   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6317   multi_domain
6318   #
6319 .ifdef _HAVE_TLS
6320   # Comment out any of these which you have to, then file a Support
6321   # request with your smarthost provider to get things fixed:
6322   hosts_require_tls = *
6323   tls_verify_hosts = *
6324   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6325   # have to comment it out then this will at least log whether you succeed
6326   # or not:
6327   tls_try_verify_hosts = *
6328   #
6329   # The SNI name should match the name which we'll expect to verify;
6330   # many mail systems don't use SNI and this doesn't matter, but if it does,
6331   # we need to send a name which the remote site will recognize.
6332   # This _should_ be the name which the smarthost operators specified as
6333   # the hostname for sending your mail to.
6334   tls_sni = ROUTER_SMARTHOST
6335   #
6336 .ifdef _HAVE_OPENSSL
6337   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6338 .endif
6339 .ifdef _HAVE_GNUTLS
6340   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6341 .endif
6342 .endif
6343 .ifdef _HAVE_PRDR
6344   hosts_try_prdr = *
6345 .endif
6346 .endd
6347 After the same &%message_size_limit%& hack, we then specify that this Transport
6348 can handle messages to multiple domains in one run.  The assumption here is
6349 that you're routing all non-local mail to the same place and that place is
6350 happy to take all messages from you as quickly as possible.
6351 All other options depend upon built-in macros; if Exim was built without TLS support
6352 then no other options are defined.
6353 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6354 and versions using the &%tls_require_ciphers%& option, where the value to be
6355 used depends upon the library providing TLS.
6356 Beyond that, the options adopt the stance that you should have TLS support available
6357 from your smarthost on today's Internet, so we turn on requiring TLS for the
6358 mail to be delivered, and requiring that the certificate be valid, and match
6359 the expected hostname.  The &%tls_sni%& option can be used by service providers
6360 to select an appropriate certificate to present to you and here we re-use the
6361 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6362 You want to specify the hostname which you'll expect to validate for, and that
6363 should not be subject to insecure tampering via DNS results.
6364
6365 For the &%hosts_try_prdr%& option see the previous transport.
6366
6367 All other options are defaulted.
6368 .code
6369 local_delivery:
6370   driver = appendfile
6371   file = /var/mail/$local_part_verified
6372   delivery_date_add
6373   envelope_to_add
6374   return_path_add
6375 # group = mail
6376 # mode = 0660
6377 .endd
6378 This &(appendfile)& transport is used for local delivery to user mailboxes in
6379 traditional BSD mailbox format.
6380
6381 .new
6382 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6383 as it is provided by a potential bad actor.
6384 Instead we use &$local_part_verified$&,
6385 the result of looking up &$local_part$& in the user database
6386 (done by using &%check_local_user%& in the the router).
6387 .wen
6388
6389 By default &(appendfile)& runs under the uid and gid of the
6390 local user, which requires the sticky bit to be set on the &_/var/mail_&
6391 directory. Some systems use the alternative approach of running mail deliveries
6392 under a particular group instead of using the sticky bit. The commented options
6393 show how this can be done.
6394
6395 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6396 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6397 similarly-named options above.
6398 .code
6399 address_pipe:
6400   driver = pipe
6401   return_output
6402 .endd
6403 This transport is used for handling deliveries to pipes that are generated by
6404 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6405 option specifies that any output on stdout or stderr generated by the pipe is to
6406 be returned to the sender.
6407 .code
6408 address_file:
6409   driver = appendfile
6410   delivery_date_add
6411   envelope_to_add
6412   return_path_add
6413 .endd
6414 This transport is used for handling deliveries to files that are generated by
6415 redirection. The name of the file is not specified in this instance of
6416 &(appendfile)&, because it comes from the &(redirect)& router.
6417 .code
6418 address_reply:
6419   driver = autoreply
6420 .endd
6421 This transport is used for handling automatic replies generated by users'
6422 filter files.
6423
6424
6425
6426 .section "Default retry rule" "SECID57"
6427 .cindex "retry" "default rule"
6428 .cindex "default" "retry rule"
6429 The retry section of the configuration file contains rules which affect the way
6430 Exim retries deliveries that cannot be completed at the first attempt. It is
6431 introduced by the line
6432 .code
6433 begin retry
6434 .endd
6435 In the default configuration, there is just one rule, which applies to all
6436 errors:
6437 .code
6438 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6439 .endd
6440 This causes any temporarily failing address to be retried every 15 minutes for
6441 2 hours, then at intervals starting at one hour and increasing by a factor of
6442 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6443 is not delivered after 4 days of temporary failure, it is bounced. The time is
6444 measured from first failure, not from the time the message was received.
6445
6446 If the retry section is removed from the configuration, or is empty (that is,
6447 if no retry rules are defined), Exim will not retry deliveries. This turns
6448 temporary errors into permanent errors.
6449
6450
6451 .section "Rewriting configuration" "SECID58"
6452 The rewriting section of the configuration, introduced by
6453 .code
6454 begin rewrite
6455 .endd
6456 contains rules for rewriting addresses in messages as they arrive. There are no
6457 rewriting rules in the default configuration file.
6458
6459
6460
6461 .section "Authenticators configuration" "SECTdefconfauth"
6462 .cindex "AUTH" "configuration"
6463 The authenticators section of the configuration, introduced by
6464 .code
6465 begin authenticators
6466 .endd
6467 defines mechanisms for the use of the SMTP AUTH command. The default
6468 configuration file contains two commented-out example authenticators
6469 which support plaintext username/password authentication using the
6470 standard PLAIN mechanism and the traditional but non-standard LOGIN
6471 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6472 to support most MUA software.
6473
6474 The example PLAIN authenticator looks like this:
6475 .code
6476 #PLAIN:
6477 #  driver                  = plaintext
6478 #  server_set_id           = $auth2
6479 #  server_prompts          = :
6480 #  server_condition        = Authentication is not yet configured
6481 #  server_advertise_condition = ${if def:tls_in_cipher }
6482 .endd
6483 And the example LOGIN authenticator looks like this:
6484 .code
6485 #LOGIN:
6486 #  driver                  = plaintext
6487 #  server_set_id           = $auth1
6488 #  server_prompts          = <| Username: | Password:
6489 #  server_condition        = Authentication is not yet configured
6490 #  server_advertise_condition = ${if def:tls_in_cipher }
6491 .endd
6492
6493 The &%server_set_id%& option makes Exim remember the authenticated username
6494 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6495 &%server_prompts%& option configures the &(plaintext)& authenticator so
6496 that it implements the details of the specific authentication mechanism,
6497 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6498 when Exim offers authentication to clients; in the examples, this is only
6499 when TLS or SSL has been started, so to enable the authenticators you also
6500 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6501
6502 The &%server_condition%& setting defines how to verify that the username and
6503 password are correct. In the examples it just produces an error message.
6504 To make the authenticators work, you can use a string expansion
6505 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6506
6507 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6508 usercode and password are in different positions.
6509 Chapter &<<CHAPplaintext>>& covers both.
6510
6511 .ecindex IIDconfiwal
6512
6513
6514
6515 . ////////////////////////////////////////////////////////////////////////////
6516 . ////////////////////////////////////////////////////////////////////////////
6517
6518 .chapter "Regular expressions" "CHAPregexp"
6519
6520 .cindex "regular expressions" "library"
6521 .cindex "PCRE"
6522 Exim supports the use of regular expressions in many of its options. It
6523 uses the PCRE regular expression library; this provides regular expression
6524 matching that is compatible with Perl 5. The syntax and semantics of
6525 regular expressions is discussed in
6526 online Perl manpages, in
6527 many Perl reference books, and also in
6528 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6529 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6530 . --- the http: URL here redirects to another page with the ISBN in the URL
6531 . --- where trying to use https: just redirects back to http:, so sticking
6532 . --- to the old URL for now.  2018-09-07.
6533
6534 The documentation for the syntax and semantics of the regular expressions that
6535 are supported by PCRE is included in the PCRE distribution, and no further
6536 description is included here. The PCRE functions are called from Exim using
6537 the default option settings (that is, with no PCRE options set), except that
6538 the PCRE_CASELESS option is set when the matching is required to be
6539 case-insensitive.
6540
6541 In most cases, when a regular expression is required in an Exim configuration,
6542 it has to start with a circumflex, in order to distinguish it from plain text
6543 or an &"ends with"& wildcard. In this example of a configuration setting, the
6544 second item in the colon-separated list is a regular expression.
6545 .code
6546 domains = a.b.c : ^\\d{3} : *.y.z : ...
6547 .endd
6548 The doubling of the backslash is required because of string expansion that
6549 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6550 of this issue, and a way of avoiding the need for doubling backslashes. The
6551 regular expression that is eventually used in this example contains just one
6552 backslash. The circumflex is included in the regular expression, and has the
6553 normal effect of &"anchoring"& it to the start of the string that is being
6554 matched.
6555
6556 There are, however, two cases where a circumflex is not required for the
6557 recognition of a regular expression: these are the &%match%& condition in a
6558 string expansion, and the &%matches%& condition in an Exim filter file. In
6559 these cases, the relevant string is always treated as a regular expression; if
6560 it does not start with a circumflex, the expression is not anchored, and can
6561 match anywhere in the subject string.
6562
6563 In all cases, if you want a regular expression to match at the end of a string,
6564 you must code the $ metacharacter to indicate this. For example:
6565 .code
6566 domains = ^\\d{3}\\.example
6567 .endd
6568 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6569 You need to use:
6570 .code
6571 domains = ^\\d{3}\\.example\$
6572 .endd
6573 if you want &'example'& to be the top-level domain. The backslash before the
6574 $ is needed because string expansion also interprets dollar characters.
6575
6576
6577
6578 . ////////////////////////////////////////////////////////////////////////////
6579 . ////////////////////////////////////////////////////////////////////////////
6580
6581 .chapter "File and database lookups" "CHAPfdlookup"
6582 .scindex IIDfidalo1 "file" "lookups"
6583 .scindex IIDfidalo2 "database" "lookups"
6584 .cindex "lookup" "description of"
6585 Exim can be configured to look up data in files or databases as it processes
6586 messages. Two different kinds of syntax are used:
6587
6588 .olist
6589 A string that is to be expanded may contain explicit lookup requests. These
6590 cause parts of the string to be replaced by data that is obtained from the
6591 lookup. Lookups of this type are conditional expansion items. Different results
6592 can be defined for the cases of lookup success and failure. See chapter
6593 &<<CHAPexpand>>&, where string expansions are described in detail.
6594 The key for the lookup is specified as part of the string expansion.
6595 .next
6596 Lists of domains, hosts, and email addresses can contain lookup requests as a
6597 way of avoiding excessively long linear lists. In this case, the data that is
6598 returned by the lookup is often (but not always) discarded; whether the lookup
6599 succeeds or fails is what really counts. These kinds of list are described in
6600 chapter &<<CHAPdomhosaddlists>>&.
6601 The key for the lookup is given by the context in which the list is expanded.
6602 .endlist
6603
6604 String expansions, lists, and lookups interact with each other in such a way
6605 that there is no order in which to describe any one of them that does not
6606 involve references to the others. Each of these three chapters makes more sense
6607 if you have read the other two first. If you are reading this for the first
6608 time, be aware that some of it will make a lot more sense after you have read
6609 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6610
6611 .section "Examples of different lookup syntax" "SECID60"
6612 It is easy to confuse the two different kinds of lookup, especially as the
6613 lists that may contain the second kind are always expanded before being
6614 processed as lists. Therefore, they may also contain lookups of the first kind.
6615 Be careful to distinguish between the following two examples:
6616 .code
6617 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6618 domains = lsearch;/some/file
6619 .endd
6620 The first uses a string expansion, the result of which must be a domain list.
6621 No strings have been specified for a successful or a failing lookup; the
6622 defaults in this case are the looked-up data and an empty string, respectively.
6623 The expansion takes place before the string is processed as a list, and the
6624 file that is searched could contain lines like this:
6625 .code
6626 192.168.3.4: domain1:domain2:...
6627 192.168.1.9: domain3:domain4:...
6628 .endd
6629 When the lookup succeeds, the result of the expansion is a list of domains (and
6630 possibly other types of item that are allowed in domain lists).
6631
6632 In the second example, the lookup is a single item in a domain list. It causes
6633 Exim to use a lookup to see if the domain that is being processed can be found
6634 in the file. The file could contains lines like this:
6635 .code
6636 domain1:
6637 domain2:
6638 .endd
6639 Any data that follows the keys is not relevant when checking that the domain
6640 matches the list item.
6641
6642 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6643 Consider a file containing lines like this:
6644 .code
6645 192.168.5.6: lsearch;/another/file
6646 .endd
6647 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6648 first &%domains%& setting above generates the second setting, which therefore
6649 causes a second lookup to occur.
6650
6651 The rest of this chapter describes the different lookup types that are
6652 available. Any of them can be used in any part of the configuration where a
6653 lookup is permitted.
6654
6655
6656 .section "Lookup types" "SECID61"
6657 .cindex "lookup" "types of"
6658 .cindex "single-key lookup" "definition of"
6659 Two different types of data lookup are implemented:
6660
6661 .ilist
6662 The &'single-key'& type requires the specification of a file in which to look,
6663 and a single key to search for. The key must be a non-empty string for the
6664 lookup to succeed. The lookup type determines how the file is searched.
6665 .next
6666 .cindex "query-style lookup" "definition of"
6667 The &'query-style'& type accepts a generalized database query. No particular
6668 key value is assumed by Exim for query-style lookups. You can use whichever
6669 Exim variables you need to construct the database query.
6670 .endlist
6671
6672 The code for each lookup type is in a separate source file that is included in
6673 the binary of Exim only if the corresponding compile-time option is set. The
6674 default settings in &_src/EDITME_& are:
6675 .code
6676 LOOKUP_DBM=yes
6677 LOOKUP_LSEARCH=yes
6678 .endd
6679 which means that only linear searching and DBM lookups are included by default.
6680 For some types of lookup (e.g. SQL databases), you need to install appropriate
6681 libraries and header files before building Exim.
6682
6683
6684
6685
6686 .section "Single-key lookup types" "SECTsinglekeylookups"
6687 .cindex "lookup" "single-key types"
6688 .cindex "single-key lookup" "list of types"
6689 The following single-key lookup types are implemented:
6690
6691 .ilist
6692 .cindex "cdb" "description of"
6693 .cindex "lookup" "cdb"
6694 .cindex "binary zero" "in lookup key"
6695 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6696 string without a terminating binary zero. The cdb format is designed for
6697 indexed files that are read frequently and never updated, except by total
6698 re-creation. As such, it is particularly suitable for large files containing
6699 aliases or other indexed data referenced by an MTA. Information about cdb and
6700 tools for building the files can be found in several places:
6701 .display
6702 &url(https://cr.yp.to/cdb.html)
6703 &url(https://www.corpit.ru/mjt/tinycdb.html)
6704 &url(https://packages.debian.org/stable/utils/freecdb)
6705 &url(https://github.com/philpennock/cdbtools) (in Go)
6706 .endd
6707 A cdb distribution is not needed in order to build Exim with cdb support,
6708 because the code for reading cdb files is included directly in Exim itself.
6709 However, no means of building or testing cdb files is provided with Exim, so
6710 you need to obtain a cdb distribution in order to do this.
6711 .next
6712 .cindex "DBM" "lookup type"
6713 .cindex "lookup" "dbm"
6714 .cindex "binary zero" "in lookup key"
6715 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6716 DBM file by looking up the record with the given key. A terminating binary
6717 zero is included in the key that is passed to the DBM library. See section
6718 &<<SECTdb>>& for a discussion of DBM libraries.
6719
6720 .cindex "Berkeley DB library" "file format"
6721 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6722 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6723 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6724 the DB_UNKNOWN option. This enables it to handle any of the types of database
6725 that the library supports, and can be useful for accessing DBM files created by
6726 other applications. (For earlier DB versions, DB_HASH is always used.)
6727 .next
6728 .cindex "lookup" "dbmjz"
6729 .cindex "lookup" "dbm &-- embedded NULs"
6730 .cindex "sasldb2"
6731 .cindex "dbmjz lookup type"
6732 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6733 interpreted as an Exim list; the elements of the list are joined together with
6734 ASCII NUL characters to form the lookup key.  An example usage would be to
6735 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6736 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6737 &(cram_md5)& authenticator.
6738 .next
6739 .cindex "lookup" "dbmnz"
6740 .cindex "lookup" "dbm &-- terminating zero"
6741 .cindex "binary zero" "in lookup key"
6742 .cindex "Courier"
6743 .cindex "&_/etc/userdbshadow.dat_&"
6744 .cindex "dbmnz lookup type"
6745 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6746 is not included in the key that is passed to the DBM library. You may need this
6747 if you want to look up data in files that are created by or shared with some
6748 other application that does not use terminating zeros. For example, you need to
6749 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6750 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6751 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6752 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6753 .next
6754 .cindex "lookup" "dsearch"
6755 .cindex "dsearch lookup type"
6756 &(dsearch)&: The given file must be a directory; this is searched for an entry
6757 whose name is the key by calling the &[lstat()]& function. The key may not
6758 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6759 the lookup is the name of the entry, which may be a file, directory,
6760 symbolic link, or any other kind of directory entry. An example of how this
6761 lookup can be used to support virtual domains is given in section
6762 &<<SECTvirtualdomains>>&.
6763 .next
6764 .cindex "lookup" "iplsearch"
6765 .cindex "iplsearch lookup type"
6766 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6767 terminated by a colon or white space or the end of the line. The keys in the
6768 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6769 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6770 being interpreted as a key terminator. For example:
6771 .code
6772 1.2.3.4:           data for 1.2.3.4
6773 192.168.0.0/16:    data for 192.168.0.0/16
6774 "abcd::cdab":      data for abcd::cdab
6775 "abcd:abcd::/32"   data for abcd:abcd::/32
6776 .endd
6777 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6778 file is searched linearly, using the CIDR masks where present, until a matching
6779 key is found. The first key that matches is used; there is no attempt to find a
6780 &"best"& match. Apart from the way the keys are matched, the processing for
6781 &(iplsearch)& is the same as for &(lsearch)&.
6782
6783 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6784 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6785 lookup types support only literal keys.
6786
6787 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6788 the implicit key is the host's IP address rather than its name (see section
6789 &<<SECThoslispatsikey>>&).
6790
6791 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6792 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6793 notation before executing the lookup.)
6794 .next
6795 .cindex lookup json
6796 .cindex json "lookup type"
6797 .cindex JSON expansions
6798 &(json)&: The given file is a text file with a JSON structure.
6799 An element of the structure is extracted, defined by the search key.
6800 The key is a list of subelement selectors
6801 (colon-separated by default but changeable in the usual way)
6802 which are applied in turn to select smaller and smaller portions
6803 of the JSON structure.
6804 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6805 nunbered array element is selected.
6806 Otherwise it must apply to a JSON object; the named element is selected.
6807 The final resulting element can be a simple JSON type or a JSON object
6808 or array; for the latter two a string-representation os the JSON
6809 is returned.
6810 For elements of type string, the returned value is de-quoted.
6811 .next
6812 .cindex "linear search"
6813 .cindex "lookup" "lsearch"
6814 .cindex "lsearch lookup type"
6815 .cindex "case sensitivity" "in lsearch lookup"
6816 &(lsearch)&: The given file is a text file that is searched linearly for a
6817 line beginning with the search key, terminated by a colon or white space or the
6818 end of the line. The search is case-insensitive; that is, upper and lower case
6819 letters are treated as the same. The first occurrence of the key that is found
6820 in the file is used.
6821
6822 White space between the key and the colon is permitted. The remainder of the
6823 line, with leading and trailing white space removed, is the data. This can be
6824 continued onto subsequent lines by starting them with any amount of white
6825 space, but only a single space character is included in the data at such a
6826 junction. If the data begins with a colon, the key must be terminated by a
6827 colon, for example:
6828 .code
6829 baduser:  :fail:
6830 .endd
6831 Empty lines and lines beginning with # are ignored, even if they occur in the
6832 middle of an item. This is the traditional textual format of alias files. Note
6833 that the keys in an &(lsearch)& file are literal strings. There is no
6834 wildcarding of any kind.
6835
6836 .cindex "lookup" "lsearch &-- colons in keys"
6837 .cindex "white space" "in lsearch key"
6838 In most &(lsearch)& files, keys are not required to contain colons or #
6839 characters, or white space. However, if you need this feature, it is available.
6840 If a key begins with a doublequote character, it is terminated only by a
6841 matching quote (or end of line), and the normal escaping rules apply to its
6842 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6843 quoted keys (exactly as for unquoted keys). There is no special handling of
6844 quotes for the data part of an &(lsearch)& line.
6845
6846 .next
6847 .cindex "NIS lookup type"
6848 .cindex "lookup" "NIS"
6849 .cindex "binary zero" "in lookup key"
6850 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6851 the given key, without a terminating binary zero. There is a variant called
6852 &(nis0)& which does include the terminating binary zero in the key. This is
6853 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6854 aliases; the full map names must be used.
6855
6856 .next
6857 .cindex "wildlsearch lookup type"
6858 .cindex "lookup" "wildlsearch"
6859 .cindex "nwildlsearch lookup type"
6860 .cindex "lookup" "nwildlsearch"
6861 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6862 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6863 the file may be wildcarded. The difference between these two lookup types is
6864 that for &(wildlsearch)&, each key in the file is string-expanded before being
6865 used, whereas for &(nwildlsearch)&, no expansion takes place.
6866
6867 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6868 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6869 file that are regular expressions can be made case-sensitive by the use of
6870 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6871
6872 . ==== As this is a nested list, any displays it contains must be indented
6873 . ==== as otherwise they are too far to the left.
6874
6875 .olist
6876 The string may begin with an asterisk to mean &"ends with"&. For example:
6877 .code
6878     *.a.b.c       data for anything.a.b.c
6879     *fish         data for anythingfish
6880 .endd
6881 .next
6882 The string may begin with a circumflex to indicate a regular expression. For
6883 example, for &(wildlsearch)&:
6884 .code
6885     ^\N\d+\.a\.b\N    data for <digits>.a.b
6886 .endd
6887 Note the use of &`\N`& to disable expansion of the contents of the regular
6888 expression. If you are using &(nwildlsearch)&, where the keys are not
6889 string-expanded, the equivalent entry is:
6890 .code
6891     ^\d+\.a\.b        data for <digits>.a.b
6892 .endd
6893 The case-insensitive flag is set at the start of compiling the regular
6894 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6895 For example, to make the entire pattern case-sensitive:
6896 .code
6897     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6898 .endd
6899
6900 If the regular expression contains white space or colon characters, you must
6901 either quote it (see &(lsearch)& above), or represent these characters in other
6902 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6903 colon. This may be easier than quoting, because if you quote, you have to
6904 escape all the backslashes inside the quotes.
6905
6906 &*Note*&: It is not possible to capture substrings in a regular expression
6907 match for later use, because the results of all lookups are cached. If a lookup
6908 is repeated, the result is taken from the cache, and no actual pattern matching
6909 takes place. The values of all the numeric variables are unset after a
6910 &((n)wildlsearch)& match.
6911
6912 .next
6913 Although I cannot see it being of much use, the general matching function that
6914 is used to implement &((n)wildlsearch)& means that the string may begin with a
6915 lookup name terminated by a semicolon, and followed by lookup data. For
6916 example:
6917 .code
6918     cdb;/some/file  data for keys that match the file
6919 .endd
6920 The data that is obtained from the nested lookup is discarded.
6921 .endlist olist
6922
6923 Keys that do not match any of these patterns are interpreted literally. The
6924 continuation rules for the data are the same as for &(lsearch)&, and keys may
6925 be followed by optional colons.
6926
6927 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6928 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6929 lookup types support only literal keys.
6930
6931 .next
6932 .cindex "lookup" "spf"
6933 If Exim is built with SPF support, manual lookups can be done
6934 (as opposed to the standard ACL condition method.
6935 For details see section &<<SECSPF>>&.
6936 .endlist ilist
6937
6938
6939 .section "Query-style lookup types" "SECTquerystylelookups"
6940 .cindex "lookup" "query-style types"
6941 .cindex "query-style lookup" "list of types"
6942 The supported query-style lookup types are listed below. Further details about
6943 many of them are given in later sections.
6944
6945 .ilist
6946 .cindex "DNS" "as a lookup type"
6947 .cindex "lookup" "DNS"
6948 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6949 are given in the supplied query. The resulting data is the contents of the
6950 records. See section &<<SECTdnsdb>>&.
6951 .next
6952 .cindex "InterBase lookup type"
6953 .cindex "lookup" "InterBase"
6954 &(ibase)&: This does a lookup in an InterBase database.
6955 .next
6956 .cindex "LDAP" "lookup type"
6957 .cindex "lookup" "LDAP"
6958 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6959 returns attributes from a single entry. There is a variant called &(ldapm)&
6960 that permits values from multiple entries to be returned. A third variant
6961 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6962 any attribute values. See section &<<SECTldap>>&.
6963 .next
6964 .cindex "MySQL" "lookup type"
6965 .cindex "lookup" "MySQL"
6966 &(mysql)&: The format of the query is an SQL statement that is passed to a
6967 MySQL database. See section &<<SECTsql>>&.
6968 .next
6969 .cindex "NIS+ lookup type"
6970 .cindex "lookup" "NIS+"
6971 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6972 the field to be returned. See section &<<SECTnisplus>>&.
6973 .next
6974 .cindex "Oracle" "lookup type"
6975 .cindex "lookup" "Oracle"
6976 &(oracle)&: The format of the query is an SQL statement that is passed to an
6977 Oracle database. See section &<<SECTsql>>&.
6978 .next
6979 .cindex "lookup" "passwd"
6980 .cindex "passwd lookup type"
6981 .cindex "&_/etc/passwd_&"
6982 &(passwd)& is a query-style lookup with queries that are just user names. The
6983 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6984 success, the result string is the same as you would get from an &(lsearch)&
6985 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6986 password value. For example:
6987 .code
6988 *:42:42:King Rat:/home/kr:/bin/bash
6989 .endd
6990 .next
6991 .cindex "PostgreSQL lookup type"
6992 .cindex "lookup" "PostgreSQL"
6993 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6994 PostgreSQL database. See section &<<SECTsql>>&.
6995
6996 .next
6997 .cindex "Redis lookup type"
6998 .cindex lookup Redis
6999 &(redis)&: The format of the query is either a simple get or simple set,
7000 passed to a Redis database. See section &<<SECTsql>>&.
7001
7002 .next
7003 .cindex "sqlite lookup type"
7004 .cindex "lookup" "sqlite"
7005 &(sqlite)&: The format of the query is a filename followed by an SQL statement
7006 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7007
7008 .next
7009 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7010 not likely to be useful in normal operation.
7011 .next
7012 .cindex "whoson lookup type"
7013 .cindex "lookup" "whoson"
7014 . --- still http:-only, 2018-09-07
7015 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7016 allows a server to check whether a particular (dynamically allocated) IP
7017 address is currently allocated to a known (trusted) user and, optionally, to
7018 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7019 at one time for &"POP before SMTP"& authentication, but that approach has been
7020 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7021 &"POP before SMTP"& checking using ACL statements such as
7022 .code
7023 require condition = \
7024   ${lookup whoson {$sender_host_address}{yes}{no}}
7025 .endd
7026 The query consists of a single IP address. The value returned is the name of
7027 the authenticated user, which is stored in the variable &$value$&. However, in
7028 this example, the data in &$value$& is not used; the result of the lookup is
7029 one of the fixed strings &"yes"& or &"no"&.
7030 .endlist
7031
7032
7033
7034 .section "Temporary errors in lookups" "SECID63"
7035 .cindex "lookup" "temporary error in"
7036 Lookup functions can return temporary error codes if the lookup cannot be
7037 completed. For example, an SQL or LDAP database might be unavailable. For this
7038 reason, it is not advisable to use a lookup that might do this for critical
7039 options such as a list of local domains.
7040
7041 When a lookup cannot be completed in a router or transport, delivery
7042 of the message (to the relevant address) is deferred, as for any other
7043 temporary error. In other circumstances Exim may assume the lookup has failed,
7044 or may give up altogether.
7045
7046
7047
7048 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7049 .cindex "wildcard lookups"
7050 .cindex "lookup" "default values"
7051 .cindex "lookup" "wildcard"
7052 .cindex "lookup" "* added to type"
7053 .cindex "default" "in single-key lookups"
7054 In this context, a &"default value"& is a value specified by the administrator
7055 that is to be used if a lookup fails.
7056
7057 &*Note:*& This section applies only to single-key lookups. For query-style
7058 lookups, the facilities of the query language must be used. An attempt to
7059 specify a default for a query-style lookup provokes an error.
7060
7061 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7062 and the initial lookup fails, the key &"*"& is looked up in the file to
7063 provide a default value. See also the section on partial matching below.
7064
7065 .cindex "*@ with single-key lookup"
7066 .cindex "lookup" "*@ added to type"
7067 .cindex "alias file" "per-domain default"
7068 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7069 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7070 character, a second lookup is done with everything before the last @ replaced
7071 by *. This makes it possible to provide per-domain defaults in alias files
7072 that include the domains in the keys. If the second lookup fails (or doesn't
7073 take place because there is no @ in the key), &"*"& is looked up.
7074 For example, a &(redirect)& router might contain:
7075 .code
7076 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7077 .endd
7078 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7079 looks up these keys, in this order:
7080 .code
7081 jane@eyre.example
7082 *@eyre.example
7083 *
7084 .endd
7085 The data is taken from whichever key it finds first. &*Note*&: In an
7086 &(lsearch)& file, this does not mean the first of these keys in the file. A
7087 complete scan is done for each key, and only if it is not found at all does
7088 Exim move on to try the next key.
7089
7090
7091
7092 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7093 .cindex "partial matching"
7094 .cindex "wildcard lookups"
7095 .cindex "lookup" "partial matching"
7096 .cindex "lookup" "wildcard"
7097 .cindex "asterisk" "in search type"
7098 The normal operation of a single-key lookup is to search the file for an exact
7099 match with the given key. However, in a number of situations where domains are
7100 being looked up, it is useful to be able to do partial matching. In this case,
7101 information in the file that has a key starting with &"*."& is matched by any
7102 domain that ends with the components that follow the full stop. For example, if
7103 a key in a DBM file is
7104 .code
7105 *.dates.fict.example
7106 .endd
7107 then when partial matching is enabled this is matched by (amongst others)
7108 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7109 by &'dates.fict.example'&, if that does not appear as a separate key in the
7110 file.
7111
7112 &*Note*&: Partial matching is not available for query-style lookups. It is
7113 also not available for any lookup items in address lists (see section
7114 &<<SECTaddresslist>>&).
7115
7116 Partial matching is implemented by doing a series of separate lookups using
7117 keys constructed by modifying the original subject key. This means that it can
7118 be used with any of the single-key lookup types, provided that
7119 partial matching keys
7120 beginning with a special prefix (default &"*."&) are included in the data file.
7121 Keys in the file that do not begin with the prefix are matched only by
7122 unmodified subject keys when partial matching is in use.
7123
7124 Partial matching is requested by adding the string &"partial-"& to the front of
7125 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7126 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7127 is added at the start of the subject key, and it is looked up again. If that
7128 fails, further lookups are tried with dot-separated components removed from the
7129 start of the subject key, one-by-one, and &"*."& added on the front of what
7130 remains.
7131
7132 A minimum number of two non-* components are required. This can be adjusted
7133 by including a number before the hyphen in the search type. For example,
7134 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7135 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7136 subject key is &'2250.dates.fict.example'& then the following keys are looked
7137 up when the minimum number of non-* components is two:
7138 .code
7139 2250.dates.fict.example
7140 *.2250.dates.fict.example
7141 *.dates.fict.example
7142 *.fict.example
7143 .endd
7144 As soon as one key in the sequence is successfully looked up, the lookup
7145 finishes.
7146
7147 .cindex "lookup" "partial matching &-- changing prefix"
7148 .cindex "prefix" "for partial matching"
7149 The use of &"*."& as the partial matching prefix is a default that can be
7150 changed. The motivation for this feature is to allow Exim to operate with file
7151 formats that are used by other MTAs. A different prefix can be supplied in
7152 parentheses instead of the hyphen after &"partial"&. For example:
7153 .code
7154 domains = partial(.)lsearch;/some/file
7155 .endd
7156 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7157 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7158 components is unchanged). The prefix may consist of any punctuation characters
7159 other than a closing parenthesis. It may be empty, for example:
7160 .code
7161 domains = partial1()cdb;/some/file
7162 .endd
7163 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7164 &`a.b.c`&, &`b.c`&, and &`c`&.
7165
7166 If &"partial0"& is specified, what happens at the end (when the lookup with
7167 just one non-wild component has failed, and the original key is shortened right
7168 down to the null string) depends on the prefix:
7169
7170 .ilist
7171 If the prefix has zero length, the whole lookup fails.
7172 .next
7173 If the prefix has length 1, a lookup for just the prefix is done. For
7174 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7175 .next
7176 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7177 remainder is looked up. With the default prefix, therefore, the final lookup is
7178 for &"*"& on its own.
7179 .next
7180 Otherwise, the whole prefix is looked up.
7181 .endlist
7182
7183
7184 If the search type ends in &"*"& or &"*@"& (see section
7185 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7186 this implies happens after all partial lookups have failed. If &"partial0"& is
7187 specified, adding &"*"& to the search type has no effect with the default
7188 prefix, because the &"*"& key is already included in the sequence of partial
7189 lookups. However, there might be a use for lookup types such as
7190 &"partial0(.)lsearch*"&.
7191
7192 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7193 in domain lists and the like. Partial matching works only in terms of
7194 dot-separated components; a key such as &`*fict.example`&
7195 in a database file is useless, because the asterisk in a partial matching
7196 subject key is always followed by a dot.
7197
7198
7199
7200
7201 .section "Lookup caching" "SECID64"
7202 .cindex "lookup" "caching"
7203 .cindex "caching" "lookup data"
7204 Exim caches all lookup results in order to avoid needless repetition of
7205 lookups. However, because (apart from the daemon) Exim operates as a collection
7206 of independent, short-lived processes, this caching applies only within a
7207 single Exim process. There is no inter-process lookup caching facility.
7208
7209 For single-key lookups, Exim keeps the relevant files open in case there is
7210 another lookup that needs them. In some types of configuration this can lead to
7211 many files being kept open for messages with many recipients. To avoid hitting
7212 the operating system limit on the number of simultaneously open files, Exim
7213 closes the least recently used file when it needs to open more files than its
7214 own internal limit, which can be changed via the &%lookup_open_max%& option.
7215
7216 The single-key lookup files are closed and the lookup caches are flushed at
7217 strategic points during delivery &-- for example, after all routing is
7218 complete.
7219
7220
7221
7222
7223 .section "Quoting lookup data" "SECID65"
7224 .cindex "lookup" "quoting"
7225 .cindex "quoting" "in lookups"
7226 When data from an incoming message is included in a query-style lookup, there
7227 is the possibility of special characters in the data messing up the syntax of
7228 the query. For example, a NIS+ query that contains
7229 .code
7230 [name=$local_part]
7231 .endd
7232 will be broken if the local part happens to contain a closing square bracket.
7233 For NIS+, data can be enclosed in double quotes like this:
7234 .code
7235 [name="$local_part"]
7236 .endd
7237 but this still leaves the problem of a double quote in the data. The rule for
7238 NIS+ is that double quotes must be doubled. Other lookup types have different
7239 rules, and to cope with the differing requirements, an expansion operator
7240 of the following form is provided:
7241 .code
7242 ${quote_<lookup-type>:<string>}
7243 .endd
7244 For example, the safest way to write the NIS+ query is
7245 .code
7246 [name="${quote_nisplus:$local_part}"]
7247 .endd
7248 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7249 operator can be used for all lookup types, but has no effect for single-key
7250 lookups, since no quoting is ever needed in their key strings.
7251
7252
7253
7254
7255 .section "More about dnsdb" "SECTdnsdb"
7256 .cindex "dnsdb lookup"
7257 .cindex "lookup" "dnsdb"
7258 .cindex "DNS" "as a lookup type"
7259 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7260 of a record type and a domain name, separated by an equals sign. For example,
7261 an expansion string could contain:
7262 .code
7263 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7264 .endd
7265 If the lookup succeeds, the result is placed in &$value$&, which in this case
7266 is used on its own as the result. If the lookup does not succeed, the
7267 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7268 &<<SECTforexpfai>>& for an explanation of what this means.
7269
7270 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7271 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7272 If no type is given, TXT is assumed.
7273
7274 For any record type, if multiple records are found, the data is returned as a
7275 concatenation, with newline as the default separator. The order, of course,
7276 depends on the DNS resolver. You can specify a different separator character
7277 between multiple records by putting a right angle-bracket followed immediately
7278 by the new separator at the start of the query. For example:
7279 .code
7280 ${lookup dnsdb{>: a=host1.example}}
7281 .endd
7282 It is permitted to specify a space as the separator character. Further
7283 white space is ignored.
7284 For lookup types that return multiple fields per record,
7285 an alternate field separator can be specified using a comma after the main
7286 separator character, followed immediately by the field separator.
7287
7288 .cindex "PTR record" "in &(dnsdb)& lookup"
7289 When the type is PTR,
7290 the data can be an IP address, written as normal; inversion and the addition of
7291 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7292 .code
7293 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7294 .endd
7295 If the data for a PTR record is not a syntactically valid IP address, it is not
7296 altered and nothing is added.
7297
7298 .cindex "MX record" "in &(dnsdb)& lookup"
7299 .cindex "SRV record" "in &(dnsdb)& lookup"
7300 For an MX lookup, both the preference value and the host name are returned for
7301 each record, separated by a space. For an SRV lookup, the priority, weight,
7302 port, and host name are returned for each record, separated by spaces.
7303 The field separator can be modified as above.
7304
7305 .cindex "TXT record" "in &(dnsdb)& lookup"
7306 .cindex "SPF record" "in &(dnsdb)& lookup"
7307 For TXT records with multiple items of data, only the first item is returned,
7308 unless a field separator is specified.
7309 To concatenate items without a separator, use a semicolon instead.
7310 For SPF records the
7311 default behaviour is to concatenate multiple items without using a separator.
7312 .code
7313 ${lookup dnsdb{>\n,: txt=a.b.example}}
7314 ${lookup dnsdb{>\n; txt=a.b.example}}
7315 ${lookup dnsdb{spf=example.org}}
7316 .endd
7317 It is permitted to specify a space as the separator character. Further
7318 white space is ignored.
7319
7320 .cindex "SOA record" "in &(dnsdb)& lookup"
7321 For an SOA lookup, while no result is obtained the lookup is redone with
7322 successively more leading components dropped from the given domain.
7323 Only the primary-nameserver field is returned unless a field separator is
7324 specified.
7325 .code
7326 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7327 .endd
7328
7329 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7330 .cindex "dnsdb modifiers"
7331 .cindex "modifiers" "dnsdb"
7332 .cindex "options" "dnsdb"
7333 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7334 each followed by a comma,
7335 that may appear before the record type.
7336
7337 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7338 temporary DNS error for any of them, the behaviour is controlled by
7339 a defer-option modifier.
7340 The possible keywords are
7341 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7342 With &"strict"& behaviour, any temporary DNS error causes the
7343 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7344 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7345 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7346 error causes the whole lookup to defer only if none of the other lookups
7347 succeed. The default is &"lax"&, so the following lookups are equivalent:
7348 .code
7349 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7350 ${lookup dnsdb{a=one.host.com:two.host.com}}
7351 .endd
7352 Thus, in the default case, as long as at least one of the DNS lookups
7353 yields some data, the lookup succeeds.
7354
7355 .cindex "DNSSEC" "dns lookup"
7356 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7357 The possible keywords are
7358 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7359 With &"strict"& or &"lax"& DNSSEC information is requested
7360 with the lookup.
7361 With &"strict"& a response from the DNS resolver that
7362 is not labelled as authenticated data
7363 is treated as equivalent to a temporary DNS error.
7364 The default is &"lax"&.
7365
7366 See also the &$lookup_dnssec_authenticated$& variable.
7367
7368 .cindex timeout "dns lookup"
7369 .cindex "DNS" timeout
7370 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7371 The form is &"retrans_VAL"& where VAL is an Exim time specification
7372 (e.g. &"5s"&).
7373 The default value is set by the main configuration option &%dns_retrans%&.
7374
7375 Retries for the dnsdb lookup can be controlled by a retry modifier.
7376 The form if &"retry_VAL"& where VAL is an integer.
7377 The default count is set by the main configuration option &%dns_retry%&.
7378
7379 .cindex caching "of dns lookup"
7380 .cindex TTL "of dns lookup"
7381 .cindex DNS TTL
7382 Dnsdb lookup results are cached within a single process (and its children).
7383 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7384 value of the set of returned DNS records.
7385
7386
7387 .section "Pseudo dnsdb record types" "SECID66"
7388 .cindex "MX record" "in &(dnsdb)& lookup"
7389 By default, both the preference value and the host name are returned for
7390 each MX record, separated by a space. If you want only host names, you can use
7391 the pseudo-type MXH:
7392 .code
7393 ${lookup dnsdb{mxh=a.b.example}}
7394 .endd
7395 In this case, the preference values are omitted, and just the host names are
7396 returned.
7397
7398 .cindex "name server for enclosing domain"
7399 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7400 records on the given domain, but if none are found, it removes the first
7401 component of the domain name, and tries again. This process continues until NS
7402 records are found or there are no more components left (or there is a DNS
7403 error). In other words, it may return the name servers for a top-level domain,
7404 but it never returns the root name servers. If there are no NS records for the
7405 top-level domain, the lookup fails. Consider these examples:
7406 .code
7407 ${lookup dnsdb{zns=xxx.quercite.com}}
7408 ${lookup dnsdb{zns=xxx.edu}}
7409 .endd
7410 Assuming that in each case there are no NS records for the full domain name,
7411 the first returns the name servers for &%quercite.com%&, and the second returns
7412 the name servers for &%edu%&.
7413
7414 You should be careful about how you use this lookup because, unless the
7415 top-level domain does not exist, the lookup always returns some host names. The
7416 sort of use to which this might be put is for seeing if the name servers for a
7417 given domain are on a blacklist. You can probably assume that the name servers
7418 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7419 such a list.
7420
7421 .cindex "CSA" "in &(dnsdb)& lookup"
7422 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7423 records according to the CSA rules, which are described in section
7424 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7425 not sufficient because of the extra parent domain search behaviour of CSA. The
7426 result of a successful lookup such as:
7427 .code
7428 ${lookup dnsdb {csa=$sender_helo_name}}
7429 .endd
7430 has two space-separated fields: an authorization code and a target host name.
7431 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7432 authorization required but absent, or &"?"& for unknown.
7433
7434 .cindex "A+" "in &(dnsdb)& lookup"
7435 The pseudo-type A+ performs an AAAA
7436 and then an A lookup.  All results are returned; defer processing
7437 (see below) is handled separately for each lookup.  Example:
7438 .code
7439 ${lookup dnsdb {>; a+=$sender_helo_name}}
7440 .endd
7441
7442
7443 .section "Multiple dnsdb lookups" "SECID67"
7444 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7445 However, you can specify a list of domains or IP addresses in a single
7446 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7447 the default separator, but with the ability to change this. For example:
7448 .code
7449 ${lookup dnsdb{one.domain.com:two.domain.com}}
7450 ${lookup dnsdb{a=one.host.com:two.host.com}}
7451 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7452 .endd
7453 In order to retain backwards compatibility, there is one special case: if
7454 the lookup type is PTR and no change of separator is specified, Exim looks
7455 to see if the rest of the string is precisely one IPv6 address. In this
7456 case, it does not treat it as a list.
7457
7458 The data from each lookup is concatenated, with newline separators by default,
7459 in the same way that multiple DNS records for a single item are handled. A
7460 different separator can be specified, as described above.
7461
7462
7463
7464
7465 .section "More about LDAP" "SECTldap"
7466 .cindex "LDAP" "lookup, more about"
7467 .cindex "lookup" "LDAP"
7468 .cindex "Solaris" "LDAP"
7469 The original LDAP implementation came from the University of Michigan; this has
7470 become &"Open LDAP"&, and there are now two different releases. Another
7471 implementation comes from Netscape, and Solaris 7 and subsequent releases
7472 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7473 the lookup function level, their error handling is different. For this reason
7474 it is necessary to set a compile-time variable when building Exim with LDAP, to
7475 indicate which LDAP library is in use. One of the following should appear in
7476 your &_Local/Makefile_&:
7477 .code
7478 LDAP_LIB_TYPE=UMICHIGAN
7479 LDAP_LIB_TYPE=OPENLDAP1
7480 LDAP_LIB_TYPE=OPENLDAP2
7481 LDAP_LIB_TYPE=NETSCAPE
7482 LDAP_LIB_TYPE=SOLARIS
7483 .endd
7484 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7485 same interface as the University of Michigan version.
7486
7487 There are three LDAP lookup types in Exim. These behave slightly differently in
7488 the way they handle the results of a query:
7489
7490 .ilist
7491 &(ldap)& requires the result to contain just one entry; if there are more, it
7492 gives an error.
7493 .next
7494 &(ldapdn)& also requires the result to contain just one entry, but it is the
7495 Distinguished Name that is returned rather than any attribute values.
7496 .next
7497 &(ldapm)& permits the result to contain more than one entry; the attributes
7498 from all of them are returned.
7499 .endlist
7500
7501
7502 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7503 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7504 the data returned by a successful lookup is described in the next section.
7505 First we explain how LDAP queries are coded.
7506
7507
7508 .section "Format of LDAP queries" "SECTforldaque"
7509 .cindex "LDAP" "query format"
7510 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7511 the configuration of a &(redirect)& router one might have this setting:
7512 .code
7513 data = ${lookup ldap \
7514   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7515   c=UK?mailbox?base?}}
7516 .endd
7517 .cindex "LDAP" "with TLS"
7518 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7519 secure (encrypted) LDAP connections. The second of these ensures that an
7520 encrypted TLS connection is used.
7521
7522 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7523 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7524 See the &%ldap_start_tls%& option.
7525
7526 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7527 controlled. Every part of the TLS configuration can be configured by settings in
7528 &_exim.conf_&. Depending on the version of the client libraries installed on
7529 your system, some of the initialization may have required setting options in
7530 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7531 certificates. This revealed a nuance where the current UID that exim was
7532 running as could affect which config files it read. With Exim 4.83, these
7533 methods become optional, only taking effect if not specifically set in
7534 &_exim.conf_&.
7535
7536
7537 .section "LDAP quoting" "SECID68"
7538 .cindex "LDAP" "quoting"
7539 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7540 and the second because the LDAP query is represented as a URL. Furthermore,
7541 within an LDAP query, two different kinds of quoting are required. For this
7542 reason, there are two different LDAP-specific quoting operators.
7543
7544 The &%quote_ldap%& operator is designed for use on strings that are part of
7545 filter specifications. Conceptually, it first does the following conversions on
7546 the string:
7547 .code
7548 *   =>   \2A
7549 (   =>   \28
7550 )   =>   \29
7551 \   =>   \5C
7552 .endd
7553 in accordance with RFC 2254. The resulting string is then quoted according
7554 to the rules for URLs, that is, all non-alphanumeric characters except
7555 .code
7556 ! $ ' - . _ ( ) * +
7557 .endd
7558 are converted to their hex values, preceded by a percent sign. For example:
7559 .code
7560 ${quote_ldap: a(bc)*, a<yz>; }
7561 .endd
7562 yields
7563 .code
7564 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7565 .endd
7566 Removing the URL quoting, this is (with a leading and a trailing space):
7567 .code
7568 a\28bc\29\2A, a<yz>;
7569 .endd
7570 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7571 base DN specifications in queries. Conceptually, it first converts the string
7572 by inserting a backslash in front of any of the following characters:
7573 .code
7574 , + " \ < > ;
7575 .endd
7576 It also inserts a backslash before any leading spaces or # characters, and
7577 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7578 is then quoted according to the rules for URLs. For example:
7579 .code
7580 ${quote_ldap_dn: a(bc)*, a<yz>; }
7581 .endd
7582 yields
7583 .code
7584 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7585 .endd
7586 Removing the URL quoting, this is (with a trailing space):
7587 .code
7588 \ a(bc)*\, a\<yz\>\;\
7589 .endd
7590 There are some further comments about quoting in the section on LDAP
7591 authentication below.
7592
7593
7594 .section "LDAP connections" "SECID69"
7595 .cindex "LDAP" "connections"
7596 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7597 is in use, via a Unix domain socket. The example given above does not specify
7598 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7599 by starting it with
7600 .code
7601 ldap://<hostname>:<port>/...
7602 .endd
7603 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7604 used. When no server is specified in a query, a list of default servers is
7605 taken from the &%ldap_default_servers%& configuration option. This supplies a
7606 colon-separated list of servers which are tried in turn until one successfully
7607 handles a query, or there is a serious error. Successful handling either
7608 returns the requested data, or indicates that it does not exist. Serious errors
7609 are syntactical, or multiple values when only a single value is expected.
7610 Errors which cause the next server to be tried are connection failures, bind
7611 failures, and timeouts.
7612
7613 For each server name in the list, a port number can be given. The standard way
7614 of specifying a host and port is to use a colon separator (RFC 1738). Because
7615 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7616 doubled. For example
7617 .code
7618 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7619 .endd
7620 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7621 to the LDAP library with no server name, and the library's default (normally
7622 the local host) is used.
7623
7624 If you are using the OpenLDAP library, you can connect to an LDAP server using
7625 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7626 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7627 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7628 not available.
7629
7630 For this type of connection, instead of a host name for the server, a pathname
7631 for the socket is required, and the port number is not relevant. The pathname
7632 can be specified either as an item in &%ldap_default_servers%&, or inline in
7633 the query. In the former case, you can have settings such as
7634 .code
7635 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7636 .endd
7637 When the pathname is given in the query, you have to escape the slashes as
7638 &`%2F`& to fit in with the LDAP URL syntax. For example:
7639 .code
7640 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7641 .endd
7642 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7643 a pathname, it uses the Unix domain socket code, even if the query actually
7644 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7645 socket connection. This behaviour means that you can use a setting of
7646 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7647 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7648 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7649 backup host.
7650
7651 If an explicit &`ldapi`& type is given in a query when a host name is
7652 specified, an error is diagnosed. However, if there are more items in
7653 &%ldap_default_servers%&, they are tried. In other words:
7654
7655 .ilist
7656 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7657 interface.
7658 .next
7659 Using &`ldapi`& with a host name causes an error.
7660 .endlist
7661
7662
7663 Using &`ldapi`& with no host or path in the query, and no setting of
7664 &%ldap_default_servers%&, does whatever the library does by default.
7665
7666
7667
7668 .section "LDAP authentication and control information" "SECID70"
7669 .cindex "LDAP" "authentication"
7670 The LDAP URL syntax provides no way of passing authentication and other control
7671 information to the server. To make this possible, the URL in an LDAP query may
7672 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7673 spaces. If a value contains spaces it must be enclosed in double quotes, and
7674 when double quotes are used, backslash is interpreted in the usual way inside
7675 them. The following names are recognized:
7676 .display
7677 &`DEREFERENCE`&  set the dereferencing parameter
7678 &`NETTIME    `&  set a timeout for a network operation
7679 &`USER       `&  set the DN, for authenticating the LDAP bind
7680 &`PASS       `&  set the password, likewise
7681 &`REFERRALS  `&  set the referrals parameter
7682 &`SERVERS    `&  set alternate server list for this query only
7683 &`SIZE       `&  set the limit for the number of entries returned
7684 &`TIME       `&  set the maximum waiting time for a query
7685 .endd
7686 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7687 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7688 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7689 library from trying to follow referrals issued by the LDAP server.
7690
7691 .cindex LDAP timeout
7692 .cindex timeout "LDAP lookup"
7693 The name CONNECT is an obsolete name for NETTIME, retained for
7694 backwards compatibility. This timeout (specified as a number of seconds) is
7695 enforced from the client end for operations that can be carried out over a
7696 network. Specifically, it applies to network connections and calls to the
7697 &'ldap_result()'& function. If the value is greater than zero, it is used if
7698 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7699 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7700 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7701 Netscape SDK; for OpenLDAP no action is taken.
7702
7703 The TIME parameter (also a number of seconds) is passed to the server to
7704 set a server-side limit on the time taken to complete a search.
7705
7706 The SERVERS parameter allows you to specify an alternate list of ldap servers
7707 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7708 default list of ldap servers, and a single lookup can specify a single ldap
7709 server to use.  But when you need to do a lookup with a list of servers that is
7710 different than the default list (maybe different order, maybe a completely
7711 different set of servers), the SERVERS parameter allows you to specify this
7712 alternate list (colon-separated).
7713
7714 Here is an example of an LDAP query in an Exim lookup that uses some of these
7715 values. This is a single line, folded to fit on the page:
7716 .code
7717 ${lookup ldap
7718   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7719   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7720   {$value}fail}
7721 .endd
7722 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7723 any of the auxiliary data. Exim configuration settings that include lookups
7724 which contain password information should be preceded by &"hide"& to prevent
7725 non-admin users from using the &%-bP%& option to see their values.
7726
7727 The auxiliary data items may be given in any order. The default is no
7728 connection timeout (the system timeout is used), no user or password, no limit
7729 on the number of entries returned, and no time limit on queries.
7730
7731 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7732 removes any URL quoting that it may contain before passing it LDAP. Apparently
7733 some libraries do this for themselves, but some do not. Removing the URL
7734 quoting has two advantages:
7735
7736 .ilist
7737 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7738 DNs as with DNs inside actual queries.
7739 .next
7740 It permits spaces inside USER= DNs.
7741 .endlist
7742
7743 For example, a setting such as
7744 .code
7745 USER=cn=${quote_ldap_dn:$1}
7746 .endd
7747 should work even if &$1$& contains spaces.
7748
7749 Expanded data for the PASS= value should be quoted using the &%quote%&
7750 expansion operator, rather than the LDAP quote operators. The only reason this
7751 field needs quoting is to ensure that it conforms to the Exim syntax, which
7752 does not allow unquoted spaces. For example:
7753 .code
7754 PASS=${quote:$3}
7755 .endd
7756 The LDAP authentication mechanism can be used to check passwords as part of
7757 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7758 &<<CHAPexpand>>&.
7759
7760
7761
7762 .section "Format of data returned by LDAP" "SECID71"
7763 .cindex "LDAP" "returned data formats"
7764 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7765 as a sequence of values, for example
7766 .code
7767 cn=manager,o=University of Cambridge,c=UK
7768 .endd
7769 The &(ldap)& lookup type generates an error if more than one entry matches the
7770 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7771 the result between the data from different entries. It is possible for multiple
7772 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7773 you know that whatever values are returned all came from a single entry in the
7774 directory.
7775
7776 In the common case where you specify a single attribute in your LDAP query, the
7777 result is not quoted, and does not contain the attribute name. If the attribute
7778 has multiple values, they are separated by commas. Any comma that is
7779 part of an attribute's value is doubled.
7780
7781 If you specify multiple attributes, the result contains space-separated, quoted
7782 strings, each preceded by the attribute name and an equals sign. Within the
7783 quotes, the quote character, backslash, and newline are escaped with
7784 backslashes, and commas are used to separate multiple values for the attribute.
7785 Any commas in attribute values are doubled
7786 (permitting treatment of the values as a comma-separated list).
7787 Apart from the escaping, the string within quotes takes the same form as the
7788 output when a single attribute is requested. Specifying no attributes is the
7789 same as specifying all of an entry's attributes.
7790
7791 Here are some examples of the output format. The first line of each pair is an
7792 LDAP query, and the second is the data that is returned. The attribute called
7793 &%attr1%& has two values, one of them with an embedded comma, whereas
7794 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7795 (they have SUP &%attr%& in their schema definitions).
7796
7797 .code
7798 ldap:///o=base?attr1?sub?(uid=fred)
7799 value1.1,value1,,2
7800
7801 ldap:///o=base?attr2?sub?(uid=fred)
7802 value two
7803
7804 ldap:///o=base?attr?sub?(uid=fred)
7805 value1.1,value1,,2,value two
7806
7807 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7808 attr1="value1.1,value1,,2" attr2="value two"
7809
7810 ldap:///o=base??sub?(uid=fred)
7811 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7812 .endd
7813 You can
7814 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7815 results of LDAP lookups.
7816 The &%extract%& operator in string expansions can be used to pick out
7817 individual fields from data that consists of &'key'&=&'value'& pairs.
7818 The &%listextract%& operator should be used to pick out individual values
7819 of attributes, even when only a single value is expected.
7820 The doubling of embedded commas allows you to use the returned data as a
7821 comma separated list (using the "<," syntax for changing the input list separator).
7822
7823
7824
7825
7826 .section "More about NIS+" "SECTnisplus"
7827 .cindex "NIS+ lookup type"
7828 .cindex "lookup" "NIS+"
7829 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7830 and field name. If this is given, the result of a successful query is the
7831 contents of the named field; otherwise the result consists of a concatenation
7832 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7833 values containing spaces are quoted. For example, the query
7834 .code
7835 [name=mg1456],passwd.org_dir
7836 .endd
7837 might return the string
7838 .code
7839 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7840 home=/home/mg1456 shell=/bin/bash shadow=""
7841 .endd
7842 (split over two lines here to fit on the page), whereas
7843 .code
7844 [name=mg1456],passwd.org_dir:gcos
7845 .endd
7846 would just return
7847 .code
7848 Martin Guerre
7849 .endd
7850 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7851 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7852 operator is to double any quote characters within the text.
7853
7854
7855
7856 .section "SQL lookups" "SECTsql"
7857 .cindex "SQL lookup types"
7858 .cindex "MySQL" "lookup type"
7859 .cindex "PostgreSQL lookup type"
7860 .cindex "lookup" "MySQL"
7861 .cindex "lookup" "PostgreSQL"
7862 .cindex "Oracle" "lookup type"
7863 .cindex "lookup" "Oracle"
7864 .cindex "InterBase lookup type"
7865 .cindex "lookup" "InterBase"
7866 .cindex "Redis lookup type"
7867 .cindex lookup Redis
7868 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7869 and SQLite
7870 databases. Queries for these databases contain SQL statements, so an example
7871 might be
7872 .code
7873 ${lookup mysql{select mailbox from users where id='userx'}\
7874   {$value}fail}
7875 .endd
7876 If the result of the query contains more than one field, the data for each
7877 field in the row is returned, preceded by its name, so the result of
7878 .code
7879 ${lookup pgsql{select home,name from users where id='userx'}\
7880   {$value}}
7881 .endd
7882 might be
7883 .code
7884 home=/home/userx name="Mister X"
7885 .endd
7886 Empty values and values containing spaces are double quoted, with embedded
7887 quotes escaped by a backslash. If the result of the query contains just one
7888 field, the value is passed back verbatim, without a field name, for example:
7889 .code
7890 Mister X
7891 .endd
7892 If the result of the query yields more than one row, it is all concatenated,
7893 with a newline between the data for each row.
7894
7895
7896 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7897 .cindex "MySQL" "lookup type"
7898 .cindex "PostgreSQL lookup type"
7899 .cindex "lookup" "MySQL"
7900 .cindex "lookup" "PostgreSQL"
7901 .cindex "Oracle" "lookup type"
7902 .cindex "lookup" "Oracle"
7903 .cindex "InterBase lookup type"
7904 .cindex "lookup" "InterBase"
7905 .cindex "Redis lookup type"
7906 .cindex lookup Redis
7907 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7908 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7909 or &%redis_servers%&
7910 option (as appropriate) must be set to a colon-separated list of server
7911 information.
7912 (For MySQL and PostgreSQL, the global option need not be set if all
7913 queries contain their own server information &-- see section
7914 &<<SECTspeserque>>&.)
7915 For all but Redis
7916 each item in the list is a slash-separated list of four
7917 items: host name, database name, user name, and password. In the case of
7918 Oracle, the host name field is used for the &"service name"&, and the database
7919 name field is not used and should be empty. For example:
7920 .code
7921 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7922 .endd
7923 Because password data is sensitive, you should always precede the setting with
7924 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7925 option. Here is an example where two MySQL servers are listed:
7926 .code
7927 hide mysql_servers = localhost/users/root/secret:\
7928                      otherhost/users/root/othersecret
7929 .endd
7930 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7931 because this is a colon-separated list, the colon has to be doubled. For each
7932 query, these parameter groups are tried in order until a connection is made and
7933 a query is successfully processed. The result of a query may be that no data is
7934 found, but that is still a successful query. In other words, the list of
7935 servers provides a backup facility, not a list of different places to look.
7936
7937 For Redis the global option need not be specified if all queries contain their
7938 own server information &-- see section &<<SECTspeserque>>&.
7939 If specified, the option must be set to a colon-separated list of server
7940 information.
7941 Each item in the list is a slash-separated list of three items:
7942 host, database number, and password.
7943 .olist
7944 The host is required and may be either an IPv4 address and optional
7945 port number (separated by a colon, which needs doubling due to the
7946 higher-level list), or a Unix socket pathname enclosed in parentheses
7947 .next
7948 The database number is optional; if present that number is selected in the backend
7949 .next
7950 The password is optional; if present it is used to authenticate to the backend
7951 .endlist
7952
7953 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7954 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7955 respectively, and the characters single-quote, double-quote, and backslash
7956 itself are escaped with backslashes.
7957
7958 The &%quote_redis%& expansion operator
7959 escapes whitespace and backslash characters with a backslash.
7960
7961 .section "Specifying the server in the query" "SECTspeserque"
7962 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7963 it is possible to specify a list of servers with an individual query. This is
7964 done by starting the query with
7965 .display
7966 &`servers=`&&'server1:server2:server3:...'&&`;`&
7967 .endd
7968 Each item in the list may take one of two forms:
7969 .olist
7970 If it contains no slashes it is assumed to be just a host name. The appropriate
7971 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7972 of the same name, and the remaining parameters (database, user, password) are
7973 taken from there.
7974 .next
7975 If it contains any slashes, it is taken as a complete parameter set.
7976 .endlist
7977 The list of servers is used in exactly the same way as the global list.
7978 Once a connection to a server has happened and a query has been
7979 successfully executed, processing of the lookup ceases.
7980
7981 This feature is intended for use in master/slave situations where updates
7982 are occurring and you want to update the master rather than a slave. If the
7983 master is in the list as a backup for reading, you might have a global setting
7984 like this:
7985 .code
7986 mysql_servers = slave1/db/name/pw:\
7987                 slave2/db/name/pw:\
7988                 master/db/name/pw
7989 .endd
7990 In an updating lookup, you could then write:
7991 .code
7992 ${lookup mysql{servers=master; UPDATE ...} }
7993 .endd
7994 That query would then be sent only to the master server. If, on the other hand,
7995 the master is not to be used for reading, and so is not present in the global
7996 option, you can still update it by a query of this form:
7997 .code
7998 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7999 .endd
8000
8001
8002 .section "Special MySQL features" "SECID73"
8003 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8004 causes a connection to the server on the local host by means of a Unix domain
8005 socket. An alternate socket can be specified in parentheses.
8006 An option group name for MySQL option files can be specified in square brackets;
8007 the default value is &"exim"&.
8008 The full syntax of each item in &%mysql_servers%& is:
8009 .display
8010 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8011   <&'database'&>/<&'user'&>/<&'password'&>
8012 .endd
8013 Any of the four sub-parts of the first field can be omitted. For normal use on
8014 the local host it can be left blank or set to just &"localhost"&.
8015
8016 No database need be supplied &-- but if it is absent here, it must be given in
8017 the queries.
8018
8019 If a MySQL query is issued that does not request any data (an insert, update,
8020 or delete command), the result of the lookup is the number of rows affected.
8021
8022 &*Warning*&: This can be misleading. If an update does not actually change
8023 anything (for example, setting a field to the value it already has), the result
8024 is zero because no rows are affected.
8025
8026
8027 .section "Special PostgreSQL features" "SECID74"
8028 PostgreSQL lookups can also use Unix domain socket connections to the database.
8029 This is usually faster and costs less CPU time than a TCP/IP connection.
8030 However it can be used only if the mail server runs on the same machine as the
8031 database server. A configuration line for PostgreSQL via Unix domain sockets
8032 looks like this:
8033 .code
8034 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8035 .endd
8036 In other words, instead of supplying a host name, a path to the socket is
8037 given. The path name is enclosed in parentheses so that its slashes aren't
8038 visually confused with the delimiters for the other server parameters.
8039
8040 If a PostgreSQL query is issued that does not request any data (an insert,
8041 update, or delete command), the result of the lookup is the number of rows
8042 affected.
8043
8044 .section "More about SQLite" "SECTsqlite"
8045 .cindex "lookup" "SQLite"
8046 .cindex "sqlite lookup type"
8047 SQLite is different to the other SQL lookups because a filename is required in
8048 addition to the SQL query. An SQLite database is a single file, and there is no
8049 daemon as in the other SQL databases. The interface to Exim requires the name
8050 of the file, as an absolute path, to be given at the start of the query. It is
8051 separated from the query by white space. This means that the path name cannot
8052 contain white space. Here is a lookup expansion example:
8053 .code
8054 ${lookup sqlite {/some/thing/sqlitedb \
8055   select name from aliases where id='userx';}}
8056 .endd
8057 In a list, the syntax is similar. For example:
8058 .code
8059 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8060    select * from relays where ip='$sender_host_address';
8061 .endd
8062 The only character affected by the &%quote_sqlite%& operator is a single
8063 quote, which it doubles.
8064
8065 .cindex timeout SQLite
8066 .cindex sqlite "lookup timeout"
8067 The SQLite library handles multiple simultaneous accesses to the database
8068 internally. Multiple readers are permitted, but only one process can
8069 update at once. Attempts to access the database while it is being updated
8070 are rejected after a timeout period, during which the SQLite library
8071 waits for the lock to be released. In Exim, the default timeout is set
8072 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8073 option.
8074
8075 .section "More about Redis" "SECTredis"
8076 .cindex "lookup" "Redis"
8077 .cindex "redis lookup type"
8078 Redis is a non-SQL database. Commands are simple get and set.
8079 Examples:
8080 .code
8081 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8082 ${lookup redis{get keyname}}
8083 .endd
8084
8085 As of release 4.91, "lightweight" support for Redis Cluster is available.
8086 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8087 of which must be reachable from the running exim instance. If the cluster has
8088 master/slave replication, the list must contain all the master and slave
8089 servers.
8090
8091 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8092 immediately follow the redirection but treats the response as a DEFER, moving on
8093 to the next server in the &%redis_servers%& list until the correct server is
8094 reached.
8095
8096 .ecindex IIDfidalo1
8097 .ecindex IIDfidalo2
8098
8099
8100 . ////////////////////////////////////////////////////////////////////////////
8101 . ////////////////////////////////////////////////////////////////////////////
8102
8103 .chapter "Domain, host, address, and local part lists" &&&
8104          "CHAPdomhosaddlists" &&&
8105          "Domain, host, and address lists"
8106 .scindex IIDdohoadli "lists of domains; hosts; etc."
8107 A number of Exim configuration options contain lists of domains, hosts,
8108 email addresses, or local parts. For example, the &%hold_domains%& option
8109 contains a list of domains whose delivery is currently suspended. These lists
8110 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8111 arguments to expansion conditions such as &%match_domain%&.
8112
8113 Each item in one of these lists is a pattern to be matched against a domain,
8114 host, email address, or local part, respectively. In the sections below, the
8115 different types of pattern for each case are described, but first we cover some
8116 general facilities that apply to all four kinds of list.
8117
8118 Note that other parts of Exim use a &'string list'& which does not
8119 support all the complexity available in
8120 domain, host, address and local part lists.
8121
8122
8123
8124 .section "Expansion of lists" "SECTlistexpand"
8125 .cindex "expansion" "of lists"
8126 Each list is expanded as a single string before it is used.
8127
8128 &'Exception: the router headers_remove option, where list-item
8129 splitting is done before string-expansion.'&
8130
8131 The result of
8132 expansion must be a list, possibly containing empty items, which is split up
8133 into separate items for matching. By default, colon is the separator character,
8134 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8135 &<<SECTempitelis>>& for details of the list syntax; the second of these
8136 discusses the way to specify empty list items.
8137
8138
8139 If the string expansion is forced to fail, Exim behaves as if the item it is
8140 testing (domain, host, address, or local part) is not in the list. Other
8141 expansion failures cause temporary errors.
8142
8143 If an item in a list is a regular expression, backslashes, dollars and possibly
8144 other special characters in the expression must be protected against
8145 misinterpretation by the string expander. The easiest way to do this is to use
8146 the &`\N`& expansion feature to indicate that the contents of the regular
8147 expression should not be expanded. For example, in an ACL you might have:
8148 .code
8149 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8150                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8151 .endd
8152 The first item is a regular expression that is protected from expansion by
8153 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8154 senders based on the receiving domain.
8155
8156
8157
8158
8159 .section "Negated items in lists" "SECID76"
8160 .cindex "list" "negation"
8161 .cindex "negation" "in lists"
8162 Items in a list may be positive or negative. Negative items are indicated by a
8163 leading exclamation mark, which may be followed by optional white space. A list
8164 defines a set of items (domains, etc). When Exim processes one of these lists,
8165 it is trying to find out whether a domain, host, address, or local part
8166 (respectively) is in the set that is defined by the list. It works like this:
8167
8168 The list is scanned from left to right. If a positive item is matched, the
8169 subject that is being checked is in the set; if a negative item is matched, the
8170 subject is not in the set. If the end of the list is reached without the
8171 subject having matched any of the patterns, it is in the set if the last item
8172 was a negative one, but not if it was a positive one. For example, the list in
8173 .code
8174 domainlist relay_to_domains = !a.b.c : *.b.c
8175 .endd
8176 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8177 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8178 list is positive. However, if the setting were
8179 .code
8180 domainlist relay_to_domains = !a.b.c
8181 .endd
8182 then all domains other than &'a.b.c'& would match because the last item in the
8183 list is negative. In other words, a list that ends with a negative item behaves
8184 as if it had an extra item &`:*`& on the end.
8185
8186 Another way of thinking about positive and negative items in lists is to read
8187 the connector as &"or"& after a positive item and as &"and"& after a negative
8188 item.
8189
8190
8191
8192 .section "File names in lists" "SECTfilnamlis"
8193 .cindex "list" "filename in"
8194 If an item in a domain, host, address, or local part list is an absolute
8195 filename (beginning with a slash character), each line of the file is read and
8196 processed as if it were an independent item in the list, except that further
8197 filenames are not allowed,
8198 and no expansion of the data from the file takes place.
8199 Empty lines in the file are ignored, and the file may also contain comment
8200 lines:
8201
8202 .ilist
8203 For domain and host lists, if a # character appears anywhere in a line of the
8204 file, it and all following characters are ignored.
8205 .next
8206 Because local parts may legitimately contain # characters, a comment in an
8207 address list or local part list file is recognized only if # is preceded by
8208 white space or the start of the line. For example:
8209 .code
8210 not#comment@x.y.z   # but this is a comment
8211 .endd
8212 .endlist
8213
8214 Putting a filename in a list has the same effect as inserting each line of the
8215 file as an item in the list (blank lines and comments excepted). However, there
8216 is one important difference: the file is read each time the list is processed,
8217 so if its contents vary over time, Exim's behaviour changes.
8218
8219 If a filename is preceded by an exclamation mark, the sense of any match
8220 within the file is inverted. For example, if
8221 .code
8222 hold_domains = !/etc/nohold-domains
8223 .endd
8224 and the file contains the lines
8225 .code
8226 !a.b.c
8227 *.b.c
8228 .endd
8229 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8230 any domain matching &`*.b.c`& is not.
8231
8232
8233
8234 .section "An lsearch file is not an out-of-line list" "SECID77"
8235 As will be described in the sections that follow, lookups can be used in lists
8236 to provide indexed methods of checking list membership. There has been some
8237 confusion about the way &(lsearch)& lookups work in lists. Because
8238 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8239 sometimes thought that it is allowed to contain wild cards and other kinds of
8240 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8241 always fixed strings, just as for any other single-key lookup type.
8242
8243 If you want to use a file to contain wild-card patterns that form part of a
8244 list, just give the filename on its own, without a search type, as described
8245 in the previous section. You could also use the &(wildlsearch)& or
8246 &(nwildlsearch)&, but there is no advantage in doing this.
8247
8248
8249
8250
8251 .section "Named lists" "SECTnamedlists"
8252 .cindex "named lists"
8253 .cindex "list" "named"
8254 A list of domains, hosts, email addresses, or local parts can be given a name
8255 which is then used to refer to the list elsewhere in the configuration. This is
8256 particularly convenient if the same list is required in several different
8257 places. It also allows lists to be given meaningful names, which can improve
8258 the readability of the configuration. For example, it is conventional to define
8259 a domain list called &'local_domains'& for all the domains that are handled
8260 locally on a host, using a configuration line such as
8261 .code
8262 domainlist local_domains = localhost:my.dom.example
8263 .endd
8264 Named lists are referenced by giving their name preceded by a plus sign, so,
8265 for example, a router that is intended to handle local domains would be
8266 configured with the line
8267 .code
8268 domains = +local_domains
8269 .endd
8270 The first router in a configuration is often one that handles all domains
8271 except the local ones, using a configuration with a negated item like this:
8272 .code
8273 dnslookup:
8274   driver = dnslookup
8275   domains = ! +local_domains
8276   transport = remote_smtp
8277   no_more
8278 .endd
8279 The four kinds of named list are created by configuration lines starting with
8280 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8281 respectively. Then there follows the name that you are defining, followed by an
8282 equals sign and the list itself. For example:
8283 .code
8284 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8285 addresslist bad_senders = cdb;/etc/badsenders
8286 .endd
8287 A named list may refer to other named lists:
8288 .code
8289 domainlist  dom1 = first.example : second.example
8290 domainlist  dom2 = +dom1 : third.example
8291 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8292 .endd
8293 &*Warning*&: If the last item in a referenced list is a negative one, the
8294 effect may not be what you intended, because the negation does not propagate
8295 out to the higher level. For example, consider:
8296 .code
8297 domainlist  dom1 = !a.b
8298 domainlist  dom2 = +dom1 : *.b
8299 .endd
8300 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8301 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8302 means it matches the second list as well. The effect is not the same as
8303 .code
8304 domainlist  dom2 = !a.b : *.b
8305 .endd
8306 where &'x.y'& does not match. It's best to avoid negation altogether in
8307 referenced lists if you can.
8308
8309 .new
8310 .cindex "hiding named list values"
8311 .cindex "named lists" "hiding value of"
8312 Some named list definitions may contain sensitive data, for example, passwords for
8313 accessing databases. To stop non-admin users from using the &%-bP%& command
8314 line option to read these values, you can precede the definition with the
8315 word &"hide"&. For example:
8316 .code
8317 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8318 .endd
8319 .wen
8320
8321
8322 Named lists may have a performance advantage. When Exim is routing an
8323 address or checking an incoming message, it caches the result of tests on named
8324 lists. So, if you have a setting such as
8325 .code
8326 domains = +local_domains
8327 .endd
8328 on several of your routers
8329 or in several ACL statements,
8330 the actual test is done only for the first one. However, the caching works only
8331 if there are no expansions within the list itself or any sublists that it
8332 references. In other words, caching happens only for lists that are known to be
8333 the same each time they are referenced.
8334
8335 By default, there may be up to 16 named lists of each type. This limit can be
8336 extended by changing a compile-time variable. The use of domain and host lists
8337 is recommended for concepts such as local domains, relay domains, and relay
8338 hosts. The default configuration is set up like this.
8339
8340
8341
8342 .section "Named lists compared with macros" "SECID78"
8343 .cindex "list" "named compared with macro"
8344 .cindex "macro" "compared with named list"
8345 At first sight, named lists might seem to be no different from macros in the
8346 configuration file. However, macros are just textual substitutions. If you
8347 write
8348 .code
8349 ALIST = host1 : host2
8350 auth_advertise_hosts = !ALIST
8351 .endd
8352 it probably won't do what you want, because that is exactly the same as
8353 .code
8354 auth_advertise_hosts = !host1 : host2
8355 .endd
8356 Notice that the second host name is not negated. However, if you use a host
8357 list, and write
8358 .code
8359 hostlist alist = host1 : host2
8360 auth_advertise_hosts = ! +alist
8361 .endd
8362 the negation applies to the whole list, and so that is equivalent to
8363 .code
8364 auth_advertise_hosts = !host1 : !host2
8365 .endd
8366
8367
8368 .section "Named list caching" "SECID79"
8369 .cindex "list" "caching of named"
8370 .cindex "caching" "named lists"
8371 While processing a message, Exim caches the result of checking a named list if
8372 it is sure that the list is the same each time. In practice, this means that
8373 the cache operates only if the list contains no $ characters, which guarantees
8374 that it will not change when it is expanded. Sometimes, however, you may have
8375 an expanded list that you know will be the same each time within a given
8376 message. For example:
8377 .code
8378 domainlist special_domains = \
8379            ${lookup{$sender_host_address}cdb{/some/file}}
8380 .endd
8381 This provides a list of domains that depends only on the sending host's IP
8382 address. If this domain list is referenced a number of times (for example,
8383 in several ACL lines, or in several routers) the result of the check is not
8384 cached by default, because Exim does not know that it is going to be the
8385 same list each time.
8386
8387 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8388 cache the result anyway. For example:
8389 .code
8390 domainlist_cache special_domains = ${lookup{...
8391 .endd
8392 If you do this, you should be absolutely sure that caching is going to do
8393 the right thing in all cases. When in doubt, leave it out.
8394
8395
8396
8397 .section "Domain lists" "SECTdomainlist"
8398 .cindex "domain list" "patterns for"
8399 .cindex "list" "domain list"
8400 Domain lists contain patterns that are to be matched against a mail domain.
8401 The following types of item may appear in domain lists:
8402
8403 .ilist
8404 .cindex "primary host name"
8405 .cindex "host name" "matched in domain list"
8406 .oindex "&%primary_hostname%&"
8407 .cindex "domain list" "matching primary host name"
8408 .cindex "@ in a domain list"
8409 If a pattern consists of a single @ character, it matches the local host name,
8410 as set by the &%primary_hostname%& option (or defaulted). This makes it
8411 possible to use the same configuration file on several different hosts that
8412 differ only in their names.
8413 .next
8414 .cindex "@[] in a domain list"
8415 .cindex "domain list" "matching local IP interfaces"
8416 .cindex "domain literal"
8417 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8418 in square brackets (as in an email address that contains a domain literal), but
8419 only if that IP address is recognized as local for email routing purposes. The
8420 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8421 control which of a host's several IP addresses are treated as local.
8422 In today's Internet, the use of domain literals is controversial.
8423 .next
8424 .cindex "@mx_any"
8425 .cindex "@mx_primary"
8426 .cindex "@mx_secondary"
8427 .cindex "domain list" "matching MX pointers to local host"
8428 If a pattern consists of the string &`@mx_any`& it matches any domain that
8429 has an MX record pointing to the local host or to any host that is listed in
8430 .oindex "&%hosts_treat_as_local%&"
8431 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8432 are similar, except that the first matches only when a primary MX target is the
8433 local host, and the second only when no primary MX target is the local host,
8434 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8435 preference value &-- there may of course be more than one of them.
8436
8437 The MX lookup that takes place when matching a pattern of this type is
8438 performed with the resolver options for widening names turned off. Thus, for
8439 example, a single-component domain will &'not'& be expanded by adding the
8440 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8441 options of the &(dnslookup)& router for a discussion of domain widening.
8442
8443 Sometimes you may want to ignore certain IP addresses when using one of these
8444 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8445 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8446 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8447 on a router). For example:
8448 .code
8449 domains = @mx_any/ignore=127.0.0.1
8450 .endd
8451 This example matches any domain that has an MX record pointing to one of
8452 the local host's IP addresses other than 127.0.0.1.
8453
8454 The list of IP addresses is in fact processed by the same code that processes
8455 host lists, so it may contain CIDR-coded network specifications and it may also
8456 contain negative items.
8457
8458 Because the list of IP addresses is a sublist within a domain list, you have to
8459 be careful about delimiters if there is more than one address. Like any other
8460 list, the default delimiter can be changed. Thus, you might have:
8461 .code
8462 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8463           an.other.domain : ...
8464 .endd
8465 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8466 involved, it is easiest to change the delimiter for the main list as well:
8467 .code
8468 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8469           an.other.domain ? ...
8470 .endd
8471 .next
8472 .cindex "asterisk" "in domain list"
8473 .cindex "domain list" "asterisk in"
8474 .cindex "domain list" "matching &""ends with""&"
8475 If a pattern starts with an asterisk, the remaining characters of the pattern
8476 are compared with the terminating characters of the domain. The use of &"*"& in
8477 domain lists differs from its use in partial matching lookups. In a domain
8478 list, the character following the asterisk need not be a dot, whereas partial
8479 matching works only in terms of dot-separated components. For example, a domain
8480 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8481 &'cipher.key.ex'&.
8482
8483 .next
8484 .cindex "regular expressions" "in domain list"
8485 .cindex "domain list" "matching regular expression"
8486 If a pattern starts with a circumflex character, it is treated as a regular
8487 expression, and matched against the domain using a regular expression matching
8488 function. The circumflex is treated as part of the regular expression.
8489 Email domains are case-independent, so this regular expression match is by
8490 default case-independent, but you can make it case-dependent by starting it
8491 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8492 are given in chapter &<<CHAPregexp>>&.
8493
8494 &*Warning*&: Because domain lists are expanded before being processed, you
8495 must escape any backslash and dollar characters in the regular expression, or
8496 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8497 it is not to be expanded (unless you really do want to build a regular
8498 expression by expansion, of course).
8499 .next
8500 .cindex "lookup" "in domain list"
8501 .cindex "domain list" "matching by lookup"
8502 If a pattern starts with the name of a single-key lookup type followed by a
8503 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8504 must be a filename in a suitable format for the lookup type. For example, for
8505 &"cdb;"& it must be an absolute path:
8506 .code
8507 domains = cdb;/etc/mail/local_domains.cdb
8508 .endd
8509 The appropriate type of lookup is done on the file using the domain name as the
8510 key. In most cases, the data that is looked up is not used; Exim is interested
8511 only in whether or not the key is present in the file. However, when a lookup
8512 is used for the &%domains%& option on a router
8513 or a &%domains%& condition in an ACL statement, the data is preserved in the
8514 &$domain_data$& variable and can be referred to in other router options or
8515 other statements in the same ACL.
8516
8517 .next
8518 Any of the single-key lookup type names may be preceded by
8519 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8520 .code
8521 domains = partial-dbm;/partial/domains
8522 .endd
8523 This causes partial matching logic to be invoked; a description of how this
8524 works is given in section &<<SECTpartiallookup>>&.
8525
8526 .next
8527 .cindex "asterisk" "in lookup type"
8528 Any of the single-key lookup types may be followed by an asterisk. This causes
8529 a default lookup for a key consisting of a single asterisk to be done if the
8530 original lookup fails. This is not a useful feature when using a domain list to
8531 select particular domains (because any domain would match), but it might have
8532 value if the result of the lookup is being used via the &$domain_data$&
8533 expansion variable.
8534 .next
8535 If the pattern starts with the name of a query-style lookup type followed by a
8536 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8537 pattern must be an appropriate query for the lookup type, as described in
8538 chapter &<<CHAPfdlookup>>&. For example:
8539 .code
8540 hold_domains = mysql;select domain from holdlist \
8541   where domain = '${quote_mysql:$domain}';
8542 .endd
8543 In most cases, the data that is looked up is not used (so for an SQL query, for
8544 example, it doesn't matter what field you select). Exim is interested only in
8545 whether or not the query succeeds. However, when a lookup is used for the
8546 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8547 variable and can be referred to in other options.
8548 .next
8549 .cindex "domain list" "matching literal domain name"
8550 If none of the above cases apply, a caseless textual comparison is made
8551 between the pattern and the domain.
8552 .endlist
8553
8554 Here is an example that uses several different kinds of pattern:
8555 .code
8556 domainlist funny_domains = \
8557   @ : \
8558   lib.unseen.edu : \
8559   *.foundation.fict.example : \
8560   \N^[1-2]\d{3}\.fict\.example$\N : \
8561   partial-dbm;/opt/data/penguin/book : \
8562   nis;domains.byname : \
8563   nisplus;[name=$domain,status=local],domains.org_dir
8564 .endd
8565 There are obvious processing trade-offs among the various matching modes. Using
8566 an asterisk is faster than a regular expression, and listing a few names
8567 explicitly probably is too. The use of a file or database lookup is expensive,
8568 but may be the only option if hundreds of names are required. Because the
8569 patterns are tested in order, it makes sense to put the most commonly matched
8570 patterns earlier.
8571
8572
8573
8574 .section "Host lists" "SECThostlist"
8575 .cindex "host list" "patterns in"
8576 .cindex "list" "host list"
8577 Host lists are used to control what remote hosts are allowed to do. For
8578 example, some hosts may be allowed to use the local host as a relay, and some
8579 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8580 two different ways, by name or by IP address. In a host list, some types of
8581 pattern are matched to a host name, and some are matched to an IP address.
8582 You need to be particularly careful with this when single-key lookups are
8583 involved, to ensure that the right value is being used as the key.
8584
8585
8586 .section "Special host list patterns" "SECID80"
8587 .cindex "empty item in hosts list"
8588 .cindex "host list" "empty string in"
8589 If a host list item is the empty string, it matches only when no remote host is
8590 involved. This is the case when a message is being received from a local
8591 process using SMTP on the standard input, that is, when a TCP/IP connection is
8592 not used.
8593
8594 .cindex "asterisk" "in host list"
8595 The special pattern &"*"& in a host list matches any host or no host. Neither
8596 the IP address nor the name is actually inspected.
8597
8598
8599
8600 .section "Host list patterns that match by IP address" "SECThoslispatip"
8601 .cindex "host list" "matching IP addresses"
8602 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8603 the incoming address actually appears in the IPv6 host as
8604 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8605 list, it is converted into a traditional IPv4 address first. (Not all operating
8606 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8607 concerns.)
8608
8609 The following types of pattern in a host list check the remote host by
8610 inspecting its IP address:
8611
8612 .ilist
8613 If the pattern is a plain domain name (not a regular expression, not starting
8614 with *, not a lookup of any kind), Exim calls the operating system function
8615 to find the associated IP address(es). Exim uses the newer
8616 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8617 This typically causes a forward DNS lookup of the name. The result is compared
8618 with the IP address of the subject host.
8619
8620 If there is a temporary problem (such as a DNS timeout) with the host name
8621 lookup, a temporary error occurs. For example, if the list is being used in an
8622 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8623 temporary SMTP error code. If no IP address can be found for the host name,
8624 what happens is described in section &<<SECTbehipnot>>& below.
8625
8626 .next
8627 .cindex "@ in a host list"
8628 If the pattern is &"@"&, the primary host name is substituted and used as a
8629 domain name, as just described.
8630
8631 .next
8632 If the pattern is an IP address, it is matched against the IP address of the
8633 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8634 IPv6 addresses can be given in colon-separated format, but the colons have to
8635 be doubled so as not to be taken as item separators when the default list
8636 separator is used. IPv6 addresses are recognized even when Exim is compiled
8637 without IPv6 support. This means that if they appear in a host list on an
8638 IPv4-only host, Exim will not treat them as host names. They are just addresses
8639 that can never match a client host.
8640
8641 .next
8642 .cindex "@[] in a host list"
8643 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8644 the local host. For example, if the local host is an IPv4 host with one
8645 interface address 10.45.23.56, these two ACL statements have the same effect:
8646 .code
8647 accept hosts = 127.0.0.1 : 10.45.23.56
8648 accept hosts = @[]
8649 .endd
8650 .next
8651 .cindex "CIDR notation"
8652 If the pattern is an IP address followed by a slash and a mask length (for
8653 example 10.11.42.0/24), it is matched against the IP address of the subject
8654 host under the given mask. This allows, an entire network of hosts to be
8655 included (or excluded) by a single item. The mask uses CIDR notation; it
8656 specifies the number of address bits that must match, starting from the most
8657 significant end of the address.
8658
8659 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8660 of a range of addresses. It is the number of bits in the network portion of the
8661 address. The above example specifies a 24-bit netmask, so it matches all 256
8662 addresses in the 10.11.42.0 network. An item such as
8663 .code
8664 192.168.23.236/31
8665 .endd
8666 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8667 32 for an IPv4 address is the same as no mask at all; just a single address
8668 matches.
8669
8670 Here is another example which shows an IPv4 and an IPv6 network:
8671 .code
8672 recipient_unqualified_hosts = 192.168.0.0/16: \
8673                               3ffe::ffff::836f::::/48
8674 .endd
8675 The doubling of list separator characters applies only when these items
8676 appear inline in a host list. It is not required when indirecting via a file.
8677 For example:
8678 .code
8679 recipient_unqualified_hosts = /opt/exim/unqualnets
8680 .endd
8681 could make use of a file containing
8682 .code
8683 172.16.0.0/12
8684 3ffe:ffff:836f::/48
8685 .endd
8686 to have exactly the same effect as the previous example. When listing IPv6
8687 addresses inline, it is usually more convenient to use the facility for
8688 changing separator characters. This list contains the same two networks:
8689 .code
8690 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8691                                  3ffe:ffff:836f::/48
8692 .endd
8693 The separator is changed to semicolon by the leading &"<;"& at the start of the
8694 list.
8695 .endlist
8696
8697
8698
8699 .section "Host list patterns for single-key lookups by host address" &&&
8700          "SECThoslispatsikey"
8701 .cindex "host list" "lookup of IP address"
8702 When a host is to be identified by a single-key lookup of its complete IP
8703 address, the pattern takes this form:
8704 .display
8705 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8706 .endd
8707 For example:
8708 .code
8709 hosts_lookup = net-cdb;/hosts-by-ip.db
8710 .endd
8711 The text form of the IP address of the subject host is used as the lookup key.
8712 IPv6 addresses are converted to an unabbreviated form, using lower case
8713 letters, with dots as separators because colon is the key terminator in
8714 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8715 quoting the keys, but this is a facility that was added later.] The data
8716 returned by the lookup is not used.
8717
8718 .cindex "IP address" "masking"
8719 .cindex "host list" "masked IP address"
8720 Single-key lookups can also be performed using masked IP addresses, using
8721 patterns of this form:
8722 .display
8723 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8724 .endd
8725 For example:
8726 .code
8727 net24-dbm;/networks.db
8728 .endd
8729 The IP address of the subject host is masked using <&'number'&> as the mask
8730 length. A textual string is constructed from the masked value, followed by the
8731 mask, and this is used as the lookup key. For example, if the host's IP address
8732 is 192.168.34.6, the key that is looked up for the above example is
8733 &"192.168.34.0/24"&.
8734
8735 When an IPv6 address is converted to a string, dots are normally used instead
8736 of colons, so that keys in &(lsearch)& files need not contain colons (which
8737 terminate &(lsearch)& keys). This was implemented some time before the ability
8738 to quote keys was made available in &(lsearch)& files. However, the more
8739 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8740 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8741 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8742 converted using colons and not dots.
8743 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8744 addresses are always used.
8745 The latter are converted to IPv4 addresses, in dotted-quad form.
8746
8747 Ideally, it would be nice to tidy up this anomalous situation by changing to
8748 colons in all cases, given that quoting is now available for &(lsearch)&.
8749 However, this would be an incompatible change that might break some existing
8750 configurations.
8751
8752 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8753 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8754 the former case the key strings include the mask value, whereas in the latter
8755 case the IP address is used on its own.
8756
8757
8758
8759 .section "Host list patterns that match by host name" "SECThoslispatnam"
8760 .cindex "host" "lookup failures"
8761 .cindex "unknown host name"
8762 .cindex "host list" "matching host name"
8763 There are several types of pattern that require Exim to know the name of the
8764 remote host. These are either wildcard patterns or lookups by name. (If a
8765 complete hostname is given without any wildcarding, it is used to find an IP
8766 address to match against, as described in section &<<SECThoslispatip>>&
8767 above.)
8768
8769 If the remote host name is not already known when Exim encounters one of these
8770 patterns, it has to be found from the IP address.
8771 Although many sites on the Internet are conscientious about maintaining reverse
8772 DNS data for their hosts, there are also many that do not do this.
8773 Consequently, a name cannot always be found, and this may lead to unwanted
8774 effects. Take care when configuring host lists with wildcarded name patterns.
8775 Consider what will happen if a name cannot be found.
8776
8777 Because of the problems of determining host names from IP addresses, matching
8778 against host names is not as common as matching against IP addresses.
8779
8780 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8781 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8782 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8783 are done can be changed by setting the &%host_lookup_order%& option. For
8784 security, once Exim has found one or more names, it looks up the IP addresses
8785 for these names and compares them with the IP address that it started with.
8786 Only those names whose IP addresses match are accepted. Any other names are
8787 discarded. If no names are left, Exim behaves as if the host name cannot be
8788 found. In the most common case there is only one name and one IP address.
8789
8790 There are some options that control what happens if a host name cannot be
8791 found. These are described in section &<<SECTbehipnot>>& below.
8792
8793 .cindex "host" "alias for"
8794 .cindex "alias for host"
8795 As a result of aliasing, hosts may have more than one name. When processing any
8796 of the following types of pattern, all the host's names are checked:
8797
8798 .ilist
8799 .cindex "asterisk" "in host list"
8800 If a pattern starts with &"*"& the remainder of the item must match the end of
8801 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8802 &'.b.c'&. This special simple form is provided because this is a very common
8803 requirement. Other kinds of wildcarding require the use of a regular
8804 expression.
8805 .next
8806 .cindex "regular expressions" "in host list"
8807 .cindex "host list" "regular expression in"
8808 If the item starts with &"^"& it is taken to be a regular expression which is
8809 matched against the host name. Host names are case-independent, so this regular
8810 expression match is by default case-independent, but you can make it
8811 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8812 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8813 example,
8814 .code
8815 ^(a|b)\.c\.d$
8816 .endd
8817 is a regular expression that matches either of the two hosts &'a.c.d'& or
8818 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8819 that backslash and dollar characters are not misinterpreted as part of the
8820 string expansion. The simplest way to do this is to use &`\N`& to mark that
8821 part of the string as non-expandable. For example:
8822 .code
8823 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8824 .endd
8825 &*Warning*&: If you want to match a complete host name, you must include the
8826 &`$`& terminating metacharacter in the regular expression, as in the above
8827 example. Without it, a match at the start of the host name is all that is
8828 required.
8829 .endlist
8830
8831
8832
8833
8834 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8835 .cindex "host" "lookup failures, permanent"
8836 While processing a host list, Exim may need to look up an IP address from a
8837 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8838 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8839 behaviour when it fails to find the information it is seeking is the same.
8840
8841 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8842 apply to temporary DNS errors, whose handling is described in the next section.
8843
8844 .cindex "&`+include_unknown`&"
8845 .cindex "&`+ignore_unknown`&"
8846 Exim parses a host list from left to right. If it encounters a permanent
8847 lookup failure in any item in the host list before it has found a match,
8848 Exim treats it as a failure and the default behavior is as if the host
8849 does not match the list. This may not always be what you want to happen.
8850 To change Exim's behaviour, the special items &`+include_unknown`& or
8851 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8852 not recognized in an indirected file).
8853
8854 .ilist
8855 If any item that follows &`+include_unknown`& requires information that
8856 cannot found, Exim behaves as if the host does match the list. For example,
8857 .code
8858 host_reject_connection = +include_unknown:*.enemy.ex
8859 .endd
8860 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8861 any hosts whose name it cannot find.
8862
8863 .next
8864 If any item that follows &`+ignore_unknown`& requires information that cannot
8865 be found, Exim ignores that item and proceeds to the rest of the list. For
8866 example:
8867 .code
8868 accept hosts = +ignore_unknown : friend.example : \
8869                192.168.4.5
8870 .endd
8871 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8872 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8873 name can be found for 192.168.4.5, it is rejected.
8874 .endlist
8875
8876 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8877 list. The effect of each one lasts until the next, or until the end of the
8878 list.
8879
8880 .section "Mixing wildcarded host names and addresses in host lists" &&&
8881          "SECTmixwilhos"
8882 .cindex "host list" "mixing names and addresses in"
8883
8884 This section explains the host/ip processing logic with the same concepts
8885 as the previous section, but specifically addresses what happens when a
8886 wildcarded hostname is one of the items in the hostlist.
8887
8888 .ilist
8889 If you have name lookups or wildcarded host names and
8890 IP addresses in the same host list, you should normally put the IP
8891 addresses first. For example, in an ACL you could have:
8892 .code
8893 accept hosts = 10.9.8.7 : *.friend.example
8894 .endd
8895 The reason you normally would order it this way lies in the
8896 left-to-right way that Exim processes lists.  It can test IP addresses
8897 without doing any DNS lookups, but when it reaches an item that requires
8898 a host name, it fails if it cannot find a host name to compare with the
8899 pattern. If the above list is given in the opposite order, the
8900 &%accept%& statement fails for a host whose name cannot be found, even
8901 if its IP address is 10.9.8.7.
8902
8903 .next
8904 If you really do want to do the name check first, and still recognize the IP
8905 address, you can rewrite the ACL like this:
8906 .code
8907 accept hosts = *.friend.example
8908 accept hosts = 10.9.8.7
8909 .endd
8910 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8911 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8912 &`+ignore_unknown`&, which was discussed in depth in the first example in
8913 this section.
8914 .endlist
8915
8916
8917 .section "Temporary DNS errors when looking up host information" &&&
8918          "SECTtemdnserr"
8919 .cindex "host" "lookup failures, temporary"
8920 .cindex "&`+include_defer`&"
8921 .cindex "&`+ignore_defer`&"
8922 A temporary DNS lookup failure normally causes a defer action (except when
8923 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8924 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8925 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8926 section. These options should be used with care, probably only in non-critical
8927 host lists such as whitelists.
8928
8929
8930
8931 .section "Host list patterns for single-key lookups by host name" &&&
8932          "SECThoslispatnamsk"
8933 .cindex "unknown host name"
8934 .cindex "host list" "matching host name"
8935 If a pattern is of the form
8936 .display
8937 <&'single-key-search-type'&>;<&'search-data'&>
8938 .endd
8939 for example
8940 .code
8941 dbm;/host/accept/list
8942 .endd
8943 a single-key lookup is performed, using the host name as its key. If the
8944 lookup succeeds, the host matches the item. The actual data that is looked up
8945 is not used.
8946
8947 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8948 keys in the file, not IP addresses. If you want to do lookups based on IP
8949 addresses, you must precede the search type with &"net-"& (see section
8950 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8951 two items in the same list, one doing an address lookup and one doing a name
8952 lookup, both using the same file.
8953
8954
8955
8956 .section "Host list patterns for query-style lookups" "SECID81"
8957 If a pattern is of the form
8958 .display
8959 <&'query-style-search-type'&>;<&'query'&>
8960 .endd
8961 the query is obeyed, and if it succeeds, the host matches the item. The actual
8962 data that is looked up is not used. The variables &$sender_host_address$& and
8963 &$sender_host_name$& can be used in the query. For example:
8964 .code
8965 hosts_lookup = pgsql;\
8966   select ip from hostlist where ip='$sender_host_address'
8967 .endd
8968 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8969 can use the &%sg%& expansion item to change this if you need to. If you want to
8970 use masked IP addresses in database queries, you can use the &%mask%& expansion
8971 operator.
8972
8973 If the query contains a reference to &$sender_host_name$&, Exim automatically
8974 looks up the host name if it has not already done so. (See section
8975 &<<SECThoslispatnam>>& for comments on finding host names.)
8976
8977 Historical note: prior to release 4.30, Exim would always attempt to find a
8978 host name before running the query, unless the search type was preceded by
8979 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8980 still recognized for query-style lookups, but its presence or absence has no
8981 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8982 See section &<<SECThoslispatsikey>>&.)
8983
8984
8985
8986
8987
8988 .section "Address lists" "SECTaddresslist"
8989 .cindex "list" "address list"
8990 .cindex "address list" "empty item"
8991 .cindex "address list" "patterns"
8992 Address lists contain patterns that are matched against mail addresses. There
8993 is one special case to be considered: the sender address of a bounce message is
8994 always empty. You can test for this by providing an empty item in an address
8995 list. For example, you can set up a router to process bounce messages by
8996 using this option setting:
8997 .code
8998 senders = :
8999 .endd
9000 The presence of the colon creates an empty item. If you do not provide any
9001 data, the list is empty and matches nothing. The empty sender can also be
9002 detected by a regular expression that matches an empty string,
9003 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9004
9005 Non-empty items in an address list can be straightforward email addresses. For
9006 example:
9007 .code
9008 senders = jbc@askone.example : hs@anacreon.example
9009 .endd
9010 A certain amount of wildcarding is permitted. If a pattern contains an @
9011 character, but is not a regular expression and does not begin with a
9012 semicolon-terminated lookup type (described below), the local part of the
9013 subject address is compared with the local part of the pattern, which may start
9014 with an asterisk. If the local parts match, the domain is checked in exactly
9015 the same way as for a pattern in a domain list. For example, the domain can be
9016 wildcarded, refer to a named list, or be a lookup:
9017 .code
9018 deny senders = *@*.spamming.site:\
9019                *@+hostile_domains:\
9020                bozo@partial-lsearch;/list/of/dodgy/sites:\
9021                *@dbm;/bad/domains.db
9022 .endd
9023 .cindex "local part" "starting with !"
9024 .cindex "address list" "local part starting with !"
9025 If a local part that begins with an exclamation mark is required, it has to be
9026 specified using a regular expression, because otherwise the exclamation mark is
9027 treated as a sign of negation, as is standard in lists.
9028
9029 If a non-empty pattern that is not a regular expression or a lookup does not
9030 contain an @ character, it is matched against the domain part of the subject
9031 address. The only two formats that are recognized this way are a literal
9032 domain, or a domain pattern that starts with *. In both these cases, the effect
9033 is the same as if &`*@`& preceded the pattern. For example:
9034 .code
9035 deny senders = enemy.domain : *.enemy.domain
9036 .endd
9037
9038 The following kinds of more complicated address list pattern can match any
9039 address, including the empty address that is characteristic of bounce message
9040 senders:
9041
9042 .ilist
9043 .cindex "regular expressions" "in address list"
9044 .cindex "address list" "regular expression in"
9045 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9046 done against the complete address, with the pattern as the regular expression.
9047 You must take care that backslash and dollar characters are not misinterpreted
9048 as part of the string expansion. The simplest way to do this is to use &`\N`&
9049 to mark that part of the string as non-expandable. For example:
9050 .code
9051 deny senders = \N^.*this.*@example\.com$\N : \
9052                \N^\d{8}.+@spamhaus.example$\N : ...
9053 .endd
9054 The &`\N`& sequences are removed by the expansion, so these items do indeed
9055 start with &"^"& by the time they are being interpreted as address patterns.
9056
9057 .next
9058 .cindex "address list" "lookup for complete address"
9059 Complete addresses can be looked up by using a pattern that starts with a
9060 lookup type terminated by a semicolon, followed by the data for the lookup. For
9061 example:
9062 .code
9063 deny senders = cdb;/etc/blocked.senders : \
9064   mysql;select address from blocked where \
9065   address='${quote_mysql:$sender_address}'
9066 .endd
9067 Both query-style and single-key lookup types can be used. For a single-key
9068 lookup type, Exim uses the complete address as the key. However, empty keys are
9069 not supported for single-key lookups, so a match against the empty address
9070 always fails. This restriction does not apply to query-style lookups.
9071
9072 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9073 cannot be used, and is ignored if specified, with an entry being written to the
9074 panic log.
9075 .cindex "*@ with single-key lookup"
9076 However, you can configure lookup defaults, as described in section
9077 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9078 default. For example, with this lookup:
9079 .code
9080 accept senders = lsearch*@;/some/file
9081 .endd
9082 the file could contains lines like this:
9083 .code
9084 user1@domain1.example
9085 *@domain2.example
9086 .endd
9087 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9088 that are tried is:
9089 .code
9090 nimrod@jaeger.example
9091 *@jaeger.example
9092 *
9093 .endd
9094 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9095 would mean that every address matches, thus rendering the test useless.
9096
9097 &*Warning 2*&: Do not confuse these two kinds of item:
9098 .code
9099 deny recipients = dbm*@;/some/file
9100 deny recipients = *@dbm;/some/file
9101 .endd
9102 The first does a whole address lookup, with defaulting, as just described,
9103 because it starts with a lookup type. The second matches the local part and
9104 domain independently, as described in a bullet point below.
9105 .endlist
9106
9107
9108 The following kinds of address list pattern can match only non-empty addresses.
9109 If the subject address is empty, a match against any of these pattern types
9110 always fails.
9111
9112
9113 .ilist
9114 .cindex "@@ with single-key lookup"
9115 .cindex "address list" "@@ lookup type"
9116 .cindex "address list" "split local part and domain"
9117 If a pattern starts with &"@@"& followed by a single-key lookup item
9118 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9119 split into a local part and a domain. The domain is looked up in the file. If
9120 it is not found, there is no match. If it is found, the data that is looked up
9121 from the file is treated as a colon-separated list of local part patterns, each
9122 of which is matched against the subject local part in turn.
9123
9124 .cindex "asterisk" "in address list"
9125 The lookup may be a partial one, and/or one involving a search for a default
9126 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9127 patterns that are looked up can be regular expressions or begin with &"*"&, or
9128 even be further lookups. They may also be independently negated. For example,
9129 with
9130 .code
9131 deny senders = @@dbm;/etc/reject-by-domain
9132 .endd
9133 the data from which the DBM file is built could contain lines like
9134 .code
9135 baddomain.com:  !postmaster : *
9136 .endd
9137 to reject all senders except &%postmaster%& from that domain.
9138
9139 .cindex "local part" "starting with !"
9140 If a local part that actually begins with an exclamation mark is required, it
9141 has to be specified using a regular expression. In &(lsearch)& files, an entry
9142 may be split over several lines by indenting the second and subsequent lines,
9143 but the separating colon must still be included at line breaks. White space
9144 surrounding the colons is ignored. For example:
9145 .code
9146 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9147   spammer3 : spammer4
9148 .endd
9149 As in all colon-separated lists in Exim, a colon can be included in an item by
9150 doubling.
9151
9152 If the last item in the list starts with a right angle-bracket, the remainder
9153 of the item is taken as a new key to look up in order to obtain a continuation
9154 list of local parts. The new key can be any sequence of characters. Thus one
9155 might have entries like
9156 .code
9157 aol.com: spammer1 : spammer 2 : >*
9158 xyz.com: spammer3 : >*
9159 *:       ^\d{8}$
9160 .endd
9161 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9162 local parts for all domains, in addition to the specific local parts listed for
9163 each domain. Of course, using this feature costs another lookup each time a
9164 chain is followed, but the effort needed to maintain the data is reduced.
9165
9166 .cindex "loop" "in lookups"
9167 It is possible to construct loops using this facility, and in order to catch
9168 them, the chains may be no more than fifty items long.
9169
9170 .next
9171 The @@<&'lookup'&> style of item can also be used with a query-style
9172 lookup, but in this case, the chaining facility is not available. The lookup
9173 can only return a single list of local parts.
9174 .endlist
9175
9176 &*Warning*&: There is an important difference between the address list items
9177 in these two examples:
9178 .code
9179 senders = +my_list
9180 senders = *@+my_list
9181 .endd
9182 In the first one, &`my_list`& is a named address list, whereas in the second
9183 example it is a named domain list.
9184
9185
9186
9187
9188 .section "Case of letters in address lists" "SECTcasletadd"
9189 .cindex "case of local parts"
9190 .cindex "address list" "case forcing"
9191 .cindex "case forcing in address lists"
9192 Domains in email addresses are always handled caselessly, but for local parts
9193 case may be significant on some systems (see &%caseful_local_part%& for how
9194 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9195 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9196 blocking lists should be done in a case-independent manner. Since most address
9197 lists in Exim are used for this kind of control, Exim attempts to do this by
9198 default.
9199
9200 The domain portion of an address is always lowercased before matching it to an
9201 address list. The local part is lowercased by default, and any string
9202 comparisons that take place are done caselessly. This means that the data in
9203 the address list itself, in files included as plain filenames, and in any file
9204 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9205 keys in files that are looked up by a search type other than &(lsearch)& (which
9206 works caselessly) must be in lower case, because these lookups are not
9207 case-independent.
9208
9209 .cindex "&`+caseful`&"
9210 To allow for the possibility of caseful address list matching, if an item in
9211 an address list is the string &"+caseful"&, the original case of the local
9212 part is restored for any comparisons that follow, and string comparisons are no
9213 longer case-independent. This does not affect the domain, which remains in
9214 lower case. However, although independent matches on the domain alone are still
9215 performed caselessly, regular expressions that match against an entire address
9216 become case-sensitive after &"+caseful"& has been seen.
9217
9218
9219
9220 .section "Local part lists" "SECTlocparlis"
9221 .cindex "list" "local part list"
9222 .cindex "local part" "list"
9223 Case-sensitivity in local part lists is handled in the same way as for address
9224 lists, as just described. The &"+caseful"& item can be used if required. In a
9225 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9226 set false, the subject is lowercased and the matching is initially
9227 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9228 matching in the local part list, but not elsewhere in the router. If
9229 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9230 option is case-sensitive from the start.
9231
9232 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9233 comments are handled in the same way as address lists &-- they are recognized
9234 only if the # is preceded by white space or the start of the line.
9235 Otherwise, local part lists are matched in the same way as domain lists, except
9236 that the special items that refer to the local host (&`@`&, &`@[]`&,
9237 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9238 Refer to section &<<SECTdomainlist>>& for details of the other available item
9239 types.
9240 .ecindex IIDdohoadli
9241
9242
9243
9244
9245 . ////////////////////////////////////////////////////////////////////////////
9246 . ////////////////////////////////////////////////////////////////////////////
9247
9248 .chapter "String expansions" "CHAPexpand"
9249 .scindex IIDstrexp "expansion" "of strings"
9250 Many strings in Exim's runtime configuration are expanded before use. Some of
9251 them are expanded every time they are used; others are expanded only once.
9252
9253 When a string is being expanded it is copied verbatim from left to right except
9254 .cindex expansion "string concatenation"
9255 when a dollar or backslash character is encountered. A dollar specifies the
9256 start of a portion of the string that is interpreted and replaced as described
9257 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9258 escape character, as described in the following section.
9259
9260 Whether a string is expanded depends upon the context.  Usually this is solely
9261 dependent upon the option for which a value is sought; in this documentation,
9262 options for which string expansion is performed are marked with &dagger; after
9263 the data type.  ACL rules always expand strings.  A couple of expansion
9264 conditions do not expand some of the brace-delimited branches, for security
9265 reasons,
9266 .cindex "tainted data" expansion
9267 .cindex expansion "tainted data"
9268 and expansion of data deriving from the sender (&"tainted data"&)
9269 is not permitted.
9270
9271
9272
9273 .section "Literal text in expanded strings" "SECTlittext"
9274 .cindex "expansion" "including literal text"
9275 An uninterpreted dollar can be included in an expanded string by putting a
9276 backslash in front of it. A backslash can be used to prevent any special
9277 character being treated specially in an expansion, including backslash itself.
9278 If the string appears in quotes in the configuration file, two backslashes are
9279 required because the quotes themselves cause interpretation of backslashes when
9280 the string is read in (see section &<<SECTstrings>>&).
9281
9282 .cindex "expansion" "non-expandable substrings"
9283 A portion of the string can specified as non-expandable by placing it between
9284 two occurrences of &`\N`&. This is particularly useful for protecting regular
9285 expressions, which often contain backslashes and dollar signs. For example:
9286 .code
9287 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9288 .endd
9289 On encountering the first &`\N`&, the expander copies subsequent characters
9290 without interpretation until it reaches the next &`\N`& or the end of the
9291 string.
9292
9293
9294
9295 .section "Character escape sequences in expanded strings" "SECID82"
9296 .cindex "expansion" "escape sequences"
9297 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9298 expanded string is recognized as an escape sequence for the character newline,
9299 carriage return, or tab, respectively. A backslash followed by up to three
9300 octal digits is recognized as an octal encoding for a single character, and a
9301 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9302 encoding.
9303
9304 These escape sequences are also recognized in quoted strings when they are read
9305 in. Their interpretation in expansions as well is useful for unquoted strings,
9306 and for other cases such as looked-up strings that are then expanded.
9307
9308
9309 .section "Testing string expansions" "SECID83"
9310 .cindex "expansion" "testing"
9311 .cindex "testing" "string expansion"
9312 .oindex "&%-be%&"
9313 Many expansions can be tested by calling Exim with the &%-be%& option. This
9314 takes the command arguments, or lines from the standard input if there are no
9315 arguments, runs them through the string expansion code, and writes the results
9316 to the standard output. Variables based on configuration values are set up, but
9317 since no message is being processed, variables such as &$local_part$& have no
9318 value. Nevertheless the &%-be%& option can be useful for checking out file and
9319 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9320 and &%nhash%&.
9321
9322 Exim gives up its root privilege when it is called with the &%-be%& option, and
9323 instead runs under the uid and gid it was called with, to prevent users from
9324 using &%-be%& for reading files to which they do not have access.
9325
9326 .oindex "&%-bem%&"
9327 If you want to test expansions that include variables whose values are taken
9328 from a message, there are two other options that can be used. The &%-bem%&
9329 option is like &%-be%& except that it is followed by a filename. The file is
9330 read as a message before doing the test expansions. For example:
9331 .code
9332 exim -bem /tmp/test.message '$h_subject:'
9333 .endd
9334 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9335 Exim message identifier. For example:
9336 .code
9337 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9338 .endd
9339 This loads the message from Exim's spool before doing the test expansions, and
9340 is therefore restricted to admin users.
9341
9342
9343 .section "Forced expansion failure" "SECTforexpfai"
9344 .cindex "expansion" "forced failure"
9345 A number of expansions that are described in the following section have
9346 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9347 (which are sometimes called &"curly brackets"&). Which of the two strings is
9348 used depends on some condition that is evaluated as part of the expansion. If,
9349 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9350 the entire string expansion fails in a way that can be detected by the code
9351 that requested the expansion. This is called &"forced expansion failure"&, and
9352 its consequences depend on the circumstances. In some cases it is no different
9353 from any other expansion failure, but in others a different action may be
9354 taken. Such variations are mentioned in the documentation of the option that is
9355 being expanded.
9356
9357
9358
9359
9360 .section "Expansion items" "SECTexpansionitems"
9361 The following items are recognized in expanded strings. White space may be used
9362 between sub-items that are keywords or substrings enclosed in braces inside an
9363 outer set of braces, to improve readability. &*Warning*&: Within braces,
9364 white space is significant.
9365
9366 .vlist
9367 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9368 .cindex "expansion" "variables"
9369 Substitute the contents of the named variable, for example:
9370 .code
9371 $local_part
9372 ${domain}
9373 .endd
9374 The second form can be used to separate the name from subsequent alphanumeric
9375 characters. This form (using braces) is available only for variables; it does
9376 &'not'& apply to message headers. The names of the variables are given in
9377 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9378 given, the expansion fails.
9379
9380 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9381 .cindex "expansion" "operators"
9382 The string is first itself expanded, and then the operation specified by
9383 <&'op'&> is applied to it. For example:
9384 .code
9385 ${lc:$local_part}
9386 .endd
9387 The string starts with the first character after the colon, which may be
9388 leading white space. A list of operators is given in section &<<SECTexpop>>&
9389 below. The operator notation is used for simple expansion items that have just
9390 one argument, because it reduces the number of braces and therefore makes the
9391 string easier to understand.
9392
9393 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9394 This item inserts &"basic"& header lines. It is described with the &%header%&
9395 expansion item below.
9396
9397
9398 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9399 .cindex "expansion" "calling an acl"
9400 .cindex "&%acl%&" "call from expansion"
9401 The name and zero to nine argument strings are first expanded separately.  The expanded
9402 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9403 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9404 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9405 and may use the variables; if another acl expansion is used the values
9406 are restored after it returns.  If the ACL sets
9407 a value using a "message =" modifier and returns accept or deny, the value becomes
9408 the result of the expansion.
9409 If no message is set and the ACL returns accept or deny
9410 the expansion result is an empty string.
9411 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9412
9413
9414 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9415 .cindex authentication "results header"
9416 .cindex headers "authentication-results:"
9417 .cindex authentication "expansion item"
9418 This item returns a string suitable for insertion as an
9419 &'Authentication-Results:'&
9420 header line.
9421 The given <&'authserv-id'&> is included in the result; typically this
9422 will be a domain name identifying the system performing the authentications.
9423 Methods that might be present in the result include:
9424 .code
9425 none
9426 iprev
9427 auth
9428 spf
9429 dkim
9430 .endd
9431
9432 Example use (as an ACL modifier):
9433 .code
9434       add_header = :at_start:${authresults {$primary_hostname}}
9435 .endd
9436 This is safe even if no authentication results are available.
9437
9438
9439 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9440        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9441 .cindex "expansion" "extracting certificate fields"
9442 .cindex "&%certextract%&" "certificate fields"
9443 .cindex "certificate" "extracting fields"
9444 The <&'certificate'&> must be a variable of type certificate.
9445 The field name is expanded and used to retrieve the relevant field from
9446 the certificate.  Supported fields are:
9447 .display
9448 &`version        `&
9449 &`serial_number  `&
9450 &`subject        `& RFC4514 DN
9451 &`issuer         `& RFC4514 DN
9452 &`notbefore      `& time
9453 &`notafter       `& time
9454 &`sig_algorithm  `&
9455 &`signature      `&
9456 &`subj_altname   `& tagged list
9457 &`ocsp_uri       `& list
9458 &`crl_uri        `& list
9459 .endd
9460 If the field is found,
9461 <&'string2'&> is expanded, and replaces the whole item;
9462 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9463 variable &$value$& contains the value that has been extracted. Afterwards, it
9464 is restored to any previous value it might have had.
9465
9466 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9467 key is not found. If {<&'string2'&>} is also omitted, the value that was
9468 extracted is used.
9469
9470 Some field names take optional modifiers, appended and separated by commas.
9471
9472 The field selectors marked as "RFC4514" above
9473 output a Distinguished Name string which is
9474 not quite
9475 parseable by Exim as a comma-separated tagged list
9476 (the exceptions being elements containing commas).
9477 RDN elements of a single type may be selected by
9478 a modifier of the type label; if so the expansion
9479 result is a list (newline-separated by default).
9480 The separator may be changed by another modifier of
9481 a right angle-bracket followed immediately by the new separator.
9482 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9483
9484 The field selectors marked as "time" above
9485 take an optional modifier of "int"
9486 for which the result is the number of seconds since epoch.
9487 Otherwise the result is a human-readable string
9488 in the timezone selected by the main "timezone" option.
9489
9490 The field selectors marked as "list" above return a list,
9491 newline-separated by default,
9492 (embedded separator characters in elements are doubled).
9493 The separator may be changed by a modifier of
9494 a right angle-bracket followed immediately by the new separator.
9495
9496 The field selectors marked as "tagged" above
9497 prefix each list element with a type string and an equals sign.
9498 Elements of only one type may be selected by a modifier
9499 which is one of "dns", "uri" or "mail";
9500 if so the element tags are omitted.
9501
9502 If not otherwise noted field values are presented in human-readable form.
9503
9504 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9505        {*&<&'arg'&>&*}...}*&"
9506 .cindex &%dlfunc%&
9507 This expansion dynamically loads and then calls a locally-written C function.
9508 This functionality is available only if Exim is compiled with
9509 .code
9510 EXPAND_DLFUNC=yes
9511 .endd
9512 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9513 object so that it doesn't reload the same object file in the same Exim process
9514 (but of course Exim does start new processes frequently).
9515
9516 There may be from zero to eight arguments to the function.
9517
9518 When compiling
9519 a local function that is to be called in this way,
9520 first &_DLFUNC_IMPL_& should be defined,
9521 and second &_local_scan.h_& should be included.
9522 The Exim variables and functions that are defined by that API
9523 are also available for dynamically loaded functions. The function itself
9524 must have the following type:
9525 .code
9526 int dlfunction(uschar **yield, int argc, uschar *argv[])
9527 .endd
9528 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9529 function should return one of the following values:
9530
9531 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9532 into the expanded string that is being built.
9533
9534 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9535 from &'yield'&, if it is set.
9536
9537 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9538 taken from &'yield'& if it is set.
9539
9540 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9541
9542 When compiling a function that is to be used in this way with gcc,
9543 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9544 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9545
9546
9547 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9548 .cindex "expansion" "extracting value from environment"
9549 .cindex "environment" "values from"
9550 The key is first expanded separately, and leading and trailing white space
9551 removed.
9552 This is then searched for as a name in the environment.
9553 If a variable is found then its value is placed in &$value$&
9554 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9555
9556 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9557 appear, for example:
9558 .code
9559 ${env{USER}{$value} fail }
9560 .endd
9561 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9562 {<&'string1'&>} must be present for &"fail"& to be recognized.
9563
9564 If {<&'string2'&>} is omitted an empty string is substituted on
9565 search failure.
9566 If {<&'string1'&>} is omitted the search result is substituted on
9567 search success.
9568
9569 The environment is adjusted by the &%keep_environment%& and
9570 &%add_environment%& main section options.
9571
9572
9573 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9574        {*&<&'string3'&>&*}}*&"
9575 .cindex "expansion" "extracting substrings by key"
9576 .cindex "&%extract%&" "substrings by key"
9577 The key and <&'string1'&> are first expanded separately. Leading and trailing
9578 white space is removed from the key (but not from any of the strings). The key
9579 must not be empty and must not consist entirely of digits.
9580 The expanded <&'string1'&> must be of the form:
9581 .display
9582 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9583 .endd
9584 .vindex "&$value$&"
9585 where the equals signs and spaces (but not both) are optional. If any of the
9586 values contain white space, they must be enclosed in double quotes, and any
9587 values that are enclosed in double quotes are subject to escape processing as
9588 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9589 for the value that corresponds to the key. The search is case-insensitive. If
9590 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9591 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9592 variable &$value$& contains the value that has been extracted. Afterwards, it
9593 is restored to any previous value it might have had.
9594
9595 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9596 key is not found. If {<&'string2'&>} is also omitted, the value that was
9597 extracted is used. Thus, for example, these two expansions are identical, and
9598 yield &"2001"&:
9599 .code
9600 ${extract{gid}{uid=1984 gid=2001}}
9601 ${extract{gid}{uid=1984 gid=2001}{$value}}
9602 .endd
9603 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9604 appear, for example:
9605 .code
9606 ${extract{Z}{A=... B=...}{$value} fail }
9607 .endd
9608 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9609 {<&'string2'&>} must be present for &"fail"& to be recognized.
9610
9611 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9612        {*&<&'string3'&>&*}}*&" &&&
9613        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9614        {*&<&'string3'&>&*}}*&"
9615 .cindex "expansion" "extracting from JSON object"
9616 .cindex JSON expansions
9617 The key and <&'string1'&> are first expanded separately. Leading and trailing
9618 white space is removed from the key (but not from any of the strings). The key
9619 must not be empty and must not consist entirely of digits.
9620 The expanded <&'string1'&> must be of the form:
9621 .display
9622 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9623 .endd
9624 .vindex "&$value$&"
9625 The braces, commas and colons, and the quoting of the member name are required;
9626 the spaces are optional.
9627 Matching of the key against the member names is done case-sensitively.
9628 For the &"json"& variant,
9629 if a returned value is a JSON string, it retains its leading and
9630 trailing quotes.
9631 For the &"jsons"& variant, which is intended for use with JSON strings, the
9632 leading and trailing quotes are removed from the returned value.
9633 . XXX should be a UTF-8 compare
9634
9635 The results of matching are handled as above.
9636
9637
9638 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9639         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9640 .cindex "expansion" "extracting substrings by number"
9641 .cindex "&%extract%&" "substrings by number"
9642 The <&'number'&> argument must consist entirely of decimal digits,
9643 apart from leading and trailing white space, which is ignored.
9644 This is what distinguishes this form of &%extract%& from the previous kind. It
9645 behaves in the same way, except that, instead of extracting a named field, it
9646 extracts from <&'string1'&> the field whose number is given as the first
9647 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9648 <&'string3'&> as before.
9649
9650 The fields in the string are separated by any one of the characters in the
9651 separator string. These may include space or tab characters.
9652 The first field is numbered one. If the number is negative, the fields are
9653 counted from the end of the string, with the rightmost one numbered -1. If the
9654 number given is zero, the entire string is returned. If the modulus of the
9655 number is greater than the number of fields in the string, the result is the
9656 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9657 provided. For example:
9658 .code
9659 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9660 .endd
9661 yields &"42"&, and
9662 .code
9663 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9664 .endd
9665 yields &"99"&. Two successive separators mean that the field between them is
9666 empty (for example, the fifth field above).
9667
9668
9669 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9670         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9671        "&*${extract jsons{*&<&'number'&>&*}}&&&
9672         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9673 .cindex "expansion" "extracting from JSON array"
9674 .cindex JSON expansions
9675 The <&'number'&> argument must consist entirely of decimal digits,
9676 apart from leading and trailing white space, which is ignored.
9677
9678 Field selection and result handling is as above;
9679 there is no choice of field separator.
9680 For the &"json"& variant,
9681 if a returned value is a JSON string, it retains its leading and
9682 trailing quotes.
9683 For the &"jsons"& variant, which is intended for use with JSON strings, the
9684 leading and trailing quotes are removed from the returned value.
9685
9686
9687 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9688 .cindex "list" "selecting by condition"
9689 .cindex "expansion" "selecting from list by condition"
9690 .vindex "&$item$&"
9691 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9692 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9693 For each item
9694 in this list, its value is place in &$item$&, and then the condition is
9695 evaluated. If the condition is true, &$item$& is added to the output as an
9696 item in a new list; if the condition is false, the item is discarded. The
9697 separator used for the output list is the same as the one used for the
9698 input, but a separator setting is not included in the output. For example:
9699 .code
9700 ${filter{a:b:c}{!eq{$item}{b}}}
9701 .endd
9702 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9703 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9704
9705
9706 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9707 .cindex "hash function" "textual"
9708 .cindex "expansion" "textual hash"
9709 This is a textual hashing function, and was the first to be implemented in
9710 early versions of Exim. In current releases, there are other hashing functions
9711 (numeric, MD5, and SHA-1), which are described below.
9712
9713 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9714 <&'n'&>. If you are using fixed values for these numbers, that is, if
9715 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9716 use the simpler operator notation that avoids some of the braces:
9717 .code
9718 ${hash_<n>_<m>:<string>}
9719 .endd
9720 The second number is optional (in both notations). If <&'n'&> is greater than
9721 or equal to the length of the string, the expansion item returns the string.
9722 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9723 function to the string. The new string consists of characters taken from the
9724 first <&'m'&> characters of the string
9725 .code
9726 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9727 .endd
9728 If <&'m'&> is not present the value 26 is used, so that only lower case
9729 letters appear. For example:
9730 .display
9731 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9732 &`$hash{5}{monty}}           `&   yields  &`monty`&
9733 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9734 .endd
9735
9736 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9737         &*$h_*&<&'header&~name'&>&*:*&" &&&
9738        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9739         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9740        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9741         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9742        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9743         &*$rh_*&<&'header&~name'&>&*:*&"
9744 .cindex "expansion" "header insertion"
9745 .vindex "&$header_$&"
9746 .vindex "&$bheader_$&"
9747 .vindex "&$lheader_$&"
9748 .vindex "&$rheader_$&"
9749 .cindex "header lines" "in expansion strings"
9750 .cindex "header lines" "character sets"
9751 .cindex "header lines" "decoding"
9752 Substitute the contents of the named message header line, for example
9753 .code
9754 $header_reply-to:
9755 .endd
9756 The newline that terminates a header line is not included in the expansion, but
9757 internal newlines (caused by splitting the header line over several physical
9758 lines) may be present.
9759
9760 The difference between the four pairs of expansions is in the way
9761 the data in the header line is interpreted.
9762
9763 .ilist
9764 .cindex "white space" "in header lines"
9765 &%rheader%& gives the original &"raw"& content of the header line, with no
9766 processing at all, and without the removal of leading and trailing white space.
9767
9768 .next
9769 .cindex "list" "of header lines"
9770 &%lheader%& gives a colon-separated list, one element per header when there
9771 are multiple headers with a given name.
9772 Any embedded colon characters within an element are doubled, so normal Exim
9773 list-processing facilities can be used.
9774 The terminating newline of each element is removed; in other respects
9775 the content is &"raw"&.
9776
9777 .next
9778 .cindex "base64 encoding" "in header lines"
9779 &%bheader%& removes leading and trailing white space, and then decodes base64
9780 or quoted-printable MIME &"words"& within the header text, but does no
9781 character set translation. If decoding of what looks superficially like a MIME
9782 &"word"& fails, the raw string is returned. If decoding
9783 .cindex "binary zero" "in header line"
9784 produces a binary zero character, it is replaced by a question mark &-- this is
9785 what Exim does for binary zeros that are actually received in header lines.
9786
9787 .next
9788 &%header%& tries to translate the string as decoded by &%bheader%& to a
9789 standard character set. This is an attempt to produce the same string as would
9790 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9791 returned. Translation is attempted only on operating systems that support the
9792 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9793 a system Makefile or in &_Local/Makefile_&.
9794 .endlist ilist
9795
9796 In a filter file, the target character set for &%header%& can be specified by a
9797 command of the following form:
9798 .code
9799 headers charset "UTF-8"
9800 .endd
9801 This command affects all references to &$h_$& (or &$header_$&) expansions in
9802 subsequently obeyed filter commands. In the absence of this command, the target
9803 character set in a filter is taken from the setting of the &%headers_charset%&
9804 option in the runtime configuration. The value of this option defaults to the
9805 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9806 ISO-8859-1.
9807
9808 Header names follow the syntax of RFC 2822, which states that they may contain
9809 any printing characters except space and colon. Consequently, curly brackets
9810 &'do not'& terminate header names, and should not be used to enclose them as
9811 if they were variables. Attempting to do so causes a syntax error.
9812
9813 Only header lines that are common to all copies of a message are visible to
9814 this mechanism. These are the original header lines that are received with the
9815 message, and any that are added by an ACL statement or by a system
9816 filter. Header lines that are added to a particular copy of a message by a
9817 router or transport are not accessible.
9818
9819 For incoming SMTP messages, no header lines are visible in
9820 ACLs that are obeyed before the data phase completes,
9821 because the header structure is not set up until the message is received.
9822 They are visible in DKIM, PRDR and DATA ACLs.
9823 Header lines that are added in a RCPT ACL (for example)
9824 are saved until the message's incoming header lines are available, at which
9825 point they are added.
9826 When any of the above ACLs ar
9827 running, however, header lines added by earlier ACLs are visible.
9828
9829 Upper case and lower case letters are synonymous in header names. If the
9830 following character is white space, the terminating colon may be omitted, but
9831 this is not recommended, because you may then forget it when it is needed. When
9832 white space terminates the header name, this white space is included in the
9833 expanded string.  If the message does not contain the given header, the
9834 expansion item is replaced by an empty string. (See the &%def%& condition in
9835 section &<<SECTexpcond>>& for a means of testing for the existence of a
9836 header.)
9837
9838 If there is more than one header with the same name, they are all concatenated
9839 to form the substitution string, up to a maximum length of 64K. Unless
9840 &%rheader%& is being used, leading and trailing white space is removed from
9841 each header before concatenation, and a completely empty header is ignored. A
9842 newline character is then inserted between non-empty headers, but there is no
9843 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9844 those headers that contain lists of addresses, a comma is also inserted at the
9845 junctions between headers. This does not happen for the &%rheader%& expansion.
9846
9847 .new
9848 .cindex "tainted data"
9849 When the headers are from an incoming message,
9850 the result of expanding any of these variables is tainted.
9851 .wen
9852
9853
9854 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9855 .cindex "expansion" "hmac hashing"
9856 .cindex &%hmac%&
9857 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9858 shared secret and some text into a message authentication code, as specified in
9859 RFC 2104. This differs from &`${md5:secret_text...}`& or
9860 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9861 cryptographic hash, allowing for authentication that is not possible with MD5
9862 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9863 present. For example:
9864 .code
9865 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9866 .endd
9867 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9868 produces:
9869 .code
9870 dd97e3ba5d1a61b5006108f8c8252953
9871 .endd
9872 As an example of how this might be used, you might put in the main part of
9873 an Exim configuration:
9874 .code
9875 SPAMSCAN_SECRET=cohgheeLei2thahw
9876 .endd
9877 In a router or a transport you could then have:
9878 .code
9879 headers_add = \
9880   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9881   ${hmac{md5}{SPAMSCAN_SECRET}\
9882   {${primary_hostname},${message_exim_id},$h_message-id:}}
9883 .endd
9884 Then given a message, you can check where it was scanned by looking at the
9885 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9886 this header line is authentic by recomputing the authentication code from the
9887 host name, message ID and the &'Message-id:'& header line. This can be done
9888 using Exim's &%-be%& option, or by other means, for example, by using the
9889 &'hmac_md5_hex()'& function in Perl.
9890
9891
9892 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9893 .cindex "expansion" "conditional"
9894 .cindex "&%if%&, expansion item"
9895 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9896 item; otherwise <&'string2'&> is used. The available conditions are described
9897 in section &<<SECTexpcond>>& below. For example:
9898 .code
9899 ${if eq {$local_part}{postmaster} {yes}{no} }
9900 .endd
9901 The second string need not be present; if it is not and the condition is not
9902 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9903 be present instead of the second string (without any curly brackets). In this
9904 case, the expansion is forced to fail if the condition is not true (see section
9905 &<<SECTforexpfai>>&).
9906
9907 If both strings are omitted, the result is the string &`true`& if the condition
9908 is true, and the empty string if the condition is false. This makes it less
9909 cumbersome to write custom ACL and router conditions. For example, instead of
9910 .code
9911 condition = ${if >{$acl_m4}{3}{true}{false}}
9912 .endd
9913 you can use
9914 .code
9915 condition = ${if >{$acl_m4}{3}}
9916 .endd
9917
9918
9919
9920 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9921 .cindex expansion "imap folder"
9922 .cindex "&%imapfolder%& expansion item"
9923 This item converts a (possibly multilevel, or with non-ASCII characters)
9924 folder specification to a Maildir name for filesystem use.
9925 For information on internationalisation support see &<<SECTi18nMDA>>&.
9926
9927
9928
9929 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9930 .cindex "expansion" "string truncation"
9931 .cindex "&%length%& expansion item"
9932 The &%length%& item is used to extract the initial portion of a string. Both
9933 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9934 you are using a fixed value for the number, that is, if <&'string1'&> does not
9935 change when expanded, you can use the simpler operator notation that avoids
9936 some of the braces:
9937 .code
9938 ${length_<n>:<string>}
9939 .endd
9940 The result of this item is either the first <&'n'&> bytes or the whole
9941 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9942 &%strlen%&, which gives the length of a string.
9943 All measurement is done in bytes and is not UTF-8 aware.
9944
9945
9946 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9947         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9948 .cindex "expansion" "extracting list elements by number"
9949 .cindex "&%listextract%&" "extract list elements by number"
9950 .cindex "list" "extracting elements by number"
9951 The <&'number'&> argument must consist entirely of decimal digits,
9952 apart from an optional leading minus,
9953 and leading and trailing white space (which is ignored).
9954
9955 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9956 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9957
9958 The first field of the list is numbered one.
9959 If the number is negative, the fields are
9960 counted from the end of the list, with the rightmost one numbered -1.
9961 The numbered element of the list is extracted and placed in &$value$&,
9962 then <&'string2'&> is expanded as the result.
9963
9964 If the modulus of the
9965 number is zero or greater than the number of fields in the string,
9966 the result is the expansion of <&'string3'&>.
9967
9968 For example:
9969 .code
9970 ${listextract{2}{x:42:99}}
9971 .endd
9972 yields &"42"&, and
9973 .code
9974 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9975 .endd
9976 yields &"result: 42"&.
9977
9978 If {<&'string3'&>} is omitted, an empty string is used for string3.
9979 If {<&'string2'&>} is also omitted, the value that was
9980 extracted is used.
9981 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9982
9983
9984 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9985         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9986 This is the first of one of two different types of lookup item, which are both
9987 described in the next item.
9988
9989 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9990         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9991 .cindex "expansion" "lookup in"
9992 .cindex "file" "lookups"
9993 .cindex "lookup" "in expanded string"
9994 The two forms of lookup item specify data lookups in files and databases, as
9995 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9996 lookups, and the second is used for query-style lookups. The <&'key'&>,
9997 <&'file'&>, and <&'query'&> strings are expanded before use.
9998
9999 If there is any white space in a lookup item which is part of a filter command,
10000 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10001 other place where white space is significant, the lookup item must be enclosed
10002 in double quotes. The use of data lookups in users' filter files may be locked
10003 out by the system administrator.
10004
10005 .vindex "&$value$&"
10006 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10007 During its expansion, the variable &$value$& contains the data returned by the
10008 lookup. Afterwards it reverts to the value it had previously (at the outer
10009 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10010 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10011 string on failure. If <&'string2'&> is provided, it can itself be a nested
10012 lookup, thus providing a mechanism for looking up a default value when the
10013 original lookup fails.
10014
10015 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10016 data for the outer lookup while the parameters of the second lookup are
10017 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10018 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10019 appear, and in this case, if the lookup fails, the entire expansion is forced
10020 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10021 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10022 successful lookup, and nothing in the case of failure.
10023
10024 For single-key lookups, the string &"partial"& is permitted to precede the
10025 search type in order to do partial matching, and * or *@ may follow a search
10026 type to request default lookups if the key does not match (see sections
10027 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10028
10029 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10030 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10031 and non-wild parts of the key during the expansion of the replacement text.
10032 They return to their previous values at the end of the lookup item.
10033
10034 This example looks up the postmaster alias in the conventional alias file:
10035 .code
10036 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10037 .endd
10038 This example uses NIS+ to look up the full name of the user corresponding to
10039 the local part of an address, forcing the expansion to fail if it is not found:
10040 .code
10041 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10042   {$value}fail}
10043 .endd
10044
10045
10046 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10047 .cindex "expansion" "list creation"
10048 .vindex "&$item$&"
10049 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10050 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10051 For each item
10052 in this list, its value is place in &$item$&, and then <&'string2'&> is
10053 expanded and added to the output as an item in a new list. The separator used
10054 for the output list is the same as the one used for the input, but a separator
10055 setting is not included in the output. For example:
10056 .code
10057 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10058 .endd
10059 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10060 value of &$item$& is restored to what it was before. See also the &%filter%&
10061 and &%reduce%& expansion items.
10062
10063 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10064 .cindex "expansion" "numeric hash"
10065 .cindex "hash function" "numeric"
10066 The three strings are expanded; the first two must yield numbers. Call them
10067 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10068 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10069 can use the simpler operator notation that avoids some of the braces:
10070 .code
10071 ${nhash_<n>_<m>:<string>}
10072 .endd
10073 The second number is optional (in both notations). If there is only one number,
10074 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10075 processed by a div/mod hash function that returns two numbers, separated by a
10076 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10077 example,
10078 .code
10079 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10080 .endd
10081 returns the string &"6/33"&.
10082
10083
10084
10085 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10086 .cindex "Perl" "use in expanded string"
10087 .cindex "expansion" "calling Perl from"
10088 This item is available only if Exim has been built to include an embedded Perl
10089 interpreter. The subroutine name and the arguments are first separately
10090 expanded, and then the Perl subroutine is called with those arguments. No
10091 additional arguments need be given; the maximum number permitted, including the
10092 name of the subroutine, is nine.
10093
10094 The return value of the subroutine is inserted into the expanded string, unless
10095 the return value is &%undef%&. In that case, the expansion fails in the same
10096 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10097 Whatever you return is evaluated in a scalar context. For example, if you
10098 return the name of a Perl vector, the return value is the size of the vector,
10099 not its contents.
10100
10101 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10102 with the error message that was passed to &%die%&. More details of the embedded
10103 Perl facility are given in chapter &<<CHAPperl>>&.
10104
10105 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10106 out the use of this expansion item in filter files.
10107
10108
10109 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10110 .cindex "&%prvs%& expansion item"
10111 The first argument is a complete email address and the second is secret
10112 keystring. The third argument, specifying a key number, is optional. If absent,
10113 it defaults to 0. The result of the expansion is a prvs-signed email address,
10114 to be typically used with the &%return_path%& option on an &(smtp)& transport
10115 as part of a bounce address tag validation (BATV) scheme. For more discussion
10116 and an example, see section &<<SECTverifyPRVS>>&.
10117
10118 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10119         {*&<&'string'&>&*}}*&"
10120 .cindex "&%prvscheck%& expansion item"
10121 This expansion item is the complement of the &%prvs%& item. It is used for
10122 checking prvs-signed addresses. If the expansion of the first argument does not
10123 yield a syntactically valid prvs-signed address, the whole item expands to the
10124 empty string. When the first argument does expand to a syntactically valid
10125 prvs-signed address, the second argument is expanded, with the prvs-decoded
10126 version of the address and the key number extracted from the address in the
10127 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10128
10129 These two variables can be used in the expansion of the second argument to
10130 retrieve the secret. The validity of the prvs-signed address is then checked
10131 against the secret. The result is stored in the variable &$prvscheck_result$&,
10132 which is empty for failure or &"1"& for success.
10133
10134 The third argument is optional; if it is missing, it defaults to an empty
10135 string. This argument is now expanded. If the result is an empty string, the
10136 result of the expansion is the decoded version of the address. This is the case
10137 whether or not the signature was valid. Otherwise, the result of the expansion
10138 is the expansion of the third argument.
10139
10140 All three variables can be used in the expansion of the third argument.
10141 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10142 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10143
10144 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10145 .cindex "expansion" "inserting an entire file"
10146 .cindex "file" "inserting into expansion"
10147 .cindex "&%readfile%& expansion item"
10148 The filename and end-of-line string are first expanded separately. The file is
10149 then read, and its contents replace the entire item. All newline characters in
10150 the file are replaced by the end-of-line string if it is present. Otherwise,
10151 newlines are left in the string.
10152 String expansion is not applied to the contents of the file. If you want this,
10153 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10154 the string expansion fails.
10155
10156 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10157 locks out the use of this expansion item in filter files.
10158
10159
10160
10161 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10162         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10163 .cindex "expansion" "inserting from a socket"
10164 .cindex "socket, use of in expansion"
10165 .cindex "&%readsocket%& expansion item"
10166 This item inserts data from a Unix domain or TCP socket into the expanded
10167 string. The minimal way of using it uses just two arguments, as in these
10168 examples:
10169 .code
10170 ${readsocket{/socket/name}{request string}}
10171 ${readsocket{inet:some.host:1234}{request string}}
10172 .endd
10173 For a Unix domain socket, the first substring must be the path to the socket.
10174 For an Internet socket, the first substring must contain &`inet:`& followed by
10175 a host name or IP address, followed by a colon and a port, which can be a
10176 number or the name of a TCP port in &_/etc/services_&. An IP address may
10177 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10178 example:
10179 .code
10180 ${readsocket{inet:[::1]:1234}{request string}}
10181 .endd
10182 Only a single host name may be given, but if looking it up yields more than
10183 one IP address, they are each tried in turn until a connection is made. For
10184 both kinds of socket, Exim makes a connection, writes the request string
10185 unless it is an empty string; and no terminating NUL is ever sent)
10186 and reads from the socket until an end-of-file
10187 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10188 extend what can be done. Firstly, you can vary the timeout. For example:
10189 .code
10190 ${readsocket{/socket/name}{request string}{3s}}
10191 .endd
10192
10193 The third argument is a list of options, of which the first element is the timeout
10194 and must be present if the argument is given.
10195 Further elements are options of form &'name=value'&.
10196 Two option types is currently recognised: shutdown and tls.
10197 The first defines whether (the default)
10198 or not a shutdown is done on the connection after sending the request.
10199 Example, to not do so (preferred, eg. by some webservers):
10200 .code
10201 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10202 .endd
10203 The second, tls, controls the use of TLS on the connection.  Example:
10204 .code
10205 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10206 .endd
10207 The default is to not use TLS.
10208 If it is enabled, a shutdown as descripbed above is never done.
10209
10210 A fourth argument allows you to change any newlines that are in the data
10211 that is read, in the same way as for &%readfile%& (see above). This example
10212 turns them into spaces:
10213 .code
10214 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10215 .endd
10216 As with all expansions, the substrings are expanded before the processing
10217 happens. Errors in these sub-expansions cause the expansion to fail. In
10218 addition, the following errors can occur:
10219
10220 .ilist
10221 Failure to create a socket file descriptor;
10222 .next
10223 Failure to connect the socket;
10224 .next
10225 Failure to write the request string;
10226 .next
10227 Timeout on reading from the socket.
10228 .endlist
10229
10230 By default, any of these errors causes the expansion to fail. However, if
10231 you supply a fifth substring, it is expanded and used when any of the above
10232 errors occurs. For example:
10233 .code
10234 ${readsocket{/socket/name}{request string}{3s}{\n}\
10235   {socket failure}}
10236 .endd
10237 You can test for the existence of a Unix domain socket by wrapping this
10238 expansion in &`${if exists`&, but there is a race condition between that test
10239 and the actual opening of the socket, so it is safer to use the fifth argument
10240 if you want to be absolutely sure of avoiding an expansion error for a
10241 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10242
10243 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10244 locks out the use of this expansion item in filter files.
10245
10246
10247 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10248 .cindex "expansion" "reducing a list to a scalar"
10249 .cindex "list" "reducing to a scalar"
10250 .vindex "&$value$&"
10251 .vindex "&$item$&"
10252 This operation reduces a list to a single, scalar string. After expansion,
10253 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10254 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10255 Then <&'string2'&> is expanded and
10256 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10257 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10258 them. The result of that expansion is assigned to &$value$& before the next
10259 iteration. When the end of the list is reached, the final value of &$value$& is
10260 added to the expansion output. The &%reduce%& expansion item can be used in a
10261 number of ways. For example, to add up a list of numbers:
10262 .code
10263 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10264 .endd
10265 The result of that expansion would be &`6`&. The maximum of a list of numbers
10266 can be found:
10267 .code
10268 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10269 .endd
10270 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10271 restored to what they were before. See also the &%filter%& and &%map%&
10272 expansion items.
10273
10274 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10275 This item inserts &"raw"& header lines. It is described with the &%header%&
10276 expansion item in section &<<SECTexpansionitems>>& above.
10277
10278 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10279         {*&<&'string2'&>&*}}*&"
10280 .cindex "expansion" "running a command"
10281 .cindex "&%run%& expansion item"
10282 The command and its arguments are first expanded as one string. The string is
10283 split apart into individual arguments by spaces, and then the command is run
10284 in a separate process, but under the same uid and gid.  As in other command
10285 executions from Exim, a shell is not used by default. If the command requires
10286 a shell, you must explicitly code it.
10287
10288 Since the arguments are split by spaces, when there is a variable expansion
10289 which has an empty result, it will cause the situation that the argument will
10290 simply be omitted when the program is actually executed by Exim. If the
10291 script/program requires a specific number of arguments and the expanded
10292 variable could possibly result in this empty expansion, the variable must be
10293 quoted. This is more difficult if the expanded variable itself could result
10294 in a string containing quotes, because it would interfere with the quotes
10295 around the command arguments. A possible guard against this is to wrap the
10296 variable in the &%sg%& operator to change any quote marks to some other
10297 character.
10298
10299 The standard input for the command exists, but is empty. The standard output
10300 and standard error are set to the same file descriptor.
10301 .cindex "return code" "from &%run%& expansion"
10302 .vindex "&$value$&"
10303 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10304 and replaces the entire item; during this expansion, the standard output/error
10305 from the command is in the variable &$value$&. If the command fails,
10306 <&'string2'&>, if present, is expanded and used. Once again, during the
10307 expansion, the standard output/error from the command is in the variable
10308 &$value$&.
10309
10310 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10311 can be the word &"fail"& (not in braces) to force expansion failure if the
10312 command does not succeed. If both strings are omitted, the result is contents
10313 of the standard output/error on success, and nothing on failure.
10314
10315 .vindex "&$run_in_acl$&"
10316 The standard output/error of the command is put in the variable &$value$&.
10317 In this ACL example, the output of a command is logged for the admin to
10318 troubleshoot:
10319 .code
10320 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10321       log_message  = Output of id: $value
10322 .endd
10323 If the command requires shell idioms, such as the > redirect operator, the
10324 shell must be invoked directly, such as with:
10325 .code
10326 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10327 .endd
10328
10329 .vindex "&$runrc$&"
10330 The return code from the command is put in the variable &$runrc$&, and this
10331 remains set afterwards, so in a filter file you can do things like this:
10332 .code
10333 if "${run{x y z}{}}$runrc" is 1 then ...
10334   elif $runrc is 2 then ...
10335   ...
10336 endif
10337 .endd
10338 If execution of the command fails (for example, the command does not exist),
10339 the return code is 127 &-- the same code that shells use for non-existent
10340 commands.
10341
10342 &*Warning*&: In a router or transport, you cannot assume the order in which
10343 option values are expanded, except for those preconditions whose order of
10344 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10345 by the expansion of one option, and use it in another.
10346
10347 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10348 out the use of this expansion item in filter files.
10349
10350
10351 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10352 .cindex "expansion" "string substitution"
10353 .cindex "&%sg%& expansion item"
10354 This item works like Perl's substitution operator (s) with the global (/g)
10355 option; hence its name. However, unlike the Perl equivalent, Exim does not
10356 modify the subject string; instead it returns the modified string for insertion
10357 into the overall expansion. The item takes three arguments: the subject string,
10358 a regular expression, and a substitution string. For example:
10359 .code
10360 ${sg{abcdefabcdef}{abc}{xyz}}
10361 .endd
10362 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10363 if any $, } or \ characters are required in the regular expression or in the
10364 substitution string, they have to be escaped. For example:
10365 .code
10366 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10367 .endd
10368 yields &"defabc"&, and
10369 .code
10370 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10371 .endd
10372 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10373 the regular expression from string expansion.
10374
10375 The regular expression is compiled in 8-bit mode, working against bytes
10376 rather than any Unicode-aware character handling.
10377
10378
10379 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10380 .cindex sorting "a list"
10381 .cindex list sorting
10382 .cindex expansion "list sorting"
10383 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10384 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10385 The <&'comparator'&> argument is interpreted as the operator
10386 of a two-argument expansion condition.
10387 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10388 The comparison should return true when applied to two values
10389 if the first value should sort before the second value.
10390 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10391 the element being placed in &$item$&,
10392 to give values for comparison.
10393
10394 The item result is a sorted list,
10395 with the original list separator,
10396 of the list elements (in full) of the original.
10397
10398 Examples:
10399 .code
10400 ${sort{3:2:1:4}{<}{$item}}
10401 .endd
10402 sorts a list of numbers, and
10403 .code
10404 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10405 .endd
10406 will sort an MX lookup into priority order.
10407
10408
10409 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10410 .cindex "&%substr%& expansion item"
10411 .cindex "substring extraction"
10412 .cindex "expansion" "substring extraction"
10413 The three strings are expanded; the first two must yield numbers. Call them
10414 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10415 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10416 can use the simpler operator notation that avoids some of the braces:
10417 .code
10418 ${substr_<n>_<m>:<string>}
10419 .endd
10420 The second number is optional (in both notations).
10421 If it is absent in the simpler format, the preceding underscore must also be
10422 omitted.
10423
10424 The &%substr%& item can be used to extract more general substrings than
10425 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10426 length required. For example
10427 .code
10428 ${substr{3}{2}{$local_part}}
10429 .endd
10430 If the starting offset is greater than the string length the result is the
10431 null string; if the length plus starting offset is greater than the string
10432 length, the result is the right-hand part of the string, starting from the
10433 given offset. The first byte (character) in the string has offset zero.
10434
10435 The &%substr%& expansion item can take negative offset values to count
10436 from the right-hand end of its operand. The last byte (character) is offset -1,
10437 the second-last is offset -2, and so on. Thus, for example,
10438 .code
10439 ${substr{-5}{2}{1234567}}
10440 .endd
10441 yields &"34"&. If the absolute value of a negative offset is greater than the
10442 length of the string, the substring starts at the beginning of the string, and
10443 the length is reduced by the amount of overshoot. Thus, for example,
10444 .code
10445 ${substr{-5}{2}{12}}
10446 .endd
10447 yields an empty string, but
10448 .code
10449 ${substr{-3}{2}{12}}
10450 .endd
10451 yields &"1"&.
10452
10453 When the second number is omitted from &%substr%&, the remainder of the string
10454 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10455 string preceding the offset point are taken. For example, an offset of -1 and
10456 no length, as in these semantically identical examples:
10457 .code
10458 ${substr_-1:abcde}
10459 ${substr{-1}{abcde}}
10460 .endd
10461 yields all but the last character of the string, that is, &"abcd"&.
10462
10463 All measurement is done in bytes and is not UTF-8 aware.
10464
10465
10466
10467 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10468         {*&<&'replacements'&>&*}}*&"
10469 .cindex "expansion" "character translation"
10470 .cindex "&%tr%& expansion item"
10471 This item does single-character (in bytes) translation on its subject string. The second
10472 argument is a list of characters to be translated in the subject string. Each
10473 matching character is replaced by the corresponding character from the
10474 replacement list. For example
10475 .code
10476 ${tr{abcdea}{ac}{13}}
10477 .endd
10478 yields &`1b3de1`&. If there are duplicates in the second character string, the
10479 last occurrence is used. If the third string is shorter than the second, its
10480 last character is replicated. However, if it is empty, no translation takes
10481 place.
10482
10483 All character handling is done in bytes and is not UTF-8 aware.
10484
10485 .endlist
10486
10487
10488
10489 .section "Expansion operators" "SECTexpop"
10490 .cindex "expansion" "operators"
10491 For expansion items that perform transformations on a single argument string,
10492 the &"operator"& notation is used because it is simpler and uses fewer braces.
10493 The substring is first expanded before the operation is applied to it. The
10494 following operations can be performed:
10495
10496 .vlist
10497 .vitem &*${address:*&<&'string'&>&*}*&
10498 .cindex "expansion" "RFC 2822 address handling"
10499 .cindex "&%address%& expansion item"
10500 The string is interpreted as an RFC 2822 address, as it might appear in a
10501 header line, and the effective address is extracted from it. If the string does
10502 not parse successfully, the result is empty.
10503
10504 The parsing correctly handles SMTPUTF8 Unicode in the string.
10505
10506
10507 .vitem &*${addresses:*&<&'string'&>&*}*&
10508 .cindex "expansion" "RFC 2822 address handling"
10509 .cindex "&%addresses%& expansion item"
10510 The string (after expansion) is interpreted as a list of addresses in RFC
10511 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10512 operative address (&'local-part@domain'&) is extracted from each item, and the
10513 result of the expansion is a colon-separated list, with appropriate
10514 doubling of colons should any happen to be present in the email addresses.
10515 Syntactically invalid RFC2822 address items are omitted from the output.
10516
10517 It is possible to specify a character other than colon for the output
10518 separator by starting the string with > followed by the new separator
10519 character. For example:
10520 .code
10521 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10522 .endd
10523 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10524 first, so if the expanded string starts with >, it may change the output
10525 separator unintentionally. This can be avoided by setting the output
10526 separator explicitly:
10527 .code
10528 ${addresses:>:$h_from:}
10529 .endd
10530
10531 Compare the &%address%& (singular)
10532 expansion item, which extracts the working address from a single RFC2822
10533 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10534 processing lists.
10535
10536 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10537 a strict interpretation of header line formatting.  Exim parses the bare,
10538 unquoted portion of an email address and if it finds a comma, treats it as an
10539 email address separator. For the example header line:
10540 .code
10541 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10542 .endd
10543 The first example below demonstrates that Q-encoded email addresses are parsed
10544 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10545 It does not see the comma because it's still encoded as "=2C".  The second
10546 example below is passed the contents of &`$header_from:`&, meaning it gets
10547 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10548 The third example shows that the presence of a comma is skipped when it is
10549 quoted.  The fourth example shows SMTPUTF8 handling.
10550 .code
10551 # exim -be '${addresses:From: \
10552 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10553 user@example.com
10554 # exim -be '${addresses:From: Last, First <user@example.com>}'
10555 Last:user@example.com
10556 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10557 user@example.com
10558 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10559 フィリップ@example.jp
10560 .endd
10561
10562 .vitem &*${base32:*&<&'digits'&>&*}*&
10563 .cindex "&%base32%& expansion item"
10564 .cindex "expansion" "conversion to base 32"
10565 The string must consist entirely of decimal digits. The number is converted to
10566 base 32 and output as a (empty, for zero) string of characters.
10567 Only lowercase letters are used.
10568
10569 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10570 .cindex "&%base32d%& expansion item"
10571 .cindex "expansion" "conversion to base 32"
10572 The string must consist entirely of base-32 digits.
10573 The number is converted to decimal and output as a string.
10574
10575 .vitem &*${base62:*&<&'digits'&>&*}*&
10576 .cindex "&%base62%& expansion item"
10577 .cindex "expansion" "conversion to base 62"
10578 The string must consist entirely of decimal digits. The number is converted to
10579 base 62 and output as a string of six characters, including leading zeros. In
10580 the few operating environments where Exim uses base 36 instead of base 62 for
10581 its message identifiers (because those systems do not have case-sensitive
10582 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10583 to be absolutely clear: this is &'not'& base64 encoding.
10584
10585 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10586 .cindex "&%base62d%& expansion item"
10587 .cindex "expansion" "conversion to base 62"
10588 The string must consist entirely of base-62 digits, or, in operating
10589 environments where Exim uses base 36 instead of base 62 for its message
10590 identifiers, base-36 digits. The number is converted to decimal and output as a
10591 string.
10592
10593 .vitem &*${base64:*&<&'string'&>&*}*&
10594 .cindex "expansion" "base64 encoding"
10595 .cindex "base64 encoding" "in string expansion"
10596 .cindex "&%base64%& expansion item"
10597 .cindex certificate "base64 of DER"
10598 This operator converts a string into one that is base64 encoded.
10599
10600 If the string is a single variable of type certificate,
10601 returns the base64 encoding of the DER form of the certificate.
10602
10603
10604 .vitem &*${base64d:*&<&'string'&>&*}*&
10605 .cindex "expansion" "base64 decoding"
10606 .cindex "base64 decoding" "in string expansion"
10607 .cindex "&%base64d%& expansion item"
10608 This operator converts a base64-encoded string into the un-coded form.
10609
10610
10611 .vitem &*${domain:*&<&'string'&>&*}*&
10612 .cindex "domain" "extraction"
10613 .cindex "expansion" "domain extraction"
10614 The string is interpreted as an RFC 2822 address and the domain is extracted
10615 from it. If the string does not parse successfully, the result is empty.
10616
10617
10618 .vitem &*${escape:*&<&'string'&>&*}*&
10619 .cindex "expansion" "escaping non-printing characters"
10620 .cindex "&%escape%& expansion item"
10621 If the string contains any non-printing characters, they are converted to
10622 escape sequences starting with a backslash. Whether characters with the most
10623 significant bit set (so-called &"8-bit characters"&) count as printing or not
10624 is controlled by the &%print_topbitchars%& option.
10625
10626 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10627 .cindex "expansion" "escaping 8-bit characters"
10628 .cindex "&%escape8bit%& expansion item"
10629 If the string contains and characters with the most significant bit set,
10630 they are converted to escape sequences starting with a backslash.
10631 Backslashes and DEL characters are also converted.
10632
10633
10634 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10635 .cindex "expansion" "expression evaluation"
10636 .cindex "expansion" "arithmetic expression"
10637 .cindex "&%eval%& expansion item"
10638 These items supports simple arithmetic and bitwise logical operations in
10639 expansion strings. The string (after expansion) must be a conventional
10640 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10641 logical operators, and parentheses. All operations are carried out using
10642 integer arithmetic. The operator priorities are as follows (the same as in the
10643 C programming language):
10644 .table2 70pt 300pt
10645 .irow &'highest:'& "not (~), negate (-)"
10646 .irow ""   "multiply (*), divide (/), remainder (%)"
10647 .irow ""   "plus (+), minus (-)"
10648 .irow ""   "shift-left (<<), shift-right (>>)"
10649 .irow ""   "and (&&)"
10650 .irow ""   "xor (^)"
10651 .irow &'lowest:'&  "or (|)"
10652 .endtable
10653 Binary operators with the same priority are evaluated from left to right. White
10654 space is permitted before or after operators.
10655
10656 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10657 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10658 decimal, even if they start with a leading zero; hexadecimal numbers are not
10659 permitted. This can be useful when processing numbers extracted from dates or
10660 times, which often do have leading zeros.
10661
10662 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10663 or 1024*1024*1024,
10664 respectively. Negative numbers are supported. The result of the computation is
10665 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10666
10667 .display
10668 &`${eval:1+1}            `&  yields 2
10669 &`${eval:1+2*3}          `&  yields 7
10670 &`${eval:(1+2)*3}        `&  yields 9
10671 &`${eval:2+42%5}         `&  yields 4
10672 &`${eval:0xc&amp;5}          `&  yields 4
10673 &`${eval:0xc|5}          `&  yields 13
10674 &`${eval:0xc^5}          `&  yields 9
10675 &`${eval:0xc>>1}         `&  yields 6
10676 &`${eval:0xc<<1}         `&  yields 24
10677 &`${eval:~255&amp;0x1234}    `&  yields 4608
10678 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10679 .endd
10680
10681 As a more realistic example, in an ACL you might have
10682 .code
10683 deny   message = Too many bad recipients
10684        condition =                    \
10685          ${if and {                   \
10686            {>{$rcpt_count}{10}}       \
10687            {                          \
10688            <                          \
10689              {$recipients_count}      \
10690              {${eval:$rcpt_count/2}}  \
10691            }                          \
10692          }{yes}{no}}
10693 .endd
10694 The condition is true if there have been more than 10 RCPT commands and
10695 fewer than half of them have resulted in a valid recipient.
10696
10697
10698 .vitem &*${expand:*&<&'string'&>&*}*&
10699 .cindex "expansion" "re-expansion of substring"
10700 The &%expand%& operator causes a string to be expanded for a second time. For
10701 example,
10702 .code
10703 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10704 .endd
10705 first looks up a string in a file while expanding the operand for &%expand%&,
10706 and then re-expands what it has found.
10707
10708
10709 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10710 .cindex "Unicode"
10711 .cindex "UTF-8" "conversion from"
10712 .cindex "expansion" "UTF-8 conversion"
10713 .cindex "&%from_utf8%& expansion item"
10714 The world is slowly moving towards Unicode, although there are no standards for
10715 email yet. However, other applications (including some databases) are starting
10716 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10717 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10718 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10719 the result is an undefined sequence of bytes.
10720
10721 Unicode code points with values less than 256 are compatible with ASCII and
10722 ISO-8859-1 (also known as Latin-1).
10723 For example, character 169 is the copyright symbol in both cases, though the
10724 way it is encoded is different. In UTF-8, more than one byte is needed for
10725 characters with code values greater than 127, whereas ISO-8859-1 is a
10726 single-byte encoding (but thereby limited to 256 characters). This makes
10727 translation from UTF-8 to ISO-8859-1 straightforward.
10728
10729
10730 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10731 .cindex "hash function" "textual"
10732 .cindex "expansion" "textual hash"
10733 The &%hash%& operator is a simpler interface to the hashing function that can
10734 be used when the two parameters are fixed numbers (as opposed to strings that
10735 change when expanded). The effect is the same as
10736 .code
10737 ${hash{<n>}{<m>}{<string>}}
10738 .endd
10739 See the description of the general &%hash%& item above for details. The
10740 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10741
10742
10743
10744 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10745 .cindex "base64 encoding" "conversion from hex"
10746 .cindex "expansion" "hex to base64"
10747 .cindex "&%hex2b64%& expansion item"
10748 This operator converts a hex string into one that is base64 encoded. This can
10749 be useful for processing the output of the various hashing functions.
10750
10751
10752
10753 .vitem &*${hexquote:*&<&'string'&>&*}*&
10754 .cindex "quoting" "hex-encoded unprintable characters"
10755 .cindex "&%hexquote%& expansion item"
10756 This operator converts non-printable characters in a string into a hex
10757 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10758 as is, and other byte values are converted to &`\xNN`&, for example, a
10759 byte value 127 is converted to &`\x7f`&.
10760
10761
10762 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10763 .cindex "&%ipv6denorm%& expansion item"
10764 .cindex "IP address" normalisation
10765 This expands an IPv6 address to a full eight-element colon-separated set
10766 of hex digits including leading zeroes.
10767 A trailing ipv4-style dotted-decimal set is converted to hex.
10768 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10769
10770 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10771 .cindex "&%ipv6norm%& expansion item"
10772 .cindex "IP address" normalisation
10773 .cindex "IP address" "canonical form"
10774 This converts an IPv6 address to canonical form.
10775 Leading zeroes of groups are omitted, and the longest
10776 set of zero-valued groups is replaced with a double colon.
10777 A trailing ipv4-style dotted-decimal set is converted to hex.
10778 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10779
10780
10781 .vitem &*${lc:*&<&'string'&>&*}*&
10782 .cindex "case forcing in strings"
10783 .cindex "string" "case forcing"
10784 .cindex "lower casing"
10785 .cindex "expansion" "case forcing"
10786 .cindex "&%lc%& expansion item"
10787 This forces the letters in the string into lower-case, for example:
10788 .code
10789 ${lc:$local_part}
10790 .endd
10791 Case is defined per the system C locale.
10792
10793 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10794 .cindex "expansion" "string truncation"
10795 .cindex "&%length%& expansion item"
10796 The &%length%& operator is a simpler interface to the &%length%& function that
10797 can be used when the parameter is a fixed number (as opposed to a string that
10798 changes when expanded). The effect is the same as
10799 .code
10800 ${length{<number>}{<string>}}
10801 .endd
10802 See the description of the general &%length%& item above for details. Note that
10803 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10804 when &%length%& is used as an operator.
10805 All measurement is done in bytes and is not UTF-8 aware.
10806
10807
10808 .vitem &*${listcount:*&<&'string'&>&*}*&
10809 .cindex "expansion" "list item count"
10810 .cindex "list" "item count"
10811 .cindex "list" "count of items"
10812 .cindex "&%listcount%& expansion item"
10813 The string is interpreted as a list and the number of items is returned.
10814
10815
10816 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10817 .cindex "expansion" "named list"
10818 .cindex "&%listnamed%& expansion item"
10819 The name is interpreted as a named list and the content of the list is returned,
10820 expanding any referenced lists, re-quoting as needed for colon-separation.
10821 If the optional type is given it must be one of "a", "d", "h" or "l"
10822 and selects address-, domain-, host- or localpart- lists to search among respectively.
10823 Otherwise all types are searched in an undefined order and the first
10824 matching list is returned.
10825
10826
10827 .vitem &*${local_part:*&<&'string'&>&*}*&
10828 .cindex "expansion" "local part extraction"
10829 .cindex "&%local_part%& expansion item"
10830 The string is interpreted as an RFC 2822 address and the local part is
10831 extracted from it. If the string does not parse successfully, the result is
10832 empty.
10833 The parsing correctly handles SMTPUTF8 Unicode in the string.
10834
10835
10836 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10837 .cindex "masked IP address"
10838 .cindex "IP address" "masking"
10839 .cindex "CIDR notation"
10840 .cindex "expansion" "IP address masking"
10841 .cindex "&%mask%& expansion item"
10842 If the form of the string to be operated on is not an IP address followed by a
10843 slash and an integer (that is, a network address in CIDR notation), the
10844 expansion fails. Otherwise, this operator converts the IP address to binary,
10845 masks off the least significant bits according to the bit count, and converts
10846 the result back to text, with mask appended. For example,
10847 .code
10848 ${mask:10.111.131.206/28}
10849 .endd
10850 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10851 be mostly used for looking up masked addresses in files, the result for an IPv6
10852 address uses dots to separate components instead of colons, because colon
10853 terminates a key string in lsearch files. So, for example,
10854 .code
10855 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10856 .endd
10857 returns the string
10858 .code
10859 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10860 .endd
10861 Letters in IPv6 addresses are always output in lower case.
10862
10863
10864 .vitem &*${md5:*&<&'string'&>&*}*&
10865 .cindex "MD5 hash"
10866 .cindex "expansion" "MD5 hash"
10867 .cindex certificate fingerprint
10868 .cindex "&%md5%& expansion item"
10869 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10870 as a 32-digit hexadecimal number, in which any letters are in lower case.
10871
10872 If the string is a single variable of type certificate,
10873 returns the MD5 hash fingerprint of the certificate.
10874
10875
10876 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10877 .cindex "expansion" "numeric hash"
10878 .cindex "hash function" "numeric"
10879 The &%nhash%& operator is a simpler interface to the numeric hashing function
10880 that can be used when the two parameters are fixed numbers (as opposed to
10881 strings that change when expanded). The effect is the same as
10882 .code
10883 ${nhash{<n>}{<m>}{<string>}}
10884 .endd
10885 See the description of the general &%nhash%& item above for details.
10886
10887
10888 .vitem &*${quote:*&<&'string'&>&*}*&
10889 .cindex "quoting" "in string expansions"
10890 .cindex "expansion" "quoting"
10891 .cindex "&%quote%& expansion item"
10892 The &%quote%& operator puts its argument into double quotes if it
10893 is an empty string or
10894 contains anything other than letters, digits, underscores, dots, and hyphens.
10895 Any occurrences of double quotes and backslashes are escaped with a backslash.
10896 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10897 respectively For example,
10898 .code
10899 ${quote:ab"*"cd}
10900 .endd
10901 becomes
10902 .code
10903 "ab\"*\"cd"
10904 .endd
10905 The place where this is useful is when the argument is a substitution from a
10906 variable or a message header.
10907
10908 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10909 .cindex "&%quote_local_part%& expansion item"
10910 This operator is like &%quote%&, except that it quotes the string only if
10911 required to do so by the rules of RFC 2822 for quoting local parts. For
10912 example, a plus sign would not cause quoting (but it would for &%quote%&).
10913 If you are creating a new email address from the contents of &$local_part$&
10914 (or any other unknown data), you should always use this operator.
10915
10916 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10917 will likely use the quoting form.
10918 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10919
10920
10921 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10922 .cindex "quoting" "lookup-specific"
10923 This operator applies lookup-specific quoting rules to the string. Each
10924 query-style lookup type has its own quoting rules which are described with
10925 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10926 .code
10927 ${quote_ldap:two * two}
10928 .endd
10929 returns
10930 .code
10931 two%20%5C2A%20two
10932 .endd
10933 For single-key lookup types, no quoting is ever necessary and this operator
10934 yields an unchanged string.
10935
10936
10937 .vitem &*${randint:*&<&'n'&>&*}*&
10938 .cindex "random number"
10939 This operator returns a somewhat random number which is less than the
10940 supplied number and is at least 0.  The quality of this randomness depends
10941 on how Exim was built; the values are not suitable for keying material.
10942 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10943 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10944 for versions of GnuTLS with that function.
10945 Otherwise, the implementation may be arc4random(), random() seeded by
10946 srandomdev() or srandom(), or a custom implementation even weaker than
10947 random().
10948
10949
10950 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10951 .cindex "expansion" "IP address"
10952 This operator reverses an IP address; for IPv4 addresses, the result is in
10953 dotted-quad decimal form, while for IPv6 addresses the result is in
10954 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10955 for DNS.  For example,
10956 .code
10957 ${reverse_ip:192.0.2.4}
10958 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10959 .endd
10960 returns
10961 .code
10962 4.2.0.192
10963 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
10964 .endd
10965
10966
10967 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10968 .cindex "expansion" "RFC 2047"
10969 .cindex "RFC 2047" "expansion operator"
10970 .cindex "&%rfc2047%& expansion item"
10971 This operator encodes text according to the rules of RFC 2047. This is an
10972 encoding that is used in header lines to encode non-ASCII characters. It is
10973 assumed that the input string is in the encoding specified by the
10974 &%headers_charset%& option, which gets its default at build time. If the string
10975 contains only characters in the range 33&--126, and no instances of the
10976 characters
10977 .code
10978 ? = ( ) < > @ , ; : \ " . [ ] _
10979 .endd
10980 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10981 string, using as many &"encoded words"& as necessary to encode all the
10982 characters.
10983
10984
10985 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10986 .cindex "expansion" "RFC 2047"
10987 .cindex "RFC 2047" "decoding"
10988 .cindex "&%rfc2047d%& expansion item"
10989 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10990 bytes are replaced by question marks. Characters are converted into the
10991 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10992 not recognized unless &%check_rfc2047_length%& is set false.
10993
10994 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10995 access a header line, RFC 2047 decoding is done automatically. You do not need
10996 to use this operator as well.
10997
10998
10999
11000 .vitem &*${rxquote:*&<&'string'&>&*}*&
11001 .cindex "quoting" "in regular expressions"
11002 .cindex "regular expressions" "quoting"
11003 .cindex "&%rxquote%& expansion item"
11004 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11005 characters in its argument. This is useful when substituting the values of
11006 variables or headers inside regular expressions.
11007
11008
11009 .vitem &*${sha1:*&<&'string'&>&*}*&
11010 .cindex "SHA-1 hash"
11011 .cindex "expansion" "SHA-1 hashing"
11012 .cindex certificate fingerprint
11013 .cindex "&%sha1%& expansion item"
11014 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11015 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11016
11017 If the string is a single variable of type certificate,
11018 returns the SHA-1 hash fingerprint of the certificate.
11019
11020
11021 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11022        &*${sha2:*&<&'string'&>&*}*& &&&
11023        &*${sha2_<n>:*&<&'string'&>&*}*&
11024 .cindex "SHA-256 hash"
11025 .cindex "SHA-2 hash"
11026 .cindex certificate fingerprint
11027 .cindex "expansion" "SHA-256 hashing"
11028 .cindex "&%sha256%& expansion item"
11029 .cindex "&%sha2%& expansion item"
11030 The &%sha256%& operator computes the SHA-256 hash value of the string
11031 and returns
11032 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11033
11034 If the string is a single variable of type certificate,
11035 returns the SHA-256 hash fingerprint of the certificate.
11036
11037 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11038 (except for certificates, which are not supported).
11039 Finally, if an underbar
11040 and a number is appended it specifies the output length, selecting a
11041 member of the SHA-2 family of hash functions.
11042 Values of 256, 384 and 512 are accepted, with 256 being the default.
11043
11044
11045 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11046        &*${sha3_<n>:*&<&'string'&>&*}*&
11047 .cindex "SHA3 hash"
11048 .cindex "expansion" "SHA3 hashing"
11049 .cindex "&%sha3%& expansion item"
11050 The &%sha3%& operator computes the SHA3-256 hash value of the string
11051 and returns
11052 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11053
11054 If a number is appended, separated by an underbar, it specifies
11055 the output length.  Values of 224, 256, 384 and 512 are accepted;
11056 with 256 being the default.
11057
11058 The &%sha3%& expansion item is only supported if Exim has been
11059 compiled with GnuTLS 3.5.0 or later,
11060 or OpenSSL 1.1.1 or later.
11061 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11062
11063
11064 .vitem &*${stat:*&<&'string'&>&*}*&
11065 .cindex "expansion" "statting a file"
11066 .cindex "file" "extracting characteristics"
11067 .cindex "&%stat%& expansion item"
11068 The string, after expansion, must be a file path. A call to the &[stat()]&
11069 function is made for this path. If &[stat()]& fails, an error occurs and the
11070 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11071 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11072 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11073 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11074 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11075 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11076 can extract individual fields using the &%extract%& expansion item.
11077
11078 The use of the &%stat%& expansion in users' filter files can be locked out by
11079 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11080 systems for files larger than 2GB.
11081
11082 .vitem &*${str2b64:*&<&'string'&>&*}*&
11083 .cindex "&%str2b64%& expansion item"
11084 Now deprecated, a synonym for the &%base64%& expansion operator.
11085
11086
11087
11088 .vitem &*${strlen:*&<&'string'&>&*}*&
11089 .cindex "expansion" "string length"
11090 .cindex "string" "length in expansion"
11091 .cindex "&%strlen%& expansion item"
11092 The item is replace by the length of the expanded string, expressed as a
11093 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11094 All measurement is done in bytes and is not UTF-8 aware.
11095
11096
11097 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11098 .cindex "&%substr%& expansion item"
11099 .cindex "substring extraction"
11100 .cindex "expansion" "substring expansion"
11101 The &%substr%& operator is a simpler interface to the &%substr%& function that
11102 can be used when the two parameters are fixed numbers (as opposed to strings
11103 that change when expanded). The effect is the same as
11104 .code
11105 ${substr{<start>}{<length>}{<string>}}
11106 .endd
11107 See the description of the general &%substr%& item above for details. The
11108 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11109 All measurement is done in bytes and is not UTF-8 aware.
11110
11111 .vitem &*${time_eval:*&<&'string'&>&*}*&
11112 .cindex "&%time_eval%& expansion item"
11113 .cindex "time interval" "decoding"
11114 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11115 seconds.
11116
11117 .vitem &*${time_interval:*&<&'string'&>&*}*&
11118 .cindex "&%time_interval%& expansion item"
11119 .cindex "time interval" "formatting"
11120 The argument (after sub-expansion) must be a sequence of decimal digits that
11121 represents an interval of time as a number of seconds. It is converted into a
11122 number of larger units and output in Exim's normal time format, for example,
11123 &`1w3d4h2m6s`&.
11124
11125 .vitem &*${uc:*&<&'string'&>&*}*&
11126 .cindex "case forcing in strings"
11127 .cindex "string" "case forcing"
11128 .cindex "upper casing"
11129 .cindex "expansion" "case forcing"
11130 .cindex "&%uc%& expansion item"
11131 This forces the letters in the string into upper-case.
11132 Case is defined per the system C locale.
11133
11134 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11135 .cindex "correction of invalid utf-8 sequences in strings"
11136 .cindex "utf-8" "utf-8 sequences"
11137 .cindex "incorrect utf-8"
11138 .cindex "expansion" "utf-8 forcing"
11139 .cindex "&%utf8clean%& expansion item"
11140 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11141 In versions of Exim before 4.92, this did not correctly do so for a truncated
11142 final codepoint's encoding, and the character would be silently dropped.
11143 If you must handle detection of this scenario across both sets of Exim behavior,
11144 the complexity will depend upon the task.
11145 For instance, to detect if the first character is multibyte and a 1-byte
11146 extraction can be successfully used as a path component (as is common for
11147 dividing up delivery folders), you might use:
11148 .code
11149 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11150 .endd
11151 (which will false-positive if the first character of the local part is a
11152 literal question mark).
11153
11154 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11155        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11156        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11157        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11158 .cindex expansion UTF-8
11159 .cindex UTF-8 expansion
11160 .cindex EAI
11161 .cindex internationalisation
11162 .cindex "&%utf8_domain_to_alabel%& expansion item"
11163 .cindex "&%utf8_domain_from_alabel%& expansion item"
11164 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11165 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11166 These convert EAI mail name components between UTF-8 and a-label forms.
11167 For information on internationalisation support see &<<SECTi18nMTA>>&.
11168 .endlist
11169
11170
11171
11172
11173
11174
11175 .section "Expansion conditions" "SECTexpcond"
11176 .scindex IIDexpcond "expansion" "conditions"
11177 The following conditions are available for testing by the &%${if%& construct
11178 while expanding strings:
11179
11180 .vlist
11181 .vitem &*!*&<&'condition'&>
11182 .cindex "expansion" "negating a condition"
11183 .cindex "negation" "in expansion condition"
11184 Preceding any condition with an exclamation mark negates the result of the
11185 condition.
11186
11187 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11188 .cindex "numeric comparison"
11189 .cindex "expansion" "numeric comparison"
11190 There are a number of symbolic operators for doing numeric comparisons. They
11191 are:
11192 .display
11193 &`=   `&   equal
11194 &`==  `&   equal
11195 &`>   `&   greater
11196 &`>=  `&   greater or equal
11197 &`<   `&   less
11198 &`<=  `&   less or equal
11199 .endd
11200 For example:
11201 .code
11202 ${if >{$message_size}{10M} ...
11203 .endd
11204 Note that the general negation operator provides for inequality testing. The
11205 two strings must take the form of optionally signed decimal integers,
11206 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11207 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11208 As a special case, the numerical value of an empty string is taken as
11209 zero.
11210
11211 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11212 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11213 10M, not if 10M is larger than &$message_size$&.
11214
11215
11216 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11217         {*&<&'arg2'&>&*}...}*&
11218 .cindex "expansion" "calling an acl"
11219 .cindex "&%acl%&" "expansion condition"
11220 The name and zero to nine argument strings are first expanded separately.  The expanded
11221 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11222 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11223 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11224 and may use the variables; if another acl expansion is used the values
11225 are restored after it returns.  If the ACL sets
11226 a value using a "message =" modifier the variable $value becomes
11227 the result of the expansion, otherwise it is empty.
11228 If the ACL returns accept the condition is true; if deny, false.
11229 If the ACL returns defer the result is a forced-fail.
11230
11231 .vitem &*bool&~{*&<&'string'&>&*}*&
11232 .cindex "expansion" "boolean parsing"
11233 .cindex "&%bool%& expansion condition"
11234 This condition turns a string holding a true or false representation into
11235 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11236 (case-insensitively); also integer numbers map to true if non-zero,
11237 false if zero.
11238 An empty string is treated as false.
11239 Leading and trailing whitespace is ignored;
11240 thus a string consisting only of whitespace is false.
11241 All other string values will result in expansion failure.
11242
11243 When combined with ACL variables, this expansion condition will let you
11244 make decisions in one place and act on those decisions in another place.
11245 For example:
11246 .code
11247 ${if bool{$acl_m_privileged_sender} ...
11248 .endd
11249
11250
11251 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11252 .cindex "expansion" "boolean parsing"
11253 .cindex "&%bool_lax%& expansion condition"
11254 Like &%bool%&, this condition turns a string into a boolean state.  But
11255 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11256 loose definition that the Router &%condition%& option uses.  The empty string
11257 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11258 true.  Leading and trailing whitespace is ignored.
11259
11260 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11261
11262 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11263 .cindex "expansion" "encrypted comparison"
11264 .cindex "encrypted strings, comparing"
11265 .cindex "&%crypteq%& expansion condition"
11266 This condition is included in the Exim binary if it is built to support any
11267 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11268 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11269 included in the binary.
11270
11271 The &%crypteq%& condition has two arguments. The first is encrypted and
11272 compared against the second, which is already encrypted. The second string may
11273 be in the LDAP form for storing encrypted strings, which starts with the
11274 encryption type in curly brackets, followed by the data. If the second string
11275 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11276 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11277 Typically this will be a field from a password file. An example of an encrypted
11278 string in LDAP form is:
11279 .code
11280 {md5}CY9rzUYh03PK3k6DJie09g==
11281 .endd
11282 If such a string appears directly in an expansion, the curly brackets have to
11283 be quoted, because they are part of the expansion syntax. For example:
11284 .code
11285 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11286 .endd
11287 The following encryption types (whose names are matched case-independently) are
11288 supported:
11289
11290 .ilist
11291 .cindex "MD5 hash"
11292 .cindex "base64 encoding" "in encrypted password"
11293 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11294 printable characters to compare with the remainder of the second string. If the
11295 length of the comparison string is 24, Exim assumes that it is base64 encoded
11296 (as in the above example). If the length is 32, Exim assumes that it is a
11297 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11298 comparison fails.
11299
11300 .next
11301 .cindex "SHA-1 hash"
11302 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11303 printable characters to compare with the remainder of the second string. If the
11304 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11305 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11306 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11307
11308 .next
11309 .cindex "&[crypt()]&"
11310 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11311 only the first eight characters of the password. However, in modern operating
11312 systems this is no longer true, and in many cases the entire password is used,
11313 whatever its length.
11314
11315 .next
11316 .cindex "&[crypt16()]&"
11317 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11318 use up to 16 characters of the password in some operating systems. Again, in
11319 modern operating systems, more characters may be used.
11320 .endlist
11321 Exim has its own version of &[crypt16()]&, which is just a double call to
11322 &[crypt()]&. For operating systems that have their own version, setting
11323 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11324 operating system version instead of its own. This option is set by default in
11325 the OS-dependent &_Makefile_& for those operating systems that are known to
11326 support &[crypt16()]&.
11327
11328 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11329 it was not using the same algorithm as some operating systems' versions. It
11330 turns out that as well as &[crypt16()]& there is a function called
11331 &[bigcrypt()]& in some operating systems. This may or may not use the same
11332 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11333
11334 However, since there is now a move away from the traditional &[crypt()]&
11335 functions towards using SHA1 and other algorithms, tidying up this area of
11336 Exim is seen as very low priority.
11337
11338 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11339 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11340 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11341 default is &`{crypt}`&. Whatever the default, you can always use either
11342 function by specifying it explicitly in curly brackets.
11343
11344 .vitem &*def:*&<&'variable&~name'&>
11345 .cindex "expansion" "checking for empty variable"
11346 .cindex "&%def%& expansion condition"
11347 The &%def%& condition must be followed by the name of one of the expansion
11348 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11349 variable does not contain the empty string. For example:
11350 .code
11351 ${if def:sender_ident {from $sender_ident}}
11352 .endd
11353 Note that the variable name is given without a leading &%$%& character. If the
11354 variable does not exist, the expansion fails.
11355
11356 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11357         &~&*def:h_*&<&'header&~name'&>&*:*&"
11358 .cindex "expansion" "checking header line existence"
11359 This condition is true if a message is being processed and the named header
11360 exists in the message. For example,
11361 .code
11362 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11363 .endd
11364 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11365 the header name must be terminated by a colon if white space does not follow.
11366
11367 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11368        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11369 .cindex "string" "comparison"
11370 .cindex "expansion" "string comparison"
11371 .cindex "&%eq%& expansion condition"
11372 .cindex "&%eqi%& expansion condition"
11373 The two substrings are first expanded. The condition is true if the two
11374 resulting strings are identical. For &%eq%& the comparison includes the case of
11375 letters, whereas for &%eqi%& the comparison is case-independent, where
11376 case is defined per the system C locale.
11377
11378 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11379 .cindex "expansion" "file existence test"
11380 .cindex "file" "existence test"
11381 .cindex "&%exists%&, expansion condition"
11382 The substring is first expanded and then interpreted as an absolute path. The
11383 condition is true if the named file (or directory) exists. The existence test
11384 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11385 users' filter files may be locked out by the system administrator.
11386
11387 .vitem &*first_delivery*&
11388 .cindex "delivery" "first"
11389 .cindex "first delivery"
11390 .cindex "expansion" "first delivery test"
11391 .cindex "&%first_delivery%& expansion condition"
11392 This condition, which has no data, is true during a message's first delivery
11393 attempt. It is false during any subsequent delivery attempts.
11394
11395
11396 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11397        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11398 .cindex "list" "iterative conditions"
11399 .cindex "expansion" "&*forall*& condition"
11400 .cindex "expansion" "&*forany*& condition"
11401 .vindex "&$item$&"
11402 These conditions iterate over a list. The first argument is expanded to form
11403 the list. By default, the list separator is a colon, but it can be changed by
11404 the normal method (&<<SECTlistsepchange>>&).
11405 The second argument is interpreted as a condition that is to
11406 be applied to each item in the list in turn. During the interpretation of the
11407 condition, the current list item is placed in a variable called &$item$&.
11408 .ilist
11409 For &*forany*&, interpretation stops if the condition is true for any item, and
11410 the result of the whole condition is true. If the condition is false for all
11411 items in the list, the overall condition is false.
11412 .next
11413 For &*forall*&, interpretation stops if the condition is false for any item,
11414 and the result of the whole condition is false. If the condition is true for
11415 all items in the list, the overall condition is true.
11416 .endlist
11417 Note that negation of &*forany*& means that the condition must be false for all
11418 items for the overall condition to succeed, and negation of &*forall*& means
11419 that the condition must be false for at least one item. In this example, the
11420 list separator is changed to a comma:
11421 .code
11422 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11423 .endd
11424 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11425 being processed, to enable these expansion items to be nested.
11426
11427 To scan a named list, expand it with the &*listnamed*& operator.
11428
11429 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11430        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11431        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11432        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11433 .cindex JSON "iterative conditions"
11434 .cindex JSON expansions
11435 .cindex expansion "&*forall_json*& condition"
11436 .cindex expansion "&*forany_json*& condition"
11437 .cindex expansion "&*forall_jsons*& condition"
11438 .cindex expansion "&*forany_jsons*& condition"
11439 As for the above, except that the first argument must, after expansion,
11440 be a JSON array.
11441 The array separator is not changeable.
11442 For the &"jsons"& variants the elements are expected to be JSON strings
11443 and have their quotes removed before the evaluation of the condition.
11444
11445
11446
11447 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11448        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11449 .cindex "string" "comparison"
11450 .cindex "expansion" "string comparison"
11451 .cindex "&%ge%& expansion condition"
11452 .cindex "&%gei%& expansion condition"
11453 The two substrings are first expanded. The condition is true if the first
11454 string is lexically greater than or equal to the second string. For &%ge%& the
11455 comparison includes the case of letters, whereas for &%gei%& the comparison is
11456 case-independent.
11457 Case and collation order are defined per the system C locale.
11458
11459 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11460        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11461 .cindex "string" "comparison"
11462 .cindex "expansion" "string comparison"
11463 .cindex "&%gt%& expansion condition"
11464 .cindex "&%gti%& expansion condition"
11465 The two substrings are first expanded. The condition is true if the first
11466 string is lexically greater than the second string. For &%gt%& the comparison
11467 includes the case of letters, whereas for &%gti%& the comparison is
11468 case-independent.
11469 Case and collation order are defined per the system C locale.
11470
11471 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11472        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11473 .cindex "string" "comparison"
11474 .cindex "list" "iterative conditions"
11475 Both strings are expanded; the second string is treated as a list of simple
11476 strings; if the first string is a member of the second, then the condition
11477 is true.
11478 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11479
11480 These are simpler to use versions of the more powerful &*forany*& condition.
11481 Examples, and the &*forany*& equivalents:
11482 .code
11483 ${if inlist{needle}{foo:needle:bar}}
11484   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11485 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11486   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11487 .endd
11488
11489 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11490        &*isip4&~{*&<&'string'&>&*}*& &&&
11491        &*isip6&~{*&<&'string'&>&*}*&
11492 .cindex "IP address" "testing string format"
11493 .cindex "string" "testing for IP address"
11494 .cindex "&%isip%& expansion condition"
11495 .cindex "&%isip4%& expansion condition"
11496 .cindex "&%isip6%& expansion condition"
11497 The substring is first expanded, and then tested to see if it has the form of
11498 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11499 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11500
11501 For an IPv4 address, the test is for four dot-separated components, each of
11502 which consists of from one to three digits. For an IPv6 address, up to eight
11503 colon-separated components are permitted, each containing from one to four
11504 hexadecimal digits. There may be fewer than eight components if an empty
11505 component (adjacent colons) is present. Only one empty component is permitted.
11506
11507 &*Note*&: The checks used to be just on the form of the address; actual numerical
11508 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11509 check.
11510 This is no longer the case.
11511
11512 The main use of these tests is to distinguish between IP addresses and
11513 host names, or between IPv4 and IPv6 addresses. For example, you could use
11514 .code
11515 ${if isip4{$sender_host_address}...
11516 .endd
11517 to test which IP version an incoming SMTP connection is using.
11518
11519 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11520 .cindex "LDAP" "use for authentication"
11521 .cindex "expansion" "LDAP authentication test"
11522 .cindex "&%ldapauth%& expansion condition"
11523 This condition supports user authentication using LDAP. See section
11524 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11525 queries. For this use, the query must contain a user name and password. The
11526 query itself is not used, and can be empty. The condition is true if the
11527 password is not empty, and the user name and password are accepted by the LDAP
11528 server. An empty password is rejected without calling LDAP because LDAP binds
11529 with an empty password are considered anonymous regardless of the username, and
11530 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11531 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11532 this can be used.
11533
11534
11535 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11536        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11537 .cindex "string" "comparison"
11538 .cindex "expansion" "string comparison"
11539 .cindex "&%le%& expansion condition"
11540 .cindex "&%lei%& expansion condition"
11541 The two substrings are first expanded. The condition is true if the first
11542 string is lexically less than or equal to the second string. For &%le%& the
11543 comparison includes the case of letters, whereas for &%lei%& the comparison is
11544 case-independent.
11545 Case and collation order are defined per the system C locale.
11546
11547 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11548        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11549 .cindex "string" "comparison"
11550 .cindex "expansion" "string comparison"
11551 .cindex "&%lt%& expansion condition"
11552 .cindex "&%lti%& expansion condition"
11553 The two substrings are first expanded. The condition is true if the first
11554 string is lexically less than the second string. For &%lt%& the comparison
11555 includes the case of letters, whereas for &%lti%& the comparison is
11556 case-independent.
11557 Case and collation order are defined per the system C locale.
11558
11559
11560 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11561 .cindex "expansion" "regular expression comparison"
11562 .cindex "regular expressions" "match in expanded string"
11563 .cindex "&%match%& expansion condition"
11564 The two substrings are first expanded. The second is then treated as a regular
11565 expression and applied to the first. Because of the pre-expansion, if the
11566 regular expression contains dollar, or backslash characters, they must be
11567 escaped. Care must also be taken if the regular expression contains braces
11568 (curly brackets). A closing brace must be escaped so that it is not taken as a
11569 premature termination of <&'string2'&>. The easiest approach is to use the
11570 &`\N`& feature to disable expansion of the regular expression.
11571 For example,
11572 .code
11573 ${if match {$local_part}{\N^\d{3}\N} ...
11574 .endd
11575 If the whole expansion string is in double quotes, further escaping of
11576 backslashes is also required.
11577
11578 The condition is true if the regular expression match succeeds.
11579 The regular expression is not required to begin with a circumflex
11580 metacharacter, but if there is no circumflex, the expression is not anchored,
11581 and it may match anywhere in the subject, not just at the start. If you want
11582 the pattern to match at the end of the subject, you must include the &`$`&
11583 metacharacter at an appropriate point.
11584 All character handling is done in bytes and is not UTF-8 aware,
11585 but we might change this in a future Exim release.
11586
11587 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11588 At the start of an &%if%& expansion the values of the numeric variable
11589 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11590 succeeds causes them to be reset to the substrings of that condition and they
11591 will have these values during the expansion of the success string. At the end
11592 of the &%if%& expansion, the previous values are restored. After testing a
11593 combination of conditions using &%or%&, the subsequent values of the numeric
11594 variables are those of the condition that succeeded.
11595
11596 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11597 .cindex "&%match_address%& expansion condition"
11598 See &*match_local_part*&.
11599
11600 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11601 .cindex "&%match_domain%& expansion condition"
11602 See &*match_local_part*&.
11603
11604 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11605 .cindex "&%match_ip%& expansion condition"
11606 This condition matches an IP address to a list of IP address patterns. It must
11607 be followed by two argument strings. The first (after expansion) must be an IP
11608 address or an empty string. The second (not expanded) is a restricted host
11609 list that can match only an IP address, not a host name. For example:
11610 .code
11611 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11612 .endd
11613 The specific types of host list item that are permitted in the list are:
11614
11615 .ilist
11616 An IP address, optionally with a CIDR mask.
11617 .next
11618 A single asterisk, which matches any IP address.
11619 .next
11620 An empty item, which matches only if the IP address is empty. This could be
11621 useful for testing for a locally submitted message or one from specific hosts
11622 in a single test such as
11623 . ==== As this is a nested list, any displays it contains must be indented
11624 . ==== as otherwise they are too far to the left. This comment applies to
11625 . ==== the use of xmlto plus fop. There's no problem when formatting with
11626 . ==== sdop, with or without the extra indent.
11627 .code
11628   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11629 .endd
11630 where the first item in the list is the empty string.
11631 .next
11632 The item @[] matches any of the local host's interface addresses.
11633 .next
11634 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11635 even if &`net-`& is not specified. There is never any attempt to turn the IP
11636 address into a host name. The most common type of linear search for
11637 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11638 masks. For example:
11639 .code
11640   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11641 .endd
11642 It is of course possible to use other kinds of lookup, and in such a case, you
11643 do need to specify the &`net-`& prefix if you want to specify a specific
11644 address mask, for example:
11645 .code
11646   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11647 .endd
11648 However, unless you are combining a &%match_ip%& condition with others, it is
11649 just as easy to use the fact that a lookup is itself a condition, and write:
11650 .code
11651   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11652 .endd
11653 .endlist ilist
11654
11655 Note that <&'string2'&> is not itself subject to string expansion, unless
11656 Exim was built with the EXPAND_LISTMATCH_RHS option.
11657
11658 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11659
11660 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11661 .cindex "domain list" "in expansion condition"
11662 .cindex "address list" "in expansion condition"
11663 .cindex "local part" "list, in expansion condition"
11664 .cindex "&%match_local_part%& expansion condition"
11665 This condition, together with &%match_address%& and &%match_domain%&, make it
11666 possible to test domain, address, and local part lists within expansions. Each
11667 condition requires two arguments: an item and a list to match. A trivial
11668 example is:
11669 .code
11670 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11671 .endd
11672 In each case, the second argument may contain any of the allowable items for a
11673 list of the appropriate type. Also, because the second argument
11674 is a standard form of list, it is possible to refer to a named list.
11675 Thus, you can use conditions like this:
11676 .code
11677 ${if match_domain{$domain}{+local_domains}{...
11678 .endd
11679 .cindex "&`+caseful`&"
11680 For address lists, the matching starts off caselessly, but the &`+caseful`&
11681 item can be used, as in all address lists, to cause subsequent items to
11682 have their local parts matched casefully. Domains are always matched
11683 caselessly.
11684
11685 Note that <&'string2'&> is not itself subject to string expansion, unless
11686 Exim was built with the EXPAND_LISTMATCH_RHS option.
11687
11688 &*Note*&: Host lists are &'not'& supported in this way. This is because
11689 hosts have two identities: a name and an IP address, and it is not clear
11690 how to specify cleanly how such a test would work. However, IP addresses can be
11691 matched using &%match_ip%&.
11692
11693 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11694 .cindex "PAM authentication"
11695 .cindex "AUTH" "with PAM"
11696 .cindex "Solaris" "PAM support"
11697 .cindex "expansion" "PAM authentication test"
11698 .cindex "&%pam%& expansion condition"
11699 &'Pluggable Authentication Modules'&
11700 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11701 available in the latest releases of Solaris and in some GNU/Linux
11702 distributions. The Exim support, which is intended for use in conjunction with
11703 the SMTP AUTH command, is available only if Exim is compiled with
11704 .code
11705 SUPPORT_PAM=yes
11706 .endd
11707 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11708 in some releases of GNU/Linux &%-ldl%& is also needed.
11709
11710 The argument string is first expanded, and the result must be a
11711 colon-separated list of strings. Leading and trailing white space is ignored.
11712 The PAM module is initialized with the service name &"exim"& and the user name
11713 taken from the first item in the colon-separated data string (<&'string1'&>).
11714 The remaining items in the data string are passed over in response to requests
11715 from the authentication function. In the simple case there will only be one
11716 request, for a password, so the data consists of just two strings.
11717
11718 There can be problems if any of the strings are permitted to contain colon
11719 characters. In the usual way, these have to be doubled to avoid being taken as
11720 separators. If the data is being inserted from a variable, the &%sg%& expansion
11721 item can be used to double any existing colons. For example, the configuration
11722 of a LOGIN authenticator might contain this setting:
11723 .code
11724 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11725 .endd
11726 For a PLAIN authenticator you could use:
11727 .code
11728 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11729 .endd
11730 In some operating systems, PAM authentication can be done only from a process
11731 running as root. Since Exim is running as the Exim user when receiving
11732 messages, this means that PAM cannot be used directly in those systems.
11733 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11734
11735
11736 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11737 .cindex "&'pwcheck'& daemon"
11738 .cindex "Cyrus"
11739 .cindex "expansion" "&'pwcheck'& authentication test"
11740 .cindex "&%pwcheck%& expansion condition"
11741 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11742 This is one way of making it possible for passwords to be checked by a process
11743 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11744 deprecated. Its replacement is &'saslauthd'& (see below).
11745
11746 The pwcheck support is not included in Exim by default. You need to specify
11747 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11748 building Exim. For example:
11749 .code
11750 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11751 .endd
11752 You do not need to install the full Cyrus software suite in order to use
11753 the pwcheck daemon. You can compile and install just the daemon alone
11754 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11755 access to the &_/var/pwcheck_& directory.
11756
11757 The &%pwcheck%& condition takes one argument, which must be the user name and
11758 password, separated by a colon. For example, in a LOGIN authenticator
11759 configuration, you might have this:
11760 .code
11761 server_condition = ${if pwcheck{$auth1:$auth2}}
11762 .endd
11763 Again, for a PLAIN authenticator configuration, this would be:
11764 .code
11765 server_condition = ${if pwcheck{$auth2:$auth3}}
11766 .endd
11767 .vitem &*queue_running*&
11768 .cindex "queue runner" "detecting when delivering from"
11769 .cindex "expansion" "queue runner test"
11770 .cindex "&%queue_running%& expansion condition"
11771 This condition, which has no data, is true during delivery attempts that are
11772 initiated by queue runner processes, and false otherwise.
11773
11774
11775 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11776 .cindex "Radius"
11777 .cindex "expansion" "Radius authentication"
11778 .cindex "&%radius%& expansion condition"
11779 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11780 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11781 the Radius client configuration file in order to build Exim with Radius
11782 support.
11783
11784 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11785 library, using the original API. If you are using release 0.4.0 or later of
11786 this library, you need to set
11787 .code
11788 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11789 .endd
11790 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11791 &%libradius%& library that comes with FreeBSD. To do this, set
11792 .code
11793 RADIUS_LIB_TYPE=RADLIB
11794 .endd
11795 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11796 You may also have to supply a suitable setting in EXTRALIBS so that the
11797 Radius library can be found when Exim is linked.
11798
11799 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11800 Radius client library, which calls the Radius server. The condition is true if
11801 the authentication is successful. For example:
11802 .code
11803 server_condition = ${if radius{<arguments>}}
11804 .endd
11805
11806
11807 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11808         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11809 .cindex "&'saslauthd'& daemon"
11810 .cindex "Cyrus"
11811 .cindex "expansion" "&'saslauthd'& authentication test"
11812 .cindex "&%saslauthd%& expansion condition"
11813 This condition supports user authentication using the Cyrus &'saslauthd'&
11814 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11815 Using this daemon is one way of making it possible for passwords to be checked
11816 by a process that is not running as root.
11817
11818 The saslauthd support is not included in Exim by default. You need to specify
11819 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11820 building Exim. For example:
11821 .code
11822 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11823 .endd
11824 You do not need to install the full Cyrus software suite in order to use
11825 the saslauthd daemon. You can compile and install just the daemon alone
11826 from the Cyrus SASL library.
11827
11828 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11829 two are mandatory. For example:
11830 .code
11831 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11832 .endd
11833 The service and the realm are optional (which is why the arguments are enclosed
11834 in their own set of braces). For details of the meaning of the service and
11835 realm, and how to run the daemon, consult the Cyrus documentation.
11836 .endlist vlist
11837
11838
11839
11840 .section "Combining expansion conditions" "SECID84"
11841 .cindex "expansion" "combining conditions"
11842 Several conditions can be tested at once by combining them using the &%and%&
11843 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11844 conditions on their own, and precede their lists of sub-conditions. Each
11845 sub-condition must be enclosed in braces within the overall braces that contain
11846 the list. No repetition of &%if%& is used.
11847
11848
11849 .vlist
11850 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11851 .cindex "&""or""& expansion condition"
11852 .cindex "expansion" "&""or""& of conditions"
11853 The sub-conditions are evaluated from left to right. The condition is true if
11854 any one of the sub-conditions is true.
11855 For example,
11856 .code
11857 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11858 .endd
11859 When a true sub-condition is found, the following ones are parsed but not
11860 evaluated. If there are several &"match"& sub-conditions the values of the
11861 numeric variables afterwards are taken from the first one that succeeds.
11862
11863 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11864 .cindex "&""and""& expansion condition"
11865 .cindex "expansion" "&""and""& of conditions"
11866 The sub-conditions are evaluated from left to right. The condition is true if
11867 all of the sub-conditions are true. If there are several &"match"&
11868 sub-conditions, the values of the numeric variables afterwards are taken from
11869 the last one. When a false sub-condition is found, the following ones are
11870 parsed but not evaluated.
11871 .endlist
11872 .ecindex IIDexpcond
11873
11874
11875
11876
11877 .section "Expansion variables" "SECTexpvar"
11878 .cindex "expansion" "variables, list of"
11879 This section contains an alphabetical list of all the expansion variables. Some
11880 of them are available only when Exim is compiled with specific options such as
11881 support for TLS or the content scanning extension.
11882
11883 .vlist
11884 .vitem "&$0$&, &$1$&, etc"
11885 .cindex "numerical variables (&$1$& &$2$& etc)"
11886 When a &%match%& expansion condition succeeds, these variables contain the
11887 captured substrings identified by the regular expression during subsequent
11888 processing of the success string of the containing &%if%& expansion item.
11889 In the expansion condition case
11890 they do not retain their values afterwards; in fact, their previous
11891 values are restored at the end of processing an &%if%& item. The numerical
11892 variables may also be set externally by some other matching process which
11893 precedes the expansion of the string. For example, the commands available in
11894 Exim filter files include an &%if%& command with its own regular expression
11895 matching condition.
11896
11897 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11898 Within an acl condition, expansion condition or expansion item
11899 any arguments are copied to these variables,
11900 any unused variables being made empty.
11901
11902 .vitem "&$acl_c...$&"
11903 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11904 can be given any name that starts with &$acl_c$& and is at least six characters
11905 long, but the sixth character must be either a digit or an underscore. For
11906 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11907 variables persist throughout the lifetime of an SMTP connection. They can be
11908 used to pass information between ACLs and between different invocations of the
11909 same ACL. When a message is received, the values of these variables are saved
11910 with the message, and can be accessed by filters, routers, and transports
11911 during subsequent delivery.
11912
11913 .vitem "&$acl_m...$&"
11914 These variables are like the &$acl_c...$& variables, except that their values
11915 are reset after a message has been received. Thus, if several messages are
11916 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11917 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11918 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11919 message is received, the values of these variables are saved with the message,
11920 and can be accessed by filters, routers, and transports during subsequent
11921 delivery.
11922
11923 .vitem &$acl_narg$&
11924 Within an acl condition, expansion condition or expansion item
11925 this variable has the number of arguments.
11926
11927 .vitem &$acl_verify_message$&
11928 .vindex "&$acl_verify_message$&"
11929 After an address verification has failed, this variable contains the failure
11930 message. It retains its value for use in subsequent modifiers. The message can
11931 be preserved by coding like this:
11932 .code
11933 warn !verify = sender
11934      set acl_m0 = $acl_verify_message
11935 .endd
11936 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11937 &%log_message%& modifiers, to include information about the verification
11938 failure.
11939
11940 .vitem &$address_data$&
11941 .vindex "&$address_data$&"
11942 This variable is set by means of the &%address_data%& option in routers. The
11943 value then remains with the address while it is processed by subsequent routers
11944 and eventually a transport. If the transport is handling multiple addresses,
11945 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11946 for more details. &*Note*&: The contents of &$address_data$& are visible in
11947 user filter files.
11948
11949 If &$address_data$& is set when the routers are called from an ACL to verify
11950 a recipient address, the final value is still in the variable for subsequent
11951 conditions and modifiers of the ACL statement. If routing the address caused it
11952 to be redirected to just one address, the child address is also routed as part
11953 of the verification, and in this case the final value of &$address_data$& is
11954 from the child's routing.
11955
11956 If &$address_data$& is set when the routers are called from an ACL to verify a
11957 sender address, the final value is also preserved, but this time in
11958 &$sender_address_data$&, to distinguish it from data from a recipient
11959 address.
11960
11961 In both cases (recipient and sender verification), the value does not persist
11962 after the end of the current ACL statement. If you want to preserve
11963 these values for longer, you can save them in ACL variables.
11964
11965 .vitem &$address_file$&
11966 .vindex "&$address_file$&"
11967 When, as a result of aliasing, forwarding, or filtering, a message is directed
11968 to a specific file, this variable holds the name of the file when the transport
11969 is running. At other times, the variable is empty. For example, using the
11970 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11971 .code
11972 /home/r2d2/savemail
11973 .endd
11974 then when the &(address_file)& transport is running, &$address_file$&
11975 contains the text string &`/home/r2d2/savemail`&.
11976 .cindex "Sieve filter" "value of &$address_file$&"
11977 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11978 then up to the transport configuration to generate an appropriate absolute path
11979 to the relevant file.
11980
11981 .vitem &$address_pipe$&
11982 .vindex "&$address_pipe$&"
11983 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11984 this variable holds the pipe command when the transport is running.
11985
11986 .vitem "&$auth1$& &-- &$auth3$&"
11987 .vindex "&$auth1$&, &$auth2$&, etc"
11988 These variables are used in SMTP authenticators (see chapters
11989 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11990
11991 .vitem &$authenticated_id$&
11992 .cindex "authentication" "id"
11993 .vindex "&$authenticated_id$&"
11994 When a server successfully authenticates a client it may be configured to
11995 preserve some of the authentication information in the variable
11996 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11997 user/password authenticator configuration might preserve the user name for use
11998 in the routers. Note that this is not the same information that is saved in
11999 &$sender_host_authenticated$&.
12000
12001 When a message is submitted locally (that is, not over a TCP connection)
12002 the value of &$authenticated_id$& is normally the login name of the calling
12003 process. However, a trusted user can override this by means of the &%-oMai%&
12004 command line option.
12005 This second case also sets up information used by the
12006 &$authresults$& expansion item.
12007
12008 .vitem &$authenticated_fail_id$&
12009 .cindex "authentication" "fail" "id"
12010 .vindex "&$authenticated_fail_id$&"
12011 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12012 will contain the failed authentication id. If more than one authentication
12013 id is attempted, it will contain only the last one. The variable is
12014 available for processing in the ACL's, generally the quit or notquit ACL.
12015 A message to a local recipient could still be accepted without requiring
12016 authentication, which means this variable could also be visible in all of
12017 the ACL's as well.
12018
12019
12020 .vitem &$authenticated_sender$&
12021 .cindex "sender" "authenticated"
12022 .cindex "authentication" "sender"
12023 .cindex "AUTH" "on MAIL command"
12024 .vindex "&$authenticated_sender$&"
12025 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12026 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12027 described in section &<<SECTauthparamail>>&. Unless the data is the string
12028 &"<>"&, it is set as the authenticated sender of the message, and the value is
12029 available during delivery in the &$authenticated_sender$& variable. If the
12030 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12031
12032 .vindex "&$qualify_domain$&"
12033 When a message is submitted locally (that is, not over a TCP connection), the
12034 value of &$authenticated_sender$& is an address constructed from the login
12035 name of the calling process and &$qualify_domain$&, except that a trusted user
12036 can override this by means of the &%-oMas%& command line option.
12037
12038
12039 .vitem &$authentication_failed$&
12040 .cindex "authentication" "failure"
12041 .vindex "&$authentication_failed$&"
12042 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12043 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12044 possible to distinguish between &"did not try to authenticate"&
12045 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12046 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12047 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12048 negative response to an AUTH command, including (for example) an attempt to use
12049 an undefined mechanism.
12050
12051 .vitem &$av_failed$&
12052 .cindex "content scanning" "AV scanner failure"
12053 This variable is available when Exim is compiled with the content-scanning
12054 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12055 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12056 the ACL malware condition.
12057
12058 .vitem &$body_linecount$&
12059 .cindex "message body" "line count"
12060 .cindex "body of message" "line count"
12061 .vindex "&$body_linecount$&"
12062 When a message is being received or delivered, this variable contains the
12063 number of lines in the message's body. See also &$message_linecount$&.
12064
12065 .vitem &$body_zerocount$&
12066 .cindex "message body" "binary zero count"
12067 .cindex "body of message" "binary zero count"
12068 .cindex "binary zero" "in message body"
12069 .vindex "&$body_zerocount$&"
12070 When a message is being received or delivered, this variable contains the
12071 number of binary zero bytes (ASCII NULs) in the message's body.
12072
12073 .vitem &$bounce_recipient$&
12074 .vindex "&$bounce_recipient$&"
12075 This is set to the recipient address of a bounce message while Exim is creating
12076 it. It is useful if a customized bounce message text file is in use (see
12077 chapter &<<CHAPemsgcust>>&).
12078
12079 .vitem &$bounce_return_size_limit$&
12080 .vindex "&$bounce_return_size_limit$&"
12081 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12082 up to a multiple of 1000. It is useful when a customized error message text
12083 file is in use (see chapter &<<CHAPemsgcust>>&).
12084
12085 .vitem &$caller_gid$&
12086 .cindex "gid (group id)" "caller"
12087 .vindex "&$caller_gid$&"
12088 The real group id under which the process that called Exim was running. This is
12089 not the same as the group id of the originator of a message (see
12090 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12091 incarnation normally contains the Exim gid.
12092
12093 .vitem &$caller_uid$&
12094 .cindex "uid (user id)" "caller"
12095 .vindex "&$caller_uid$&"
12096 The real user id under which the process that called Exim was running. This is
12097 not the same as the user id of the originator of a message (see
12098 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12099 incarnation normally contains the Exim uid.
12100
12101 .vitem &$callout_address$&
12102 .vindex "&$callout_address$&"
12103 After a callout for verification, spamd or malware daemon service, the
12104 address that was connected to.
12105
12106 .vitem &$compile_number$&
12107 .vindex "&$compile_number$&"
12108 The building process for Exim keeps a count of the number
12109 of times it has been compiled. This serves to distinguish different
12110 compilations of the same version of Exim.
12111
12112 .vitem &$config_dir$&
12113 .vindex "&$config_dir$&"
12114 The directory name of the main configuration file. That is, the content of
12115 &$config_file$& with the last component stripped. The value does not
12116 contain the trailing slash. If &$config_file$& does not contain a slash,
12117 &$config_dir$& is ".".
12118
12119 .vitem &$config_file$&
12120 .vindex "&$config_file$&"
12121 The name of the main configuration file Exim is using.
12122
12123 .vitem &$dmarc_domain_policy$& &&&
12124        &$dmarc_status$& &&&
12125        &$dmarc_status_text$& &&&
12126        &$dmarc_used_domains$&
12127 Results of DMARC verification.
12128 For details see section &<<SECDMARC>>&.
12129
12130 .vitem &$dkim_verify_status$&
12131 Results of DKIM verification.
12132 For details see section &<<SECDKIMVFY>>&.
12133
12134 .vitem &$dkim_cur_signer$& &&&
12135        &$dkim_verify_reason$& &&&
12136        &$dkim_domain$& &&&
12137        &$dkim_identity$& &&&
12138        &$dkim_selector$& &&&
12139        &$dkim_algo$& &&&
12140        &$dkim_canon_body$& &&&
12141        &$dkim_canon_headers$& &&&
12142        &$dkim_copiedheaders$& &&&
12143        &$dkim_bodylength$& &&&
12144        &$dkim_created$& &&&
12145        &$dkim_expires$& &&&
12146        &$dkim_headernames$& &&&
12147        &$dkim_key_testing$& &&&
12148        &$dkim_key_nosubdomains$& &&&
12149        &$dkim_key_srvtype$& &&&
12150        &$dkim_key_granularity$& &&&
12151        &$dkim_key_notes$& &&&
12152        &$dkim_key_length$&
12153 These variables are only available within the DKIM ACL.
12154 For details see section &<<SECDKIMVFY>>&.
12155
12156 .vitem &$dkim_signers$&
12157 .vindex &$dkim_signers$&
12158 When a message has been received this variable contains
12159 a colon-separated list of signer domains and identities for the message.
12160 For details see section &<<SECDKIMVFY>>&.
12161
12162 .vitem &$dnslist_domain$& &&&
12163        &$dnslist_matched$& &&&
12164        &$dnslist_text$& &&&
12165        &$dnslist_value$&
12166 .vindex "&$dnslist_domain$&"
12167 .vindex "&$dnslist_matched$&"
12168 .vindex "&$dnslist_text$&"
12169 .vindex "&$dnslist_value$&"
12170 .cindex "black list (DNS)"
12171 When a DNS (black) list lookup succeeds, these variables are set to contain
12172 the following data from the lookup: the list's domain name, the key that was
12173 looked up, the contents of any associated TXT record, and the value from the
12174 main A record. See section &<<SECID204>>& for more details.
12175
12176 .vitem &$domain$&
12177 .vindex "&$domain$&"
12178 When an address is being routed, or delivered on its own, this variable
12179 contains the domain. Uppercase letters in the domain are converted into lower
12180 case for &$domain$&.
12181
12182 Global address rewriting happens when a message is received, so the value of
12183 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12184 is set during user filtering, but not during system filtering, because a
12185 message may have many recipients and the system filter is called just once.
12186
12187 When more than one address is being delivered at once (for example, several
12188 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12189 have the same domain. Transports can be restricted to handling only one domain
12190 at a time if the value of &$domain$& is required at transport time &-- this is
12191 the default for local transports. For further details of the environment in
12192 which local transports are run, see chapter &<<CHAPenvironment>>&.
12193
12194 .oindex "&%delay_warning_condition%&"
12195 At the end of a delivery, if all deferred addresses have the same domain, it is
12196 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12197
12198 The &$domain$& variable is also used in some other circumstances:
12199
12200 .ilist
12201 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12202 the recipient address. The domain of the &'sender'& address is in
12203 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12204 normally set during the running of the MAIL ACL. However, if the sender address
12205 is verified with a callout during the MAIL ACL, the sender domain is placed in
12206 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12207 the &(smtp)& transport.
12208
12209 .next
12210 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12211 &$domain$& contains the domain portion of the address that is being rewritten;
12212 it can be used in the expansion of the replacement address, for example, to
12213 rewrite domains by file lookup.
12214
12215 .next
12216 With one important exception, whenever a domain list is being scanned,
12217 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12218 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12219 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12220 that, in a RCPT ACL, the sender domain list can be dependent on the
12221 recipient domain (which is what is in &$domain$& at this time).
12222
12223 .next
12224 .cindex "ETRN" "value of &$domain$&"
12225 .oindex "&%smtp_etrn_command%&"
12226 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12227 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12228 .endlist
12229
12230 .new
12231 .cindex "tainted data"
12232 If the origin of the data is an incoming message,
12233 the result of expanding this variable is tainted.
12234 See also &$domain_verified$&.
12235 .wen
12236
12237
12238 .vitem &$domain_data$&
12239 .vindex "&$domain_data$&"
12240 When the &%domains%& option on a router matches a domain by
12241 means of a lookup, the data read by the lookup is available during the running
12242 of the router as &$domain_data$&. In addition, if the driver routes the
12243 address to a transport, the value is available in that transport. If the
12244 transport is handling multiple addresses, the value from the first address is
12245 used.
12246
12247 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12248 domain by means of a lookup. The data read by the lookup is available during
12249 the rest of the ACL statement. In all other situations, this variable expands
12250 to nothing.
12251
12252 .vitem &$exim_gid$&
12253 .vindex "&$exim_gid$&"
12254 This variable contains the numerical value of the Exim group id.
12255
12256 .vitem &$exim_path$&
12257 .vindex "&$exim_path$&"
12258 This variable contains the path to the Exim binary.
12259
12260 .vitem &$exim_uid$&
12261 .vindex "&$exim_uid$&"
12262 This variable contains the numerical value of the Exim user id.
12263
12264 .vitem &$exim_version$&
12265 .vindex "&$exim_version$&"
12266 This variable contains the version string of the Exim build.
12267 The first character is a major version number, currently 4.
12268 Then after a dot, the next group of digits is a minor version number.
12269 There may be other characters following the minor version.
12270 This value may be overridden by the &%exim_version%& main config option.
12271
12272 .vitem &$header_$&<&'name'&>
12273 This is not strictly an expansion variable. It is expansion syntax for
12274 inserting the message header line with the given name. Note that the name must
12275 be terminated by colon or white space, because it may contain a wide variety of
12276 characters. Note also that braces must &'not'& be used.
12277 See the full description in section &<<SECTexpansionitems>>& above.
12278
12279 .vitem &$headers_added$&
12280 .vindex "&$headers_added$&"
12281 Within an ACL this variable contains the headers added so far by
12282 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12283 The headers are a newline-separated list.
12284
12285 .vitem &$home$&
12286 .vindex "&$home$&"
12287 When the &%check_local_user%& option is set for a router, the user's home
12288 directory is placed in &$home$& when the check succeeds. In particular, this
12289 means it is set during the running of users' filter files. A router may also
12290 explicitly set a home directory for use by a transport; this can be overridden
12291 by a setting on the transport itself.
12292
12293 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12294 of the environment variable HOME, which is subject to the
12295 &%keep_environment%& and &%add_environment%& main config options.
12296
12297 .vitem &$host$&
12298 .vindex "&$host$&"
12299 If a router assigns an address to a transport (any transport), and passes a
12300 list of hosts with the address, the value of &$host$& when the transport starts
12301 to run is the name of the first host on the list. Note that this applies both
12302 to local and remote transports.
12303
12304 .cindex "transport" "filter"
12305 .cindex "filter" "transport filter"
12306 For the &(smtp)& transport, if there is more than one host, the value of
12307 &$host$& changes as the transport works its way through the list. In
12308 particular, when the &(smtp)& transport is expanding its options for encryption
12309 using TLS, or for specifying a transport filter (see chapter
12310 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12311 is connected.
12312
12313 When used in the client part of an authenticator configuration (see chapter
12314 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12315 client is connected.
12316
12317
12318 .vitem &$host_address$&
12319 .vindex "&$host_address$&"
12320 This variable is set to the remote host's IP address whenever &$host$& is set
12321 for a remote connection. It is also set to the IP address that is being checked
12322 when the &%ignore_target_hosts%& option is being processed.
12323
12324 .vitem &$host_data$&
12325 .vindex "&$host_data$&"
12326 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12327 result of the lookup is made available in the &$host_data$& variable. This
12328 allows you, for example, to do things like this:
12329 .code
12330 deny  hosts = net-lsearch;/some/file
12331 message = $host_data
12332 .endd
12333 .vitem &$host_lookup_deferred$&
12334 .cindex "host name" "lookup, failure of"
12335 .vindex "&$host_lookup_deferred$&"
12336 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12337 message comes from a remote host and there is an attempt to look up the host's
12338 name from its IP address, and the attempt is not successful, one of these
12339 variables is set to &"1"&.
12340
12341 .ilist
12342 If the lookup receives a definite negative response (for example, a DNS lookup
12343 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12344
12345 .next
12346 If there is any kind of problem during the lookup, such that Exim cannot
12347 tell whether or not the host name is defined (for example, a timeout for a DNS
12348 lookup), &$host_lookup_deferred$& is set to &"1"&.
12349 .endlist ilist
12350
12351 Looking up a host's name from its IP address consists of more than just a
12352 single reverse lookup. Exim checks that a forward lookup of at least one of the
12353 names it receives from a reverse lookup yields the original IP address. If this
12354 is not the case, Exim does not accept the looked up name(s), and
12355 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12356 IP address (for example, the existence of a PTR record in the DNS) is not
12357 sufficient on its own for the success of a host name lookup. If the reverse
12358 lookup succeeds, but there is a lookup problem such as a timeout when checking
12359 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12360 &"1"&. See also &$sender_host_name$&.
12361
12362 .cindex authentication "expansion item"
12363 Performing these checks sets up information used by the
12364 &%authresults%& expansion item.
12365
12366
12367 .vitem &$host_lookup_failed$&
12368 .vindex "&$host_lookup_failed$&"
12369 See &$host_lookup_deferred$&.
12370
12371 .vitem &$host_port$&
12372 .vindex "&$host_port$&"
12373 This variable is set to the remote host's TCP port whenever &$host$& is set
12374 for an outbound connection.
12375
12376 .vitem &$initial_cwd$&
12377 .vindex "&$initial_cwd$&
12378 This variable contains the full path name of the initial working
12379 directory of the current Exim process. This may differ from the current
12380 working directory, as Exim changes this to "/" during early startup, and
12381 to &$spool_directory$& later.
12382
12383 .vitem &$inode$&
12384 .vindex "&$inode$&"
12385 The only time this variable is set is while expanding the &%directory_file%&
12386 option in the &(appendfile)& transport. The variable contains the inode number
12387 of the temporary file which is about to be renamed. It can be used to construct
12388 a unique name for the file.
12389
12390 .vitem &$interface_address$&
12391 .vindex "&$interface_address$&"
12392 This is an obsolete name for &$received_ip_address$&.
12393
12394 .vitem &$interface_port$&
12395 .vindex "&$interface_port$&"
12396 This is an obsolete name for &$received_port$&.
12397
12398 .vitem &$item$&
12399 .vindex "&$item$&"
12400 This variable is used during the expansion of &*forall*& and &*forany*&
12401 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12402 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12403 empty.
12404
12405 .vitem &$ldap_dn$&
12406 .vindex "&$ldap_dn$&"
12407 This variable, which is available only when Exim is compiled with LDAP support,
12408 contains the DN from the last entry in the most recently successful LDAP
12409 lookup.
12410
12411 .vitem &$load_average$&
12412 .vindex "&$load_average$&"
12413 This variable contains the system load average, multiplied by 1000 so that it
12414 is an integer. For example, if the load average is 0.21, the value of the
12415 variable is 210. The value is recomputed every time the variable is referenced.
12416
12417 .vitem &$local_part$&
12418 .vindex "&$local_part$&"
12419 When an address is being routed, or delivered on its own, this
12420 variable contains the local part. When a number of addresses are being
12421 delivered together (for example, multiple RCPT commands in an SMTP
12422 session), &$local_part$& is not set.
12423
12424 Global address rewriting happens when a message is received, so the value of
12425 &$local_part$& during routing and delivery is the value after rewriting.
12426 &$local_part$& is set during user filtering, but not during system filtering,
12427 because a message may have many recipients and the system filter is called just
12428 once.
12429
12430 .new
12431 .cindex "tainted data"
12432 If the origin of the data is an incoming message,
12433 the result of expanding this variable is tainted.
12434
12435 &*Warning*&: the content of this variable is usually provided by a potential
12436 attacker.
12437 Consider carefully the implications of using it unvalidated as a name
12438 for file access.
12439 This presents issues for users' &_.forward_& and filter files.
12440 For traditional full user accounts, use &%check_local_users%& and the
12441 &$local_part_verified$& variable rather than this one.
12442 For virtual users, store a suitable pathname component in the database
12443 which is used for account name validation, and use that retrieved value
12444 rather than this variable.
12445 If needed, use a router &%address_data%& or &%set%& option for
12446 the retrieved data.
12447 .wen
12448
12449 .vindex "&$local_part_prefix$&"
12450 .vindex "&$local_part_suffix$&"
12451 .cindex affix variables
12452 If a local part prefix or suffix has been recognized, it is not included in the
12453 value of &$local_part$& during routing and subsequent delivery. The values of
12454 any prefix or suffix are in &$local_part_prefix$& and
12455 &$local_part_suffix$&, respectively.
12456
12457 When a message is being delivered to a file, pipe, or autoreply transport as a
12458 result of aliasing or forwarding, &$local_part$& is set to the local part of
12459 the parent address, not to the filename or command (see &$address_file$& and
12460 &$address_pipe$&).
12461
12462 When an ACL is running for a RCPT command, &$local_part$& contains the
12463 local part of the recipient address.
12464
12465 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12466 &$local_part$& contains the local part of the address that is being rewritten;
12467 it can be used in the expansion of the replacement address, for example.
12468
12469 In all cases, all quoting is removed from the local part. For example, for both
12470 the addresses
12471 .code
12472 "abc:xyz"@test.example
12473 abc\:xyz@test.example
12474 .endd
12475 the value of &$local_part$& is
12476 .code
12477 abc:xyz
12478 .endd
12479 If you use &$local_part$& to create another address, you should always wrap it
12480 inside a quoting operator. For example, in a &(redirect)& router you could
12481 have:
12482 .code
12483 data = ${quote_local_part:$local_part}@new.domain.example
12484 .endd
12485 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12486 to process local parts in a case-dependent manner in a router, you can set the
12487 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12488
12489 .vitem &$local_part_data$&
12490 .vindex "&$local_part_data$&"
12491 When the &%local_parts%& option on a router matches a local part by means of a
12492 lookup, the data read by the lookup is available during the running of the
12493 router as &$local_part_data$&. In addition, if the driver routes the address
12494 to a transport, the value is available in that transport. If the transport is
12495 handling multiple addresses, the value from the first address is used.
12496
12497 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12498 matches a local part by means of a lookup. The data read by the lookup is
12499 available during the rest of the ACL statement. In all other situations, this
12500 variable expands to nothing.
12501
12502 .vitem &$local_part_prefix$&
12503 .vindex "&$local_part_prefix$&"
12504 .cindex affix variables
12505 When an address is being routed or delivered, and a
12506 specific prefix for the local part was recognized, it is available in this
12507 variable, having been removed from &$local_part$&.
12508
12509 .vitem &$local_part_suffix$&
12510 .vindex "&$local_part_suffix$&"
12511 When an address is being routed or delivered, and a
12512 specific suffix for the local part was recognized, it is available in this
12513 variable, having been removed from &$local_part$&.
12514
12515 .new
12516 .vitem &$local_part_verified$&
12517 .vindex "&$local_part_verified$&"
12518 If the router generic option &%check_local_part%& has run successfully,
12519 this variable has the user database version of &$local_part$&.
12520 Such values are not tainted and hence usable for building file names.
12521 .wen
12522
12523 .vitem &$local_scan_data$&
12524 .vindex "&$local_scan_data$&"
12525 This variable contains the text returned by the &[local_scan()]& function when
12526 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12527
12528 .vitem &$local_user_gid$&
12529 .vindex "&$local_user_gid$&"
12530 See &$local_user_uid$&.
12531
12532 .vitem &$local_user_uid$&
12533 .vindex "&$local_user_uid$&"
12534 This variable and &$local_user_gid$& are set to the uid and gid after the
12535 &%check_local_user%& router precondition succeeds. This means that their values
12536 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12537 and &%condition%&), for the &%address_data%& expansion, and for any
12538 router-specific expansions. At all other times, the values in these variables
12539 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12540
12541 .vitem &$localhost_number$&
12542 .vindex "&$localhost_number$&"
12543 This contains the expanded value of the
12544 &%localhost_number%& option. The expansion happens after the main options have
12545 been read.
12546
12547 .vitem &$log_inodes$&
12548 .vindex "&$log_inodes$&"
12549 The number of free inodes in the disk partition where Exim's
12550 log files are being written. The value is recalculated whenever the variable is
12551 referenced. If the relevant file system does not have the concept of inodes,
12552 the value of is -1. See also the &%check_log_inodes%& option.
12553
12554 .vitem &$log_space$&
12555 .vindex "&$log_space$&"
12556 The amount of free space (as a number of kilobytes) in the disk
12557 partition where Exim's log files are being written. The value is recalculated
12558 whenever the variable is referenced. If the operating system does not have the
12559 ability to find the amount of free space (only true for experimental systems),
12560 the space value is -1. See also the &%check_log_space%& option.
12561
12562
12563 .vitem &$lookup_dnssec_authenticated$&
12564 .vindex "&$lookup_dnssec_authenticated$&"
12565 This variable is set after a DNS lookup done by
12566 a dnsdb lookup expansion, dnslookup router or smtp transport.
12567 .cindex "DNS" "DNSSEC"
12568 It will be empty if &(DNSSEC)& was not requested,
12569 &"no"& if the result was not labelled as authenticated data
12570 and &"yes"& if it was.
12571 Results that are labelled as authoritative answer that match
12572 the &%dns_trust_aa%& configuration variable count also
12573 as authenticated data.
12574
12575 .vitem &$mailstore_basename$&
12576 .vindex "&$mailstore_basename$&"
12577 This variable is set only when doing deliveries in &"mailstore"& format in the
12578 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12579 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12580 contains the basename of the files that are being written, that is, the name
12581 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12582 variable is empty.
12583
12584 .vitem &$malware_name$&
12585 .vindex "&$malware_name$&"
12586 This variable is available when Exim is compiled with the
12587 content-scanning extension. It is set to the name of the virus that was found
12588 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12589
12590 .vitem &$max_received_linelength$&
12591 .vindex "&$max_received_linelength$&"
12592 .cindex "maximum" "line length"
12593 .cindex "line length" "maximum"
12594 This variable contains the number of bytes in the longest line that was
12595 received as part of the message, not counting the line termination
12596 character(s).
12597 It is not valid if the &%spool_files_wireformat%& option is used.
12598
12599 .vitem &$message_age$&
12600 .cindex "message" "age of"
12601 .vindex "&$message_age$&"
12602 This variable is set at the start of a delivery attempt to contain the number
12603 of seconds since the message was received. It does not change during a single
12604 delivery attempt.
12605
12606 .vitem &$message_body$&
12607 .cindex "body of message" "expansion variable"
12608 .cindex "message body" "in expansion"
12609 .cindex "binary zero" "in message body"
12610 .vindex "&$message_body$&"
12611 .oindex "&%message_body_visible%&"
12612 This variable contains the initial portion of a message's body while it is
12613 being delivered, and is intended mainly for use in filter files. The maximum
12614 number of characters of the body that are put into the variable is set by the
12615 &%message_body_visible%& configuration option; the default is 500.
12616
12617 .oindex "&%message_body_newlines%&"
12618 By default, newlines are converted into spaces in &$message_body$&, to make it
12619 easier to search for phrases that might be split over a line break. However,
12620 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12621 zeros are always converted into spaces.
12622
12623 .vitem &$message_body_end$&
12624 .cindex "body of message" "expansion variable"
12625 .cindex "message body" "in expansion"
12626 .vindex "&$message_body_end$&"
12627 This variable contains the final portion of a message's
12628 body while it is being delivered. The format and maximum size are as for
12629 &$message_body$&.
12630
12631 .vitem &$message_body_size$&
12632 .cindex "body of message" "size"
12633 .cindex "message body" "size"
12634 .vindex "&$message_body_size$&"
12635 When a message is being delivered, this variable contains the size of the body
12636 in bytes. The count starts from the character after the blank line that
12637 separates the body from the header. Newlines are included in the count. See
12638 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12639
12640 If the spool file is wireformat
12641 (see the &%spool_files_wireformat%& main option)
12642 the CRLF line-terminators are included in the count.
12643
12644 .vitem &$message_exim_id$&
12645 .vindex "&$message_exim_id$&"
12646 When a message is being received or delivered, this variable contains the
12647 unique message id that is generated and used by Exim to identify the message.
12648 An id is not created for a message until after its header has been successfully
12649 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12650 line; it is the local id that Exim assigns to the message, for example:
12651 &`1BXTIK-0001yO-VA`&.
12652
12653 .vitem &$message_headers$&
12654 .vindex &$message_headers$&
12655 This variable contains a concatenation of all the header lines when a message
12656 is being processed, except for lines added by routers or transports. The header
12657 lines are separated by newline characters. Their contents are decoded in the
12658 same way as a header line that is inserted by &%bheader%&.
12659
12660 .vitem &$message_headers_raw$&
12661 .vindex &$message_headers_raw$&
12662 This variable is like &$message_headers$& except that no processing of the
12663 contents of header lines is done.
12664
12665 .vitem &$message_id$&
12666 This is an old name for &$message_exim_id$&. It is now deprecated.
12667
12668 .vitem &$message_linecount$&
12669 .vindex "&$message_linecount$&"
12670 This variable contains the total number of lines in the header and body of the
12671 message. Compare &$body_linecount$&, which is the count for the body only.
12672 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12673 number of lines received. Before delivery happens (that is, before filters,
12674 routers, and transports run) the count is increased to include the
12675 &'Received:'& header line that Exim standardly adds, and also any other header
12676 lines that are added by ACLs. The blank line that separates the message header
12677 from the body is not counted.
12678
12679 As with the special case of &$message_size$&, during the expansion of the
12680 appendfile transport's maildir_tag option in maildir format, the value of
12681 &$message_linecount$& is the precise size of the number of newlines in the
12682 file that has been written (minus one for the blank line between the
12683 header and the body).
12684
12685 Here is an example of the use of this variable in a DATA ACL:
12686 .code
12687 deny message   = Too many lines in message header
12688      condition = \
12689       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12690 .endd
12691 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12692 message has not yet been received.
12693
12694 This variable is not valid if the &%spool_files_wireformat%& option is used.
12695
12696 .vitem &$message_size$&
12697 .cindex "size" "of message"
12698 .cindex "message" "size"
12699 .vindex "&$message_size$&"
12700 When a message is being processed, this variable contains its size in bytes. In
12701 most cases, the size includes those headers that were received with the
12702 message, but not those (such as &'Envelope-to:'&) that are added to individual
12703 deliveries as they are written. However, there is one special case: during the
12704 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12705 doing a delivery in maildir format, the value of &$message_size$& is the
12706 precise size of the file that has been written. See also
12707 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12708
12709 .cindex "RCPT" "value of &$message_size$&"
12710 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12711 contains the size supplied on the MAIL command, or -1 if no size was given. The
12712 value may not, of course, be truthful.
12713
12714 .vitem &$mime_$&&'xxx'&
12715 A number of variables whose names start with &$mime$& are
12716 available when Exim is compiled with the content-scanning extension. For
12717 details, see section &<<SECTscanmimepart>>&.
12718
12719 .vitem "&$n0$& &-- &$n9$&"
12720 These variables are counters that can be incremented by means
12721 of the &%add%& command in filter files.
12722
12723 .vitem &$original_domain$&
12724 .vindex "&$domain$&"
12725 .vindex "&$original_domain$&"
12726 When a top-level address is being processed for delivery, this contains the
12727 same value as &$domain$&. However, if a &"child"& address (for example,
12728 generated by an alias, forward, or filter file) is being processed, this
12729 variable contains the domain of the original address (lower cased). This
12730 differs from &$parent_domain$& only when there is more than one level of
12731 aliasing or forwarding. When more than one address is being delivered in a
12732 single transport run, &$original_domain$& is not set.
12733
12734 If a new address is created by means of a &%deliver%& command in a system
12735 filter, it is set up with an artificial &"parent"& address. This has the local
12736 part &'system-filter'& and the default qualify domain.
12737
12738 .vitem &$original_local_part$&
12739 .vindex "&$local_part$&"
12740 .vindex "&$original_local_part$&"
12741 When a top-level address is being processed for delivery, this contains the
12742 same value as &$local_part$&, unless a prefix or suffix was removed from the
12743 local part, because &$original_local_part$& always contains the full local
12744 part. When a &"child"& address (for example, generated by an alias, forward, or
12745 filter file) is being processed, this variable contains the full local part of
12746 the original address.
12747
12748 If the router that did the redirection processed the local part
12749 case-insensitively, the value in &$original_local_part$& is in lower case.
12750 This variable differs from &$parent_local_part$& only when there is more than
12751 one level of aliasing or forwarding. When more than one address is being
12752 delivered in a single transport run, &$original_local_part$& is not set.
12753
12754 If a new address is created by means of a &%deliver%& command in a system
12755 filter, it is set up with an artificial &"parent"& address. This has the local
12756 part &'system-filter'& and the default qualify domain.
12757
12758 .vitem &$originator_gid$&
12759 .cindex "gid (group id)" "of originating user"
12760 .cindex "sender" "gid"
12761 .vindex "&$caller_gid$&"
12762 .vindex "&$originator_gid$&"
12763 This variable contains the value of &$caller_gid$& that was set when the
12764 message was received. For messages received via the command line, this is the
12765 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12766 normally the gid of the Exim user.
12767
12768 .vitem &$originator_uid$&
12769 .cindex "uid (user id)" "of originating user"
12770 .cindex "sender" "uid"
12771 .vindex "&$caller_uid$&"
12772 .vindex "&$originator_uid$&"
12773 The value of &$caller_uid$& that was set when the message was received. For
12774 messages received via the command line, this is the uid of the sending user.
12775 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12776 user.
12777
12778 .vitem &$parent_domain$&
12779 .vindex "&$parent_domain$&"
12780 This variable is similar to &$original_domain$& (see
12781 above), except that it refers to the immediately preceding parent address.
12782
12783 .vitem &$parent_local_part$&
12784 .vindex "&$parent_local_part$&"
12785 This variable is similar to &$original_local_part$&
12786 (see above), except that it refers to the immediately preceding parent address.
12787
12788 .vitem &$pid$&
12789 .cindex "pid (process id)" "of current process"
12790 .vindex "&$pid$&"
12791 This variable contains the current process id.
12792
12793 .vitem &$pipe_addresses$&
12794 .cindex "filter" "transport filter"
12795 .cindex "transport" "filter"
12796 .vindex "&$pipe_addresses$&"
12797 This is not an expansion variable, but is mentioned here because the string
12798 &`$pipe_addresses`& is handled specially in the command specification for the
12799 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12800 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12801 It cannot be used in general expansion strings, and provokes an &"unknown
12802 variable"& error if encountered.
12803
12804 .vitem &$primary_hostname$&
12805 .vindex "&$primary_hostname$&"
12806 This variable contains the value set by &%primary_hostname%& in the
12807 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12808 a single-component name, Exim calls &[gethostbyname()]& (or
12809 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12810 qualified host name. See also &$smtp_active_hostname$&.
12811
12812
12813 .vitem &$proxy_external_address$& &&&
12814        &$proxy_external_port$& &&&
12815        &$proxy_local_address$& &&&
12816        &$proxy_local_port$& &&&
12817        &$proxy_session$&
12818 These variables are only available when built with Proxy Protocol
12819 or SOCKS5 support.
12820 For details see chapter &<<SECTproxyInbound>>&.
12821
12822 .vitem &$prdr_requested$&
12823 .cindex "PRDR" "variable for"
12824 This variable is set to &"yes"& if PRDR was requested by the client for the
12825 current message, otherwise &"no"&.
12826
12827 .vitem &$prvscheck_address$&
12828 This variable is used in conjunction with the &%prvscheck%& expansion item,
12829 which is described in sections &<<SECTexpansionitems>>& and
12830 &<<SECTverifyPRVS>>&.
12831
12832 .vitem &$prvscheck_keynum$&
12833 This variable is used in conjunction with the &%prvscheck%& expansion item,
12834 which is described in sections &<<SECTexpansionitems>>& and
12835 &<<SECTverifyPRVS>>&.
12836
12837 .vitem &$prvscheck_result$&
12838 This variable is used in conjunction with the &%prvscheck%& expansion item,
12839 which is described in sections &<<SECTexpansionitems>>& and
12840 &<<SECTverifyPRVS>>&.
12841
12842 .vitem &$qualify_domain$&
12843 .vindex "&$qualify_domain$&"
12844 The value set for the &%qualify_domain%& option in the configuration file.
12845
12846 .vitem &$qualify_recipient$&
12847 .vindex "&$qualify_recipient$&"
12848 The value set for the &%qualify_recipient%& option in the configuration file,
12849 or if not set, the value of &$qualify_domain$&.
12850
12851 .vitem &$queue_name$&
12852 .vindex &$queue_name$&
12853 .cindex "named queues" variable
12854 .cindex queues named
12855 The name of the spool queue in use; empty for the default queue.
12856
12857 .vitem &$r_...$&
12858 .vindex &$r_...$&
12859 .cindex router variables
12860 Values can be placed in these variables by the &%set%& option of a router.
12861 They can be given any name that starts with &$r_$&.
12862 The values persist for the address being handled through subsequent routers
12863 and the eventual transport.
12864
12865 .vitem &$rcpt_count$&
12866 .vindex "&$rcpt_count$&"
12867 When a message is being received by SMTP, this variable contains the number of
12868 RCPT commands received for the current message. If this variable is used in a
12869 RCPT ACL, its value includes the current command.
12870
12871 .vitem &$rcpt_defer_count$&
12872 .vindex "&$rcpt_defer_count$&"
12873 .cindex "4&'xx'& responses" "count of"
12874 When a message is being received by SMTP, this variable contains the number of
12875 RCPT commands in the current message that have previously been rejected with a
12876 temporary (4&'xx'&) response.
12877
12878 .vitem &$rcpt_fail_count$&
12879 .vindex "&$rcpt_fail_count$&"
12880 When a message is being received by SMTP, this variable contains the number of
12881 RCPT commands in the current message that have previously been rejected with a
12882 permanent (5&'xx'&) response.
12883
12884 .vitem &$received_count$&
12885 .vindex "&$received_count$&"
12886 This variable contains the number of &'Received:'& header lines in the message,
12887 including the one added by Exim (so its value is always greater than zero). It
12888 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12889 delivering.
12890
12891 .vitem &$received_for$&
12892 .vindex "&$received_for$&"
12893 If there is only a single recipient address in an incoming message, this
12894 variable contains that address when the &'Received:'& header line is being
12895 built. The value is copied after recipient rewriting has happened, but before
12896 the &[local_scan()]& function is run.
12897
12898 .vitem &$received_ip_address$&
12899 .vindex "&$received_ip_address$&"
12900 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12901 variable is set to the address of the local IP interface, and &$received_port$&
12902 is set to the local port number. (The remote IP address and port are in
12903 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12904 the port value is -1 unless it has been set using the &%-oMi%& command line
12905 option.
12906
12907 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12908 could be used, for example, to make the filename for a TLS certificate depend
12909 on which interface and/or port is being used for the incoming connection. The
12910 values of &$received_ip_address$& and &$received_port$& are saved with any
12911 messages that are received, thus making these variables available at delivery
12912 time.
12913 For outbound connections see &$sending_ip_address$&.
12914
12915 .vitem &$received_port$&
12916 .vindex "&$received_port$&"
12917 See &$received_ip_address$&.
12918
12919 .vitem &$received_protocol$&
12920 .vindex "&$received_protocol$&"
12921 When a message is being processed, this variable contains the name of the
12922 protocol by which it was received. Most of the names used by Exim are defined
12923 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12924 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12925 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12926 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12927 connection and the client was successfully authenticated.
12928
12929 Exim uses the protocol name &"smtps"& for the case when encryption is
12930 automatically set up on connection without the use of STARTTLS (see
12931 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12932 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12933 where the client initially uses EHLO, sets up an encrypted connection using
12934 STARTTLS, and then uses HELO afterwards.
12935
12936 The &%-oMr%& option provides a way of specifying a custom protocol name for
12937 messages that are injected locally by trusted callers. This is commonly used to
12938 identify messages that are being re-injected after some kind of scanning.
12939
12940 .vitem &$received_time$&
12941 .vindex "&$received_time$&"
12942 This variable contains the date and time when the current message was received,
12943 as a number of seconds since the start of the Unix epoch.
12944
12945 .vitem &$recipient_data$&
12946 .vindex "&$recipient_data$&"
12947 This variable is set after an indexing lookup success in an ACL &%recipients%&
12948 condition. It contains the data from the lookup, and the value remains set
12949 until the next &%recipients%& test. Thus, you can do things like this:
12950 .display
12951 &`require recipients  = cdb*@;/some/file`&
12952 &`deny    `&&'some further test involving'& &`$recipient_data`&
12953 .endd
12954 &*Warning*&: This variable is set only when a lookup is used as an indexing
12955 method in the address list, using the semicolon syntax as in the example above.
12956 The variable is not set for a lookup that is used as part of the string
12957 expansion that all such lists undergo before being interpreted.
12958
12959 .vitem &$recipient_verify_failure$&
12960 .vindex "&$recipient_verify_failure$&"
12961 In an ACL, when a recipient verification fails, this variable contains
12962 information about the failure. It is set to one of the following words:
12963
12964 .ilist
12965 &"qualify"&: The address was unqualified (no domain), and the message
12966 was neither local nor came from an exempted host.
12967
12968 .next
12969 &"route"&: Routing failed.
12970
12971 .next
12972 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12973 or before the MAIL command (that is, on initial connection, HELO, or
12974 MAIL).
12975
12976 .next
12977 &"recipient"&: The RCPT command in a callout was rejected.
12978 .next
12979
12980 &"postmaster"&: The postmaster check in a callout was rejected.
12981 .endlist
12982
12983 The main use of this variable is expected to be to distinguish between
12984 rejections of MAIL and rejections of RCPT.
12985
12986 .vitem &$recipients$&
12987 .vindex "&$recipients$&"
12988 This variable contains a list of envelope recipients for a message. A comma and
12989 a space separate the addresses in the replacement text. However, the variable
12990 is not generally available, to prevent exposure of Bcc recipients in
12991 unprivileged users' filter files. You can use &$recipients$& only in these
12992 cases:
12993
12994 .olist
12995 In a system filter file.
12996 .next
12997 In the ACLs associated with the DATA command and with non-SMTP messages, that
12998 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12999 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13000 &%acl_not_smtp_mime%&.
13001 .next
13002 From within a &[local_scan()]& function.
13003 .endlist
13004
13005
13006 .vitem &$recipients_count$&
13007 .vindex "&$recipients_count$&"
13008 When a message is being processed, this variable contains the number of
13009 envelope recipients that came with the message. Duplicates are not excluded
13010 from the count. While a message is being received over SMTP, the number
13011 increases for each accepted recipient. It can be referenced in an ACL.
13012
13013
13014 .vitem &$regex_match_string$&
13015 .vindex "&$regex_match_string$&"
13016 This variable is set to contain the matching regular expression after a
13017 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13018
13019 .vitem "&$regex1$&, &$regex2$&, etc"
13020 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13021 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13022 these variables contain the
13023 captured substrings identified by the regular expression.
13024
13025
13026 .vitem &$reply_address$&
13027 .vindex "&$reply_address$&"
13028 When a message is being processed, this variable contains the contents of the
13029 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13030 contents of the &'From:'& header line. Apart from the removal of leading
13031 white space, the value is not processed in any way. In particular, no RFC 2047
13032 decoding or character code translation takes place.
13033
13034 .vitem &$return_path$&
13035 .vindex "&$return_path$&"
13036 When a message is being delivered, this variable contains the return path &--
13037 the sender field that will be sent as part of the envelope. It is not enclosed
13038 in <> characters. At the start of routing an address, &$return_path$& has the
13039 same value as &$sender_address$&, but if, for example, an incoming message to a
13040 mailing list has been expanded by a router which specifies a different address
13041 for bounce messages, &$return_path$& subsequently contains the new bounce
13042 address, whereas &$sender_address$& always contains the original sender address
13043 that was received with the message. In other words, &$sender_address$& contains
13044 the incoming envelope sender, and &$return_path$& contains the outgoing
13045 envelope sender.
13046
13047 .vitem &$return_size_limit$&
13048 .vindex "&$return_size_limit$&"
13049 This is an obsolete name for &$bounce_return_size_limit$&.
13050
13051 .vitem &$router_name$&
13052 .cindex "router" "name"
13053 .cindex "name" "of router"
13054 .vindex "&$router_name$&"
13055 During the running of a router this variable contains its name.
13056
13057 .vitem &$runrc$&
13058 .cindex "return code" "from &%run%& expansion"
13059 .vindex "&$runrc$&"
13060 This variable contains the return code from a command that is run by the
13061 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13062 assume the order in which option values are expanded, except for those
13063 preconditions whose order of testing is documented. Therefore, you cannot
13064 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13065 another.
13066
13067 .vitem &$self_hostname$&
13068 .oindex "&%self%&" "value of host name"
13069 .vindex "&$self_hostname$&"
13070 When an address is routed to a supposedly remote host that turns out to be the
13071 local host, what happens is controlled by the &%self%& generic router option.
13072 One of its values causes the address to be passed to another router. When this
13073 happens, &$self_hostname$& is set to the name of the local host that the
13074 original router encountered. In other circumstances its contents are null.
13075
13076 .vitem &$sender_address$&
13077 .vindex "&$sender_address$&"
13078 When a message is being processed, this variable contains the sender's address
13079 that was received in the message's envelope. The case of letters in the address
13080 is retained, in both the local part and the domain. For bounce messages, the
13081 value of this variable is the empty string. See also &$return_path$&.
13082
13083 .vitem &$sender_address_data$&
13084 .vindex "&$address_data$&"
13085 .vindex "&$sender_address_data$&"
13086 If &$address_data$& is set when the routers are called from an ACL to verify a
13087 sender address, the final value is preserved in &$sender_address_data$&, to
13088 distinguish it from data from a recipient address. The value does not persist
13089 after the end of the current ACL statement. If you want to preserve it for
13090 longer, you can save it in an ACL variable.
13091
13092 .vitem &$sender_address_domain$&
13093 .vindex "&$sender_address_domain$&"
13094 The domain portion of &$sender_address$&.
13095
13096 .vitem &$sender_address_local_part$&
13097 .vindex "&$sender_address_local_part$&"
13098 The local part portion of &$sender_address$&.
13099
13100 .vitem &$sender_data$&
13101 .vindex "&$sender_data$&"
13102 This variable is set after a lookup success in an ACL &%senders%& condition or
13103 in a router &%senders%& option. It contains the data from the lookup, and the
13104 value remains set until the next &%senders%& test. Thus, you can do things like
13105 this:
13106 .display
13107 &`require senders      = cdb*@;/some/file`&
13108 &`deny    `&&'some further test involving'& &`$sender_data`&
13109 .endd
13110 &*Warning*&: This variable is set only when a lookup is used as an indexing
13111 method in the address list, using the semicolon syntax as in the example above.
13112 The variable is not set for a lookup that is used as part of the string
13113 expansion that all such lists undergo before being interpreted.
13114
13115 .vitem &$sender_fullhost$&
13116 .vindex "&$sender_fullhost$&"
13117 When a message is received from a remote host, this variable contains the host
13118 name and IP address in a single string. It ends with the IP address in square
13119 brackets, followed by a colon and a port number if the logging of ports is
13120 enabled. The format of the rest of the string depends on whether the host
13121 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13122 looking up its IP address. (Looking up the IP address can be forced by the
13123 &%host_lookup%& option, independent of verification.) A plain host name at the
13124 start of the string is a verified host name; if this is not present,
13125 verification either failed or was not requested. A host name in parentheses is
13126 the argument of a HELO or EHLO command. This is omitted if it is identical to
13127 the verified host name or to the host's IP address in square brackets.
13128
13129 .vitem &$sender_helo_dnssec$&
13130 .vindex "&$sender_helo_dnssec$&"
13131 This boolean variable is true if a successful HELO verification was
13132 .cindex "DNS" "DNSSEC"
13133 done using DNS information the resolver library stated was authenticated data.
13134
13135 .vitem &$sender_helo_name$&
13136 .vindex "&$sender_helo_name$&"
13137 When a message is received from a remote host that has issued a HELO or EHLO
13138 command, the argument of that command is placed in this variable. It is also
13139 set if HELO or EHLO is used when a message is received using SMTP locally via
13140 the &%-bs%& or &%-bS%& options.
13141
13142 .vitem &$sender_host_address$&
13143 .vindex "&$sender_host_address$&"
13144 When a message is received from a remote host using SMTP,
13145 this variable contains that
13146 host's IP address. For locally non-SMTP submitted messages, it is empty.
13147
13148 .vitem &$sender_host_authenticated$&
13149 .vindex "&$sender_host_authenticated$&"
13150 This variable contains the name (not the public name) of the authenticator
13151 driver that successfully authenticated the client from which the message was
13152 received. It is empty if there was no successful authentication. See also
13153 &$authenticated_id$&.
13154
13155 .vitem &$sender_host_dnssec$&
13156 .vindex "&$sender_host_dnssec$&"
13157 If an attempt to populate &$sender_host_name$& has been made
13158 (by reference, &%hosts_lookup%& or
13159 otherwise) then this boolean will have been set true if, and only if, the
13160 resolver library states that both
13161 the reverse and forward DNS were authenticated data.  At all
13162 other times, this variable is false.
13163
13164 .cindex "DNS" "DNSSEC"
13165 It is likely that you will need to coerce DNSSEC support on in the resolver
13166 library, by setting:
13167 .code
13168 dns_dnssec_ok = 1
13169 .endd
13170
13171 Exim does not perform DNSSEC validation itself, instead leaving that to a
13172 validating resolver (e.g. unbound, or bind with suitable configuration).
13173
13174 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13175 mechanism in the list, then this variable will be false.
13176
13177 This requires that your system resolver library support EDNS0 (and that
13178 DNSSEC flags exist in the system headers).  If the resolver silently drops
13179 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13180 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13181
13182
13183 .vitem &$sender_host_name$&
13184 .vindex "&$sender_host_name$&"
13185 When a message is received from a remote host, this variable contains the
13186 host's name as obtained by looking up its IP address. For messages received by
13187 other means, this variable is empty.
13188
13189 .vindex "&$host_lookup_failed$&"
13190 If the host name has not previously been looked up, a reference to
13191 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13192 A looked up name is accepted only if it leads back to the original IP address
13193 via a forward lookup. If either the reverse or the forward lookup fails to find
13194 any data, or if the forward lookup does not yield the original IP address,
13195 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13196
13197 .vindex "&$host_lookup_deferred$&"
13198 However, if either of the lookups cannot be completed (for example, there is a
13199 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13200 &$host_lookup_failed$& remains set to &"0"&.
13201
13202 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13203 host name again if there is a subsequent reference to &$sender_host_name$&
13204 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13205 is set to &"1"&.
13206
13207 Exim does not automatically look up every calling host's name. If you want
13208 maximum efficiency, you should arrange your configuration so that it avoids
13209 these lookups altogether. The lookup happens only if one or more of the
13210 following are true:
13211
13212 .ilist
13213 A string containing &$sender_host_name$& is expanded.
13214 .next
13215 The calling host matches the list in &%host_lookup%&. In the default
13216 configuration, this option is set to *, so it must be changed if lookups are
13217 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13218 .next
13219 Exim needs the host name in order to test an item in a host list. The items
13220 that require this are described in sections &<<SECThoslispatnam>>& and
13221 &<<SECThoslispatnamsk>>&.
13222 .next
13223 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13224 In this case, the host name is required to compare with the name quoted in any
13225 EHLO or HELO commands that the client issues.
13226 .next
13227 The remote host issues a EHLO or HELO command that quotes one of the
13228 domains in &%helo_lookup_domains%&. The default value of this option is
13229 . ==== As this is a nested list, any displays it contains must be indented
13230 . ==== as otherwise they are too far to the left.
13231 .code
13232   helo_lookup_domains = @ : @[]
13233 .endd
13234 which causes a lookup if a remote host (incorrectly) gives the server's name or
13235 IP address in an EHLO or HELO command.
13236 .endlist
13237
13238
13239 .vitem &$sender_host_port$&
13240 .vindex "&$sender_host_port$&"
13241 When a message is received from a remote host, this variable contains the port
13242 number that was used on the remote host.
13243
13244 .vitem &$sender_ident$&
13245 .vindex "&$sender_ident$&"
13246 When a message is received from a remote host, this variable contains the
13247 identification received in response to an RFC 1413 request. When a message has
13248 been received locally, this variable contains the login name of the user that
13249 called Exim.
13250
13251 .vitem &$sender_rate_$&&'xxx'&
13252 A number of variables whose names begin &$sender_rate_$& are set as part of the
13253 &%ratelimit%& ACL condition. Details are given in section
13254 &<<SECTratelimiting>>&.
13255
13256 .vitem &$sender_rcvhost$&
13257 .cindex "DNS" "reverse lookup"
13258 .cindex "reverse DNS lookup"
13259 .vindex "&$sender_rcvhost$&"
13260 This is provided specifically for use in &'Received:'& headers. It starts with
13261 either the verified host name (as obtained from a reverse DNS lookup) or, if
13262 there is no verified host name, the IP address in square brackets. After that
13263 there may be text in parentheses. When the first item is a verified host name,
13264 the first thing in the parentheses is the IP address in square brackets,
13265 followed by a colon and a port number if port logging is enabled. When the
13266 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13267 the parentheses.
13268
13269 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13270 was used and its argument was not identical to the real host name or IP
13271 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13272 all three items are present in the parentheses, a newline and tab are inserted
13273 into the string, to improve the formatting of the &'Received:'& header.
13274
13275 .vitem &$sender_verify_failure$&
13276 .vindex "&$sender_verify_failure$&"
13277 In an ACL, when a sender verification fails, this variable contains information
13278 about the failure. The details are the same as for
13279 &$recipient_verify_failure$&.
13280
13281 .vitem &$sending_ip_address$&
13282 .vindex "&$sending_ip_address$&"
13283 This variable is set whenever an outgoing SMTP connection to another host has
13284 been set up. It contains the IP address of the local interface that is being
13285 used. This is useful if a host that has more than one IP address wants to take
13286 on different personalities depending on which one is being used. For incoming
13287 connections, see &$received_ip_address$&.
13288
13289 .vitem &$sending_port$&
13290 .vindex "&$sending_port$&"
13291 This variable is set whenever an outgoing SMTP connection to another host has
13292 been set up. It contains the local port that is being used. For incoming
13293 connections, see &$received_port$&.
13294
13295 .vitem &$smtp_active_hostname$&
13296 .vindex "&$smtp_active_hostname$&"
13297 During an incoming SMTP session, this variable contains the value of the active
13298 host name, as specified by the &%smtp_active_hostname%& option. The value of
13299 &$smtp_active_hostname$& is saved with any message that is received, so its
13300 value can be consulted during routing and delivery.
13301
13302 .vitem &$smtp_command$&
13303 .vindex "&$smtp_command$&"
13304 During the processing of an incoming SMTP command, this variable contains the
13305 entire command. This makes it possible to distinguish between HELO and EHLO in
13306 the HELO ACL, and also to distinguish between commands such as these:
13307 .code
13308 MAIL FROM:<>
13309 MAIL FROM: <>
13310 .endd
13311 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13312 command, the address in &$smtp_command$& is the original address before any
13313 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13314 the address after SMTP-time rewriting.
13315
13316 .vitem &$smtp_command_argument$&
13317 .cindex "SMTP" "command, argument for"
13318 .vindex "&$smtp_command_argument$&"
13319 While an ACL is running to check an SMTP command, this variable contains the
13320 argument, that is, the text that follows the command name, with leading white
13321 space removed. Following the introduction of &$smtp_command$&, this variable is
13322 somewhat redundant, but is retained for backwards compatibility.
13323
13324 .vitem &$smtp_command_history$&
13325 .cindex SMTP "command history"
13326 .vindex "&$smtp_command_history$&"
13327 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13328 received, in time-order left to right.  Only a limited number of commands
13329 are remembered.
13330
13331 .vitem &$smtp_count_at_connection_start$&
13332 .vindex "&$smtp_count_at_connection_start$&"
13333 This variable is set greater than zero only in processes spawned by the Exim
13334 daemon for handling incoming SMTP connections. The name is deliberately long,
13335 in order to emphasize what the contents are. When the daemon accepts a new
13336 connection, it increments this variable. A copy of the variable is passed to
13337 the child process that handles the connection, but its value is fixed, and
13338 never changes. It is only an approximation of how many incoming connections
13339 there actually are, because many other connections may come and go while a
13340 single connection is being processed. When a child process terminates, the
13341 daemon decrements its copy of the variable.
13342
13343 .vitem "&$sn0$& &-- &$sn9$&"
13344 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13345 that were current at the end of the system filter file. This allows a system
13346 filter file to set values that can be tested in users' filter files. For
13347 example, a system filter could set a value indicating how likely it is that a
13348 message is junk mail.
13349
13350 .vitem &$spam_$&&'xxx'&
13351 A number of variables whose names start with &$spam$& are available when Exim
13352 is compiled with the content-scanning extension. For details, see section
13353 &<<SECTscanspamass>>&.
13354
13355 .vitem &$spf_header_comment$& &&&
13356        &$spf_received$& &&&
13357        &$spf_result$& &&&
13358        &$spf_result_guessed$& &&&
13359        &$spf_smtp_comment$&
13360 These variables are only available if Exim is built with SPF support.
13361 For details see section &<<SECSPF>>&.
13362
13363 .vitem &$spool_directory$&
13364 .vindex "&$spool_directory$&"
13365 The name of Exim's spool directory.
13366
13367 .vitem &$spool_inodes$&
13368 .vindex "&$spool_inodes$&"
13369 The number of free inodes in the disk partition where Exim's spool files are
13370 being written. The value is recalculated whenever the variable is referenced.
13371 If the relevant file system does not have the concept of inodes, the value of
13372 is -1. See also the &%check_spool_inodes%& option.
13373
13374 .vitem &$spool_space$&
13375 .vindex "&$spool_space$&"
13376 The amount of free space (as a number of kilobytes) in the disk partition where
13377 Exim's spool files are being written. The value is recalculated whenever the
13378 variable is referenced. If the operating system does not have the ability to
13379 find the amount of free space (only true for experimental systems), the space
13380 value is -1. For example, to check in an ACL that there is at least 50
13381 megabytes free on the spool, you could write:
13382 .code
13383 condition = ${if > {$spool_space}{50000}}
13384 .endd
13385 See also the &%check_spool_space%& option.
13386
13387
13388 .vitem &$thisaddress$&
13389 .vindex "&$thisaddress$&"
13390 This variable is set only during the processing of the &%foranyaddress%&
13391 command in a filter file. Its use is explained in the description of that
13392 command, which can be found in the separate document entitled &'Exim's
13393 interfaces to mail filtering'&.
13394
13395 .vitem &$tls_in_bits$&
13396 .vindex "&$tls_in_bits$&"
13397 Contains an approximation of the TLS cipher's bit-strength
13398 on the inbound connection; the meaning of
13399 this depends upon the TLS implementation used.
13400 If TLS has not been negotiated, the value will be 0.
13401 The value of this is automatically fed into the Cyrus SASL authenticator
13402 when acting as a server, to specify the "external SSF" (a SASL term).
13403
13404 The deprecated &$tls_bits$& variable refers to the inbound side
13405 except when used in the context of an outbound SMTP delivery, when it refers to
13406 the outbound.
13407
13408 .vitem &$tls_out_bits$&
13409 .vindex "&$tls_out_bits$&"
13410 Contains an approximation of the TLS cipher's bit-strength
13411 on an outbound SMTP connection; the meaning of
13412 this depends upon the TLS implementation used.
13413 If TLS has not been negotiated, the value will be 0.
13414
13415 .vitem &$tls_in_ourcert$&
13416 .vindex "&$tls_in_ourcert$&"
13417 .cindex certificate variables
13418 This variable refers to the certificate presented to the peer of an
13419 inbound connection when the message was received.
13420 It is only useful as the argument of a
13421 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13422 or a &%def%& condition.
13423
13424 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13425 when a list of more than one
13426 file is used for &%tls_certificate%&, this variable is not reliable.
13427 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13428
13429 .vitem &$tls_in_peercert$&
13430 .vindex "&$tls_in_peercert$&"
13431 This variable refers to the certificate presented by the peer of an
13432 inbound connection when the message was received.
13433 It is only useful as the argument of a
13434 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13435 or a &%def%& condition.
13436 If certificate verification fails it may refer to a failing chain element
13437 which is not the leaf.
13438
13439 .vitem &$tls_out_ourcert$&
13440 .vindex "&$tls_out_ourcert$&"
13441 This variable refers to the certificate presented to the peer of an
13442 outbound connection.  It is only useful as the argument of a
13443 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13444 or a &%def%& condition.
13445
13446 .vitem &$tls_out_peercert$&
13447 .vindex "&$tls_out_peercert$&"
13448 This variable refers to the certificate presented by the peer of an
13449 outbound connection.  It is only useful as the argument of a
13450 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13451 or a &%def%& condition.
13452 If certificate verification fails it may refer to a failing chain element
13453 which is not the leaf.
13454
13455 .vitem &$tls_in_certificate_verified$&
13456 .vindex "&$tls_in_certificate_verified$&"
13457 This variable is set to &"1"& if a TLS certificate was verified when the
13458 message was received, and &"0"& otherwise.
13459
13460 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13461 except when used in the context of an outbound SMTP delivery, when it refers to
13462 the outbound.
13463
13464 .vitem &$tls_out_certificate_verified$&
13465 .vindex "&$tls_out_certificate_verified$&"
13466 This variable is set to &"1"& if a TLS certificate was verified when an
13467 outbound SMTP connection was made,
13468 and &"0"& otherwise.
13469
13470 .vitem &$tls_in_cipher$&
13471 .vindex "&$tls_in_cipher$&"
13472 .vindex "&$tls_cipher$&"
13473 When a message is received from a remote host over an encrypted SMTP
13474 connection, this variable is set to the cipher suite that was negotiated, for
13475 example DES-CBC3-SHA. In other circumstances, in particular, for message
13476 received over unencrypted connections, the variable is empty. Testing
13477 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13478 non-encrypted connections during ACL processing.
13479
13480 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13481 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13482 becomes the same as &$tls_out_cipher$&.
13483
13484 .vitem &$tls_in_cipher_std$&
13485 .vindex "&$tls_in_cipher_std$&"
13486 As above, but returning the RFC standard name for the cipher suite.
13487
13488 .vitem &$tls_out_cipher$&
13489 .vindex "&$tls_out_cipher$&"
13490 This variable is
13491 cleared before any outgoing SMTP connection is made,
13492 and then set to the outgoing cipher suite if one is negotiated. See chapter
13493 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13494 details of the &(smtp)& transport.
13495
13496 .vitem &$tls_out_cipher_std$&
13497 .vindex "&$tls_out_cipher_std$&"
13498 As above, but returning the RFC standard name for the cipher suite.
13499
13500 .vitem &$tls_out_dane$&
13501 .vindex &$tls_out_dane$&
13502 DANE active status.  See section &<<SECDANE>>&.
13503
13504 .vitem &$tls_in_ocsp$&
13505 .vindex "&$tls_in_ocsp$&"
13506 When a message is received from a remote client connection
13507 the result of any OCSP request from the client is encoded in this variable:
13508 .code
13509 0 OCSP proof was not requested (default value)
13510 1 No response to request
13511 2 Response not verified
13512 3 Verification failed
13513 4 Verification succeeded
13514 .endd
13515
13516 .vitem &$tls_out_ocsp$&
13517 .vindex "&$tls_out_ocsp$&"
13518 When a message is sent to a remote host connection
13519 the result of any OCSP request made is encoded in this variable.
13520 See &$tls_in_ocsp$& for values.
13521
13522 .vitem &$tls_in_peerdn$&
13523 .vindex "&$tls_in_peerdn$&"
13524 .vindex "&$tls_peerdn$&"
13525 .cindex certificate "extracting fields"
13526 When a message is received from a remote host over an encrypted SMTP
13527 connection, and Exim is configured to request a certificate from the client,
13528 the value of the Distinguished Name of the certificate is made available in the
13529 &$tls_in_peerdn$& during subsequent processing.
13530 If certificate verification fails it may refer to a failing chain element
13531 which is not the leaf.
13532
13533 The deprecated &$tls_peerdn$& variable refers to the inbound side
13534 except when used in the context of an outbound SMTP delivery, when it refers to
13535 the outbound.
13536
13537 .vitem &$tls_out_peerdn$&
13538 .vindex "&$tls_out_peerdn$&"
13539 When a message is being delivered to a remote host over an encrypted SMTP
13540 connection, and Exim is configured to request a certificate from the server,
13541 the value of the Distinguished Name of the certificate is made available in the
13542 &$tls_out_peerdn$& during subsequent processing.
13543 If certificate verification fails it may refer to a failing chain element
13544 which is not the leaf.
13545
13546 .vitem &$tls_in_sni$&
13547 .vindex "&$tls_in_sni$&"
13548 .vindex "&$tls_sni$&"
13549 .cindex "TLS" "Server Name Indication"
13550 When a TLS session is being established, if the client sends the Server
13551 Name Indication extension, the value will be placed in this variable.
13552 If the variable appears in &%tls_certificate%& then this option and
13553 some others, described in &<<SECTtlssni>>&,
13554 will be re-expanded early in the TLS session, to permit
13555 a different certificate to be presented (and optionally a different key to be
13556 used) to the client, based upon the value of the SNI extension.
13557
13558 The deprecated &$tls_sni$& variable refers to the inbound side
13559 except when used in the context of an outbound SMTP delivery, when it refers to
13560 the outbound.
13561
13562 .vitem &$tls_out_sni$&
13563 .vindex "&$tls_out_sni$&"
13564 .cindex "TLS" "Server Name Indication"
13565 During outbound
13566 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13567 the transport.
13568
13569 .vitem &$tls_out_tlsa_usage$&
13570 .vindex &$tls_out_tlsa_usage$&
13571 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13572
13573 .vitem &$tls_in_ver$&
13574 .vindex "&$tls_in_ver$&"
13575 When a message is received from a remote host over an encrypted SMTP connection
13576 this variable is set to the protocol version, eg &'TLS1.2'&.
13577
13578 .vitem &$tls_out_ver$&
13579 .vindex "&$tls_out_ver$&"
13580 When a message is being delivered to a remote host over an encrypted SMTP connection
13581 this variable is set to the protocol version.
13582
13583
13584 .vitem &$tod_bsdinbox$&
13585 .vindex "&$tod_bsdinbox$&"
13586 The time of day and the date, in the format required for BSD-style mailbox
13587 files, for example: Thu Oct 17 17:14:09 1995.
13588
13589 .vitem &$tod_epoch$&
13590 .vindex "&$tod_epoch$&"
13591 The time and date as a number of seconds since the start of the Unix epoch.
13592
13593 .vitem &$tod_epoch_l$&
13594 .vindex "&$tod_epoch_l$&"
13595 The time and date as a number of microseconds since the start of the Unix epoch.
13596
13597 .vitem &$tod_full$&
13598 .vindex "&$tod_full$&"
13599 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13600 +0100. The timezone is always given as a numerical offset from UTC, with
13601 positive values used for timezones that are ahead (east) of UTC, and negative
13602 values for those that are behind (west).
13603
13604 .vitem &$tod_log$&
13605 .vindex "&$tod_log$&"
13606 The time and date in the format used for writing Exim's log files, for example:
13607 1995-10-12 15:32:29, but without a timezone.
13608
13609 .vitem &$tod_logfile$&
13610 .vindex "&$tod_logfile$&"
13611 This variable contains the date in the format yyyymmdd. This is the format that
13612 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13613 flag.
13614
13615 .vitem &$tod_zone$&
13616 .vindex "&$tod_zone$&"
13617 This variable contains the numerical value of the local timezone, for example:
13618 -0500.
13619
13620 .vitem &$tod_zulu$&
13621 .vindex "&$tod_zulu$&"
13622 This variable contains the UTC date and time in &"Zulu"& format, as specified
13623 by ISO 8601, for example: 20030221154023Z.
13624
13625 .vitem &$transport_name$&
13626 .cindex "transport" "name"
13627 .cindex "name" "of transport"
13628 .vindex "&$transport_name$&"
13629 During the running of a transport, this variable contains its name.
13630
13631 .vitem &$value$&
13632 .vindex "&$value$&"
13633 This variable contains the result of an expansion lookup, extraction operation,
13634 or external command, as described above. It is also used during a
13635 &*reduce*& expansion.
13636
13637 .vitem &$verify_mode$&
13638 .vindex "&$verify_mode$&"
13639 While a router or transport is being run in verify mode or for cutthrough delivery,
13640 contains "S" for sender-verification or "R" for recipient-verification.
13641 Otherwise, empty.
13642
13643 .vitem &$version_number$&
13644 .vindex "&$version_number$&"
13645 The version number of Exim. Same as &$exim_version$&, may be overridden
13646 by the &%exim_version%& main config option.
13647
13648 .vitem &$warn_message_delay$&
13649 .vindex "&$warn_message_delay$&"
13650 This variable is set only during the creation of a message warning about a
13651 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13652
13653 .vitem &$warn_message_recipients$&
13654 .vindex "&$warn_message_recipients$&"
13655 This variable is set only during the creation of a message warning about a
13656 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13657 .endlist
13658 .ecindex IIDstrexp
13659
13660
13661
13662 . ////////////////////////////////////////////////////////////////////////////
13663 . ////////////////////////////////////////////////////////////////////////////
13664
13665 .chapter "Embedded Perl" "CHAPperl"
13666 .scindex IIDperl "Perl" "calling from Exim"
13667 Exim can be built to include an embedded Perl interpreter. When this is done,
13668 Perl subroutines can be called as part of the string expansion process. To make
13669 use of the Perl support, you need version 5.004 or later of Perl installed on
13670 your system. To include the embedded interpreter in the Exim binary, include
13671 the line
13672 .code
13673 EXIM_PERL = perl.o
13674 .endd
13675 in your &_Local/Makefile_& and then build Exim in the normal way.
13676
13677
13678 .section "Setting up so Perl can be used" "SECID85"
13679 .oindex "&%perl_startup%&"
13680 Access to Perl subroutines is via a global configuration option called
13681 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13682 no &%perl_startup%& option in the Exim configuration file then no Perl
13683 interpreter is started and there is almost no overhead for Exim (since none of
13684 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13685 option then the associated value is taken to be Perl code which is executed in
13686 a newly created Perl interpreter.
13687
13688 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13689 need backslashes before any characters to escape special meanings. The option
13690 should usually be something like
13691 .code
13692 perl_startup = do '/etc/exim.pl'
13693 .endd
13694 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13695 use from Exim. Exim can be configured either to start up a Perl interpreter as
13696 soon as it is entered, or to wait until the first time it is needed. Starting
13697 the interpreter at the beginning ensures that it is done while Exim still has
13698 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13699 fact used in a particular run. Also, note that this does not mean that Exim is
13700 necessarily running as root when Perl is called at a later time. By default,
13701 the interpreter is started only when it is needed, but this can be changed in
13702 two ways:
13703
13704 .ilist
13705 .oindex "&%perl_at_start%&"
13706 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13707 a startup when Exim is entered.
13708 .next
13709 The command line option &%-ps%& also requests a startup when Exim is entered,
13710 overriding the setting of &%perl_at_start%&.
13711 .endlist
13712
13713 There is also a command line option &%-pd%& (for delay) which suppresses the
13714 initial startup, even if &%perl_at_start%& is set.
13715
13716 .ilist
13717 .oindex "&%perl_taintmode%&"
13718 .cindex "Perl" "taintmode"
13719 To provide more security executing Perl code via the embedded Perl
13720 interpreter, the &%perl_taintmode%& option can be set. This enables the
13721 taint mode of the Perl interpreter. You are encouraged to set this
13722 option to a true value. To avoid breaking existing installations, it
13723 defaults to false.
13724
13725
13726 .section "Calling Perl subroutines" "SECID86"
13727 When the configuration file includes a &%perl_startup%& option you can make use
13728 of the string expansion item to call the Perl subroutines that are defined
13729 by the &%perl_startup%& code. The operator is used in any of the following
13730 forms:
13731 .code
13732 ${perl{foo}}
13733 ${perl{foo}{argument}}
13734 ${perl{foo}{argument1}{argument2} ... }
13735 .endd
13736 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13737 arguments may be passed. Passing more than this results in an expansion failure
13738 with an error message of the form
13739 .code
13740 Too many arguments passed to Perl subroutine "foo" (max is 8)
13741 .endd
13742 The return value of the Perl subroutine is evaluated in a scalar context before
13743 it is passed back to Exim to be inserted into the expanded string. If the
13744 return value is &'undef'&, the expansion is forced to fail in the same way as
13745 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13746 by obeying Perl's &%die%& function, the expansion fails with the error message
13747 that was passed to &%die%&.
13748
13749
13750 .section "Calling Exim functions from Perl" "SECID87"
13751 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13752 is available to call back into Exim's string expansion function. For example,
13753 the Perl code
13754 .code
13755 my $lp = Exim::expand_string('$local_part');
13756 .endd
13757 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13758 Note those are single quotes and not double quotes to protect against
13759 &$local_part$& being interpolated as a Perl variable.
13760
13761 If the string expansion is forced to fail by a &"fail"& item, the result of
13762 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13763 expansion string, the Perl call from the original expansion string fails with
13764 an appropriate error message, in the same way as if &%die%& were used.
13765
13766 .cindex "debugging" "from embedded Perl"
13767 .cindex "log" "writing from embedded Perl"
13768 Two other Exim functions are available for use from within Perl code.
13769 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13770 debugging is enabled. If you want a newline at the end, you must supply it.
13771 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13772 timestamp. In this case, you should not supply a terminating newline.
13773
13774
13775 .section "Use of standard output and error by Perl" "SECID88"
13776 .cindex "Perl" "standard output and error"
13777 You should not write to the standard error or output streams from within your
13778 Perl code, as it is not defined how these are set up. In versions of Exim
13779 before 4.50, it is possible for the standard output or error to refer to the
13780 SMTP connection during message reception via the daemon. Writing to this stream
13781 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13782 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13783 avoided, but the output is lost.
13784
13785 .cindex "Perl" "use of &%warn%&"
13786 The Perl &%warn%& statement writes to the standard error stream by default.
13787 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13788 you have no control. When Exim starts up the Perl interpreter, it arranges for
13789 output from the &%warn%& statement to be written to the Exim main log. You can
13790 change this by including appropriate Perl magic somewhere in your Perl code.
13791 For example, to discard &%warn%& output completely, you need this:
13792 .code
13793 $SIG{__WARN__} = sub { };
13794 .endd
13795 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13796 example, the code for the subroutine is empty, so it does nothing, but you can
13797 include any Perl code that you like. The text of the &%warn%& message is passed
13798 as the first subroutine argument.
13799 .ecindex IIDperl
13800
13801
13802 . ////////////////////////////////////////////////////////////////////////////
13803 . ////////////////////////////////////////////////////////////////////////////
13804
13805 .chapter "Starting the daemon and the use of network interfaces" &&&
13806          "CHAPinterfaces" &&&
13807          "Starting the daemon"
13808 .cindex "daemon" "starting"
13809 .cindex "interface" "listening"
13810 .cindex "network interface"
13811 .cindex "interface" "network"
13812 .cindex "IP address" "for listening"
13813 .cindex "daemon" "listening IP addresses"
13814 .cindex "TCP/IP" "setting listening interfaces"
13815 .cindex "TCP/IP" "setting listening ports"
13816 A host that is connected to a TCP/IP network may have one or more physical
13817 hardware network interfaces. Each of these interfaces may be configured as one
13818 or more &"logical"& interfaces, which are the entities that a program actually
13819 works with. Each of these logical interfaces is associated with an IP address.
13820 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13821 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13822 knowledge about the host's interfaces for use in three different circumstances:
13823
13824 .olist
13825 When a listening daemon is started, Exim needs to know which interfaces
13826 and ports to listen on.
13827 .next
13828 When Exim is routing an address, it needs to know which IP addresses
13829 are associated with local interfaces. This is required for the correct
13830 processing of MX lists by removing the local host and others with the
13831 same or higher priority values. Also, Exim needs to detect cases
13832 when an address is routed to an IP address that in fact belongs to the
13833 local host. Unless the &%self%& router option or the &%allow_localhost%&
13834 option of the smtp transport is set (as appropriate), this is treated
13835 as an error situation.
13836 .next
13837 When Exim connects to a remote host, it may need to know which interface to use
13838 for the outgoing connection.
13839 .endlist
13840
13841
13842 Exim's default behaviour is likely to be appropriate in the vast majority
13843 of cases. If your host has only one interface, and you want all its IP
13844 addresses to be treated in the same way, and you are using only the
13845 standard SMTP port, you should not need to take any special action. The
13846 rest of this chapter does not apply to you.
13847
13848 In a more complicated situation you may want to listen only on certain
13849 interfaces, or on different ports, and for this reason there are a number of
13850 options that can be used to influence Exim's behaviour. The rest of this
13851 chapter describes how they operate.
13852
13853 When a message is received over TCP/IP, the interface and port that were
13854 actually used are set in &$received_ip_address$& and &$received_port$&.
13855
13856
13857
13858 .section "Starting a listening daemon" "SECID89"
13859 When a listening daemon is started (by means of the &%-bd%& command line
13860 option), the interfaces and ports on which it listens are controlled by the
13861 following options:
13862
13863 .ilist
13864 &%daemon_smtp_ports%& contains a list of default ports
13865 or service names.
13866 (For backward compatibility, this option can also be specified in the singular.)
13867 .next
13868 &%local_interfaces%& contains list of interface IP addresses on which to
13869 listen. Each item may optionally also specify a port.
13870 .endlist
13871
13872 The default list separator in both cases is a colon, but this can be changed as
13873 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13874 it is usually best to change the separator to avoid having to double all the
13875 colons. For example:
13876 .code
13877 local_interfaces = <; 127.0.0.1 ; \
13878                       192.168.23.65 ; \
13879                       ::1 ; \
13880                       3ffe:ffff:836f::fe86:a061
13881 .endd
13882 There are two different formats for specifying a port along with an IP address
13883 in &%local_interfaces%&:
13884
13885 .olist
13886 The port is added onto the address with a dot separator. For example, to listen
13887 on port 1234 on two different IP addresses:
13888 .code
13889 local_interfaces = <; 192.168.23.65.1234 ; \
13890                       3ffe:ffff:836f::fe86:a061.1234
13891 .endd
13892 .next
13893 The IP address is enclosed in square brackets, and the port is added
13894 with a colon separator, for example:
13895 .code
13896 local_interfaces = <; [192.168.23.65]:1234 ; \
13897                       [3ffe:ffff:836f::fe86:a061]:1234
13898 .endd
13899 .endlist
13900
13901 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13902 default setting contains just one port:
13903 .code
13904 daemon_smtp_ports = smtp
13905 .endd
13906 If more than one port is listed, each interface that does not have its own port
13907 specified listens on all of them. Ports that are listed in
13908 &%daemon_smtp_ports%& can be identified either by name (defined in
13909 &_/etc/services_&) or by number. However, when ports are given with individual
13910 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13911
13912
13913
13914 .section "Special IP listening addresses" "SECID90"
13915 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13916 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13917 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13918 instead of setting up separate listening sockets for each interface. The
13919 default value of &%local_interfaces%& is
13920 .code
13921 local_interfaces = 0.0.0.0
13922 .endd
13923 when Exim is built without IPv6 support; otherwise it is:
13924 .code
13925 local_interfaces = <; ::0 ; 0.0.0.0
13926 .endd
13927 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13928
13929
13930
13931 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13932 The &%-oX%& command line option can be used to override the values of
13933 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13934 instance. Another way of doing this would be to use macros and the &%-D%&
13935 option. However, &%-oX%& can be used by any admin user, whereas modification of
13936 the runtime configuration by &%-D%& is allowed only when the caller is root or
13937 exim.
13938
13939 The value of &%-oX%& is a list of items. The default colon separator can be
13940 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13941 If there are any items that do not
13942 contain dots or colons (that is, are not IP addresses), the value of
13943 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13944 items that do contain dots or colons, the value of &%local_interfaces%& is
13945 replaced by those items. Thus, for example,
13946 .code
13947 -oX 1225
13948 .endd
13949 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13950 whereas
13951 .code
13952 -oX 192.168.34.5.1125
13953 .endd
13954 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13955 (However, since &%local_interfaces%& now contains no items without ports, the
13956 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13957
13958
13959
13960 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13961 .cindex "submissions protocol"
13962 .cindex "ssmtp protocol"
13963 .cindex "smtps protocol"
13964 .cindex "SMTP" "ssmtp protocol"
13965 .cindex "SMTP" "smtps protocol"
13966 Exim supports the use of TLS-on-connect, used by mail clients in the
13967 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13968 For some years, IETF Standards Track documents only blessed the
13969 STARTTLS-based Submission service (port 587) while common practice was to support
13970 the same feature set on port 465, but using TLS-on-connect.
13971 If your installation needs to provide service to mail clients
13972 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13973 the 465 TCP ports.
13974
13975 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13976 service names, connections to those ports must first establish TLS, before
13977 proceeding to the application layer use of the SMTP protocol.
13978
13979 The common use of this option is expected to be
13980 .code
13981 tls_on_connect_ports = 465
13982 .endd
13983 per RFC 8314.
13984 There is also a command line option &%-tls-on-connect%&, which forces all ports
13985 to behave in this way when a daemon is started.
13986
13987 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13988 daemon to listen on those ports. You must still specify them in
13989 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13990 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13991 connections via the daemon.)
13992
13993
13994
13995
13996 .section "IPv6 address scopes" "SECID92"
13997 .cindex "IPv6" "address scopes"
13998 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13999 can, in principle, have the same link-local IPv6 address on different
14000 interfaces. Thus, additional information is needed, over and above the IP
14001 address, to distinguish individual interfaces. A convention of using a
14002 percent sign followed by something (often the interface name) has been
14003 adopted in some cases, leading to addresses like this:
14004 .code
14005 fe80::202:b3ff:fe03:45c1%eth0
14006 .endd
14007 To accommodate this usage, a percent sign followed by an arbitrary string is
14008 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14009 to convert a textual IPv6 address for actual use. This function recognizes the
14010 percent convention in operating systems that support it, and it processes the
14011 address appropriately. Unfortunately, some older libraries have problems with
14012 &[getaddrinfo()]&. If
14013 .code
14014 IPV6_USE_INET_PTON=yes
14015 .endd
14016 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14017 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14018 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14019 function.) Of course, this means that the additional functionality of
14020 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14021
14022 .section "Disabling IPv6" "SECID93"
14023 .cindex "IPv6" "disabling"
14024 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14025 run on a host whose kernel does not support IPv6. The binary will fall back to
14026 using IPv4, but it may waste resources looking up AAAA records, and trying to
14027 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14028 .oindex "&%disable_ipv6%&"
14029 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14030 activities take place. AAAA records are never looked up, and any IPv6 addresses
14031 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14032 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14033 to handle IPv6 literal addresses.
14034
14035 On the other hand, when IPv6 is in use, there may be times when you want to
14036 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14037 option to globally suppress the lookup of AAAA records for specified domains,
14038 and you can use the &%ignore_target_hosts%& generic router option to ignore
14039 IPv6 addresses in an individual router.
14040
14041
14042
14043 .section "Examples of starting a listening daemon" "SECID94"
14044 The default case in an IPv6 environment is
14045 .code
14046 daemon_smtp_ports = smtp
14047 local_interfaces = <; ::0 ; 0.0.0.0
14048 .endd
14049 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14050 Either one or two sockets may be used, depending on the characteristics of
14051 the TCP/IP stack. (This is complicated and messy; for more information,
14052 read the comments in the &_daemon.c_& source file.)
14053
14054 To specify listening on ports 25 and 26 on all interfaces:
14055 .code
14056 daemon_smtp_ports = 25 : 26
14057 .endd
14058 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14059 .code
14060 local_interfaces = <; ::0.25     ; ::0.26 \
14061                       0.0.0.0.25 ; 0.0.0.0.26
14062 .endd
14063 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14064 IPv4 loopback address only:
14065 .code
14066 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14067 .endd
14068 To specify listening on the default port on specific interfaces only:
14069 .code
14070 local_interfaces = 10.0.0.67 : 192.168.34.67
14071 .endd
14072 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14073
14074
14075
14076 .section "Recognizing the local host" "SECTreclocipadd"
14077 The &%local_interfaces%& option is also used when Exim needs to determine
14078 whether or not an IP address refers to the local host. That is, the IP
14079 addresses of all the interfaces on which a daemon is listening are always
14080 treated as local.
14081
14082 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14083 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14084 available interfaces from the operating system, and extracts the relevant
14085 (that is, IPv4 or IPv6) addresses to use for checking.
14086
14087 Some systems set up large numbers of virtual interfaces in order to provide
14088 many virtual web servers. In this situation, you may want to listen for
14089 email on only a few of the available interfaces, but nevertheless treat all
14090 interfaces as local when routing. You can do this by setting
14091 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14092 &"all"& wildcard values. These addresses are recognized as local, but are not
14093 used for listening. Consider this example:
14094 .code
14095 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14096                       192.168.53.235 ; \
14097                       3ffe:2101:12:1:a00:20ff:fe86:a061
14098
14099 extra_local_interfaces = <; ::0 ; 0.0.0.0
14100 .endd
14101 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14102 address, but all available interface addresses are treated as local when
14103 Exim is routing.
14104
14105 In some environments the local host name may be in an MX list, but with an IP
14106 address that is not assigned to any local interface. In other cases it may be
14107 desirable to treat other host names as if they referred to the local host. Both
14108 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14109 This contains host names rather than IP addresses. When a host is referenced
14110 during routing, either via an MX record or directly, it is treated as the local
14111 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14112 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14113
14114
14115
14116 .section "Delivering to a remote host" "SECID95"
14117 Delivery to a remote host is handled by the smtp transport. By default, it
14118 allows the system's TCP/IP functions to choose which interface to use (if
14119 there is more than one) when connecting to a remote host. However, the
14120 &%interface%& option can be set to specify which interface is used. See the
14121 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14122 details.
14123
14124
14125
14126
14127 . ////////////////////////////////////////////////////////////////////////////
14128 . ////////////////////////////////////////////////////////////////////////////
14129
14130 .chapter "Main configuration" "CHAPmainconfig"
14131 .scindex IIDconfima "configuration file" "main section"
14132 .scindex IIDmaiconf "main configuration"
14133 The first part of the runtime configuration file contains three types of item:
14134
14135 .ilist
14136 Macro definitions: These lines start with an upper case letter. See section
14137 &<<SECTmacrodefs>>& for details of macro processing.
14138 .next
14139 Named list definitions: These lines start with one of the words &"domainlist"&,
14140 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14141 section &<<SECTnamedlists>>&.
14142 .next
14143 Main configuration settings: Each setting occupies one line of the file
14144 (with possible continuations). If any setting is preceded by the word
14145 &"hide"&, the &%-bP%& command line option displays its value to admin users
14146 only. See section &<<SECTcos>>& for a description of the syntax of these option
14147 settings.
14148 .endlist
14149
14150 This chapter specifies all the main configuration options, along with their
14151 types and default values. For ease of finding a particular option, they appear
14152 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14153 are now so many options, they are first listed briefly in functional groups, as
14154 an aid to finding the name of the option you are looking for. Some options are
14155 listed in more than one group.
14156
14157 .section "Miscellaneous" "SECID96"
14158 .table2
14159 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14160 .row &%debug_store%&                 "do extra internal checks"
14161 .row &%disable_ipv6%&                "do no IPv6 processing"
14162 .row &%keep_malformed%&              "for broken files &-- should not happen"
14163 .row &%localhost_number%&            "for unique message ids in clusters"
14164 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14165 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14166 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14167 .row &%print_topbitchars%&           "top-bit characters are printing"
14168 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14169 .row &%timezone%&                    "force time zone"
14170 .endtable
14171
14172
14173 .section "Exim parameters" "SECID97"
14174 .table2
14175 .row &%exim_group%&                  "override compiled-in value"
14176 .row &%exim_path%&                   "override compiled-in value"
14177 .row &%exim_user%&                   "override compiled-in value"
14178 .row &%primary_hostname%&            "default from &[uname()]&"
14179 .row &%split_spool_directory%&       "use multiple directories"
14180 .row &%spool_directory%&             "override compiled-in value"
14181 .endtable
14182
14183
14184
14185 .section "Privilege controls" "SECID98"
14186 .table2
14187 .row &%admin_groups%&                "groups that are Exim admin users"
14188 .row &%commandline_checks_require_admin%& "require admin for various checks"
14189 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14190 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14191 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14192 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14193 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14194 .row &%never_users%&                 "do not run deliveries as these"
14195 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14196 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14197 .row &%trusted_groups%&              "groups that are trusted"
14198 .row &%trusted_users%&               "users that are trusted"
14199 .endtable
14200
14201
14202
14203 .section "Logging" "SECID99"
14204 .table2
14205 .row &%event_action%&                "custom logging"
14206 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14207 .row &%log_file_path%&               "override compiled-in value"
14208 .row &%log_selector%&                "set/unset optional logging"
14209 .row &%log_timezone%&                "add timezone to log lines"
14210 .row &%message_logs%&                "create per-message logs"
14211 .row &%preserve_message_logs%&       "after message completion"
14212 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14213 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14214 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14215 .row &%syslog_facility%&             "set syslog &""facility""& field"
14216 .row &%syslog_pid%&                  "pid in syslog lines"
14217 .row &%syslog_processname%&          "set syslog &""ident""& field"
14218 .row &%syslog_timestamp%&            "timestamp syslog lines"
14219 .row &%write_rejectlog%&             "control use of message log"
14220 .endtable
14221
14222
14223
14224 .section "Frozen messages" "SECID100"
14225 .table2
14226 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14227 .row &%freeze_tell%&                 "send message when freezing"
14228 .row &%move_frozen_messages%&        "to another directory"
14229 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14230 .endtable
14231
14232
14233
14234 .section "Data lookups" "SECID101"
14235 .table2
14236 .row &%ibase_servers%&               "InterBase servers"
14237 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14238 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14239 .row &%ldap_cert_file%&              "client cert file for LDAP"
14240 .row &%ldap_cert_key%&               "client key file for LDAP"
14241 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14242 .row &%ldap_default_servers%&        "used if no server in query"
14243 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14244 .row &%ldap_start_tls%&              "require TLS within LDAP"
14245 .row &%ldap_version%&                "set protocol version"
14246 .row &%lookup_open_max%&             "lookup files held open"
14247 .row &%mysql_servers%&               "default MySQL servers"
14248 .row &%oracle_servers%&              "Oracle servers"
14249 .row &%pgsql_servers%&               "default PostgreSQL servers"
14250 .row &%sqlite_lock_timeout%&         "as it says"
14251 .endtable
14252
14253
14254
14255 .section "Message ids" "SECID102"
14256 .table2
14257 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14258 .row &%message_id_header_text%&      "ditto"
14259 .endtable
14260
14261
14262
14263 .section "Embedded Perl Startup" "SECID103"
14264 .table2
14265 .row &%perl_at_start%&               "always start the interpreter"
14266 .row &%perl_startup%&                "code to obey when starting Perl"
14267 .row &%perl_taintmode%&              "enable taint mode in Perl"
14268 .endtable
14269
14270
14271
14272 .section "Daemon" "SECID104"
14273 .table2
14274 .row &%daemon_smtp_ports%&           "default ports"
14275 .row &%daemon_startup_retries%&      "number of times to retry"
14276 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14277 .row &%extra_local_interfaces%&      "not necessarily listened on"
14278 .row &%local_interfaces%&            "on which to listen, with optional ports"
14279 .row &%pid_file_path%&               "override compiled-in value"
14280 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14281 .endtable
14282
14283
14284
14285 .section "Resource control" "SECID105"
14286 .table2
14287 .row &%check_log_inodes%&            "before accepting a message"
14288 .row &%check_log_space%&             "before accepting a message"
14289 .row &%check_spool_inodes%&          "before accepting a message"
14290 .row &%check_spool_space%&           "before accepting a message"
14291 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14292 .row &%queue_only_load%&             "queue incoming if load high"
14293 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14294 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14295 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14296 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14297 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14298 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14299 .row &%smtp_accept_max_per_connection%& "messages per connection"
14300 .row &%smtp_accept_max_per_host%&    "connections from one host"
14301 .row &%smtp_accept_queue%&           "queue mail if more connections"
14302 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14303                                            connection"
14304 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14305 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14306 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14307 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14308 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14309 .endtable
14310
14311
14312
14313 .section "Policy controls" "SECID106"
14314 .table2
14315 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14316 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14317 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14318 .row &%acl_smtp_auth%&               "ACL for AUTH"
14319 .row &%acl_smtp_connect%&            "ACL for connection"
14320 .row &%acl_smtp_data%&               "ACL for DATA"
14321 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14322 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14323 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14324 .row &%acl_smtp_expn%&               "ACL for EXPN"
14325 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14326 .row &%acl_smtp_mail%&               "ACL for MAIL"
14327 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14328 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14329 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14330 .row &%acl_smtp_predata%&            "ACL for start of data"
14331 .row &%acl_smtp_quit%&               "ACL for QUIT"
14332 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14333 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14334 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14335 .row &%av_scanner%&                  "specify virus scanner"
14336 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14337                                       words""&"
14338 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14339 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14340 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14341 .row &%header_maxsize%&              "total size of message header"
14342 .row &%header_line_maxsize%&         "individual header line limit"
14343 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14344 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14345 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14346 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14347 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14348 .row &%host_lookup%&                 "host name looked up for these hosts"
14349 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14350 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14351 .row &%host_reject_connection%&      "reject connection from these hosts"
14352 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14353 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14354 .row &%message_size_limit%&          "for all messages"
14355 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14356 .row &%spamd_address%&               "set interface to SpamAssassin"
14357 .row &%strict_acl_vars%&             "object to unset ACL variables"
14358 .endtable
14359
14360
14361
14362 .section "Callout cache" "SECID107"
14363 .table2
14364 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14365                                          item"
14366 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14367                                          item"
14368 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14369 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14370 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14371 .endtable
14372
14373
14374
14375 .section "TLS" "SECID108"
14376 .table2
14377 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14378 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14379 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14380 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14381 .row &%tls_certificate%&             "location of server certificate"
14382 .row &%tls_crl%&                     "certificate revocation list"
14383 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14384 .row &%tls_dhparam%&                 "DH parameters for server"
14385 .row &%tls_eccurve%&                 "EC curve selection for server"
14386 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14387 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14388 .row &%tls_privatekey%&              "location of server private key"
14389 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14390 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14391 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14392 .row &%tls_verify_certificates%&     "expected client certificates"
14393 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14394 .endtable
14395
14396
14397
14398 .section "Local user handling" "SECID109"
14399 .table2
14400 .row &%finduser_retries%&            "useful in NIS environments"
14401 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14402 .row &%gecos_pattern%&               "ditto"
14403 .row &%max_username_length%&         "for systems that truncate"
14404 .row &%unknown_login%&               "used when no login name found"
14405 .row &%unknown_username%&            "ditto"
14406 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14407 .row &%uucp_from_sender%&            "ditto"
14408 .endtable
14409
14410
14411
14412 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14413 .table2
14414 .row &%header_maxsize%&              "total size of message header"
14415 .row &%header_line_maxsize%&         "individual header line limit"
14416 .row &%message_size_limit%&          "applies to all messages"
14417 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14418 .row &%received_header_text%&        "expanded to make &'Received:'&"
14419 .row &%received_headers_max%&        "for mail loop detection"
14420 .row &%recipients_max%&              "limit per message"
14421 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14422 .endtable
14423
14424
14425
14426
14427 .section "Non-SMTP incoming messages" "SECID111"
14428 .table2
14429 .row &%receive_timeout%&             "for non-SMTP messages"
14430 .endtable
14431
14432
14433
14434
14435
14436 .section "Incoming SMTP messages" "SECID112"
14437 See also the &'Policy controls'& section above.
14438
14439 .table2
14440 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14441 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14442 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14443 .row &%host_lookup%&                 "host name looked up for these hosts"
14444 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14445 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14446 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14447 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14448 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14449 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14450 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14451 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14452 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14453 .row &%smtp_accept_max_per_connection%& "messages per connection"
14454 .row &%smtp_accept_max_per_host%&    "connections from one host"
14455 .row &%smtp_accept_queue%&           "queue mail if more connections"
14456 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14457                                            connection"
14458 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14459 .row &%smtp_active_hostname%&        "host name to use in messages"
14460 .row &%smtp_banner%&                 "text for welcome banner"
14461 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14462 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14463 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14464 .row &%smtp_etrn_command%&           "what to run for ETRN"
14465 .row &%smtp_etrn_serialize%&         "only one at once"
14466 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14467 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14468 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14469 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14470 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14471 .row &%smtp_receive_timeout%&        "per command or data line"
14472 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14473 .row &%smtp_return_error_details%&   "give detail on rejections"
14474 .endtable
14475
14476
14477
14478 .section "SMTP extensions" "SECID113"
14479 .table2
14480 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14481 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14482 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14483 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14484 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14485 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14486 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14487 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14488 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14489 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14490 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14491 .endtable
14492
14493
14494
14495 .section "Processing messages" "SECID114"
14496 .table2
14497 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14498 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14499 .row &%allow_utf8_domains%&          "in addresses"
14500 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14501                                       words""&"
14502 .row &%delivery_date_remove%&        "from incoming messages"
14503 .row &%envelope_to_remove%&          "from incoming messages"
14504 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14505 .row &%headers_charset%&             "default for translations"
14506 .row &%qualify_domain%&              "default for senders"
14507 .row &%qualify_recipient%&           "default for recipients"
14508 .row &%return_path_remove%&          "from incoming messages"
14509 .row &%strip_excess_angle_brackets%& "in addresses"
14510 .row &%strip_trailing_dot%&          "at end of addresses"
14511 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14512 .endtable
14513
14514
14515
14516 .section "System filter" "SECID115"
14517 .table2
14518 .row &%system_filter%&               "locate system filter"
14519 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14520                                             directory"
14521 .row &%system_filter_file_transport%& "transport for delivery to a file"
14522 .row &%system_filter_group%&         "group for filter running"
14523 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14524 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14525 .row &%system_filter_user%&          "user for filter running"
14526 .endtable
14527
14528
14529
14530 .section "Routing and delivery" "SECID116"
14531 .table2
14532 .row &%disable_ipv6%&                "do no IPv6 processing"
14533 .row &%dns_again_means_nonexist%&    "for broken domains"
14534 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14535 .row &%dns_dnssec_ok%&               "parameter for resolver"
14536 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14537 .row &%dns_retrans%&                 "parameter for resolver"
14538 .row &%dns_retry%&                   "parameter for resolver"
14539 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14540 .row &%dns_use_edns0%&               "parameter for resolver"
14541 .row &%hold_domains%&                "hold delivery for these domains"
14542 .row &%local_interfaces%&            "for routing checks"
14543 .row &%queue_domains%&               "no immediate delivery for these"
14544 .row &%queue_only%&                  "no immediate delivery at all"
14545 .row &%queue_only_file%&             "no immediate delivery if file exists"
14546 .row &%queue_only_load%&             "no immediate delivery if load is high"
14547 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14548 .row &%queue_only_override%&         "allow command line to override"
14549 .row &%queue_run_in_order%&          "order of arrival"
14550 .row &%queue_run_max%&               "of simultaneous queue runners"
14551 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14552 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14553 .row &%remote_sort_domains%&         "order of remote deliveries"
14554 .row &%retry_data_expire%&           "timeout for retry data"
14555 .row &%retry_interval_max%&          "safety net for retry rules"
14556 .endtable
14557
14558
14559
14560 .section "Bounce and warning messages" "SECID117"
14561 .table2
14562 .row &%bounce_message_file%&         "content of bounce"
14563 .row &%bounce_message_text%&         "content of bounce"
14564 .row &%bounce_return_body%&          "include body if returning message"
14565 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14566 .row &%bounce_return_message%&       "include original message in bounce"
14567 .row &%bounce_return_size_limit%&    "limit on returned message"
14568 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14569 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14570 .row &%errors_copy%&                 "copy bounce messages"
14571 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14572 .row &%delay_warning%&               "time schedule"
14573 .row &%delay_warning_condition%&     "condition for warning messages"
14574 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14575 .row &%smtp_return_error_details%&   "give detail on rejections"
14576 .row &%warn_message_file%&           "content of warning message"
14577 .endtable
14578
14579
14580
14581 .section "Alphabetical list of main options" "SECTalomo"
14582 Those options that undergo string expansion before use are marked with
14583 &dagger;.
14584
14585 .option accept_8bitmime main boolean true
14586 .cindex "8BITMIME"
14587 .cindex "8-bit characters"
14588 .cindex "log" "selectors"
14589 .cindex "log" "8BITMIME"
14590 This option causes Exim to send 8BITMIME in its response to an SMTP
14591 EHLO command, and to accept the BODY= parameter on MAIL commands.
14592 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14593 takes no steps to do anything special with messages received by this route.
14594
14595 Historically Exim kept this option off by default, but the maintainers
14596 feel that in today's Internet, this causes more problems than it solves.
14597 It now defaults to true.
14598 A more detailed analysis of the issues is provided by Dan Bernstein:
14599 .display
14600 &url(https://cr.yp.to/smtp/8bitmime.html)
14601 .endd
14602
14603 To log received 8BITMIME status use
14604 .code
14605 log_selector = +8bitmime
14606 .endd
14607
14608 .option acl_not_smtp main string&!! unset
14609 .cindex "&ACL;" "for non-SMTP messages"
14610 .cindex "non-SMTP messages" "ACLs for"
14611 This option defines the ACL that is run when a non-SMTP message has been
14612 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14613 further details.
14614
14615 .option acl_not_smtp_mime main string&!! unset
14616 This option defines the ACL that is run for individual MIME parts of non-SMTP
14617 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14618 SMTP messages.
14619
14620 .option acl_not_smtp_start main string&!! unset
14621 .cindex "&ACL;" "at start of non-SMTP message"
14622 .cindex "non-SMTP messages" "ACLs for"
14623 This option defines the ACL that is run before Exim starts reading a
14624 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14625
14626 .option acl_smtp_auth main string&!! unset
14627 .cindex "&ACL;" "setting up for SMTP commands"
14628 .cindex "AUTH" "ACL for"
14629 This option defines the ACL that is run when an SMTP AUTH command is
14630 received. See chapter &<<CHAPACL>>& for further details.
14631
14632 .option acl_smtp_connect main string&!! unset
14633 .cindex "&ACL;" "on SMTP connection"
14634 This option defines the ACL that is run when an SMTP connection is received.
14635 See chapter &<<CHAPACL>>& for further details.
14636
14637 .option acl_smtp_data main string&!! unset
14638 .cindex "DATA" "ACL for"
14639 This option defines the ACL that is run after an SMTP DATA command has been
14640 processed and the message itself has been received, but before the final
14641 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14642
14643 .option acl_smtp_data_prdr main string&!! accept
14644 .cindex "PRDR" "ACL for"
14645 .cindex "DATA" "PRDR ACL for"
14646 .cindex "&ACL;" "PRDR-related"
14647 .cindex "&ACL;" "per-user data processing"
14648 This option defines the ACL that,
14649 if the PRDR feature has been negotiated,
14650 is run for each recipient after an SMTP DATA command has been
14651 processed and the message itself has been received, but before the
14652 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14653
14654 .option acl_smtp_dkim main string&!! unset
14655 .cindex DKIM "ACL for"
14656 This option defines the ACL that is run for each DKIM signature
14657 (by default, or as specified in the dkim_verify_signers option)
14658 of a received message.
14659 See section &<<SECDKIMVFY>>& for further details.
14660
14661 .option acl_smtp_etrn main string&!! unset
14662 .cindex "ETRN" "ACL for"
14663 This option defines the ACL that is run when an SMTP ETRN command is
14664 received. See chapter &<<CHAPACL>>& for further details.
14665
14666 .option acl_smtp_expn main string&!! unset
14667 .cindex "EXPN" "ACL for"
14668 This option defines the ACL that is run when an SMTP EXPN command is
14669 received. See chapter &<<CHAPACL>>& for further details.
14670
14671 .option acl_smtp_helo main string&!! unset
14672 .cindex "EHLO" "ACL for"
14673 .cindex "HELO" "ACL for"
14674 This option defines the ACL that is run when an SMTP EHLO or HELO
14675 command is received. See chapter &<<CHAPACL>>& for further details.
14676
14677
14678 .option acl_smtp_mail main string&!! unset
14679 .cindex "MAIL" "ACL for"
14680 This option defines the ACL that is run when an SMTP MAIL command is
14681 received. See chapter &<<CHAPACL>>& for further details.
14682
14683 .option acl_smtp_mailauth main string&!! unset
14684 .cindex "AUTH" "on MAIL command"
14685 This option defines the ACL that is run when there is an AUTH parameter on
14686 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14687 &<<CHAPSMTPAUTH>>& for details of authentication.
14688
14689 .option acl_smtp_mime main string&!! unset
14690 .cindex "MIME content scanning" "ACL for"
14691 This option is available when Exim is built with the content-scanning
14692 extension. It defines the ACL that is run for each MIME part in a message. See
14693 section &<<SECTscanmimepart>>& for details.
14694
14695 .option acl_smtp_notquit main string&!! unset
14696 .cindex "not-QUIT, ACL for"
14697 This option defines the ACL that is run when an SMTP session
14698 ends without a QUIT command being received.
14699 See chapter &<<CHAPACL>>& for further details.
14700
14701 .option acl_smtp_predata main string&!! unset
14702 This option defines the ACL that is run when an SMTP DATA command is
14703 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14704 further details.
14705
14706 .option acl_smtp_quit main string&!! unset
14707 .cindex "QUIT, ACL for"
14708 This option defines the ACL that is run when an SMTP QUIT command is
14709 received. See chapter &<<CHAPACL>>& for further details.
14710
14711 .option acl_smtp_rcpt main string&!! unset
14712 .cindex "RCPT" "ACL for"
14713 This option defines the ACL that is run when an SMTP RCPT command is
14714 received. See chapter &<<CHAPACL>>& for further details.
14715
14716 .option acl_smtp_starttls main string&!! unset
14717 .cindex "STARTTLS, ACL for"
14718 This option defines the ACL that is run when an SMTP STARTTLS command is
14719 received. See chapter &<<CHAPACL>>& for further details.
14720
14721 .option acl_smtp_vrfy main string&!! unset
14722 .cindex "VRFY" "ACL for"
14723 This option defines the ACL that is run when an SMTP VRFY command is
14724 received. See chapter &<<CHAPACL>>& for further details.
14725
14726 .option add_environment main "string list" empty
14727 .cindex "environment" "set values"
14728 This option adds individual environment variables that the
14729 currently linked libraries and programs in child processes may use.
14730 Each list element should be of the form &"name=value"&.
14731
14732 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14733
14734 .option admin_groups main "string list&!!" unset
14735 .cindex "admin user"
14736 This option is expanded just once, at the start of Exim's processing. If the
14737 current group or any of the supplementary groups of an Exim caller is in this
14738 colon-separated list, the caller has admin privileges. If all your system
14739 programmers are in a specific group, for example, you can give them all Exim
14740 admin privileges by putting that group in &%admin_groups%&. However, this does
14741 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14742 To permit this, you have to add individuals to the Exim group.
14743
14744 .option allow_domain_literals main boolean false
14745 .cindex "domain literal"
14746 If this option is set, the RFC 2822 domain literal format is permitted in
14747 email addresses. The option is not set by default, because the domain literal
14748 format is not normally required these days, and few people know about it. It
14749 has, however, been exploited by mail abusers.
14750
14751 Unfortunately, it seems that some DNS black list maintainers are using this
14752 format to report black listing to postmasters. If you want to accept messages
14753 addressed to your hosts by IP address, you need to set
14754 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14755 domains (defined in the named domain list &%local_domains%& in the default
14756 configuration). This &"magic string"& matches the domain literal form of all
14757 the local host's IP addresses.
14758
14759
14760 .option allow_mx_to_ip main boolean false
14761 .cindex "MX record" "pointing to IP address"
14762 It appears that more and more DNS zone administrators are breaking the rules
14763 and putting domain names that look like IP addresses on the right hand side of
14764 MX records. Exim follows the rules and rejects this, giving an error message
14765 that explains the misconfiguration. However, some other MTAs support this
14766 practice, so to avoid &"Why can't Exim do this?"& complaints,
14767 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14768 recommended, except when you have no other choice.
14769
14770 .option allow_utf8_domains main boolean false
14771 .cindex "domain" "UTF-8 characters in"
14772 .cindex "UTF-8" "in domain name"
14773 Lots of discussion is going on about internationalized domain names. One
14774 camp is strongly in favour of just using UTF-8 characters, and it seems
14775 that at least two other MTAs permit this.
14776 This option allows Exim users to experiment if they wish.
14777
14778 If it is set true, Exim's domain parsing function allows valid
14779 UTF-8 multicharacters to appear in domain name components, in addition to
14780 letters, digits, and hyphens.
14781
14782 If Exim is built with internationalization support
14783 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14784 this option can be left as default.
14785 Without that,
14786 if you want to look up such domain names in the DNS, you must also
14787 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14788 suitable setting is:
14789 .code
14790 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14791   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14792 .endd
14793 Alternatively, you can just disable this feature by setting
14794 .code
14795 dns_check_names_pattern =
14796 .endd
14797 That is, set the option to an empty string so that no check is done.
14798
14799
14800 .option auth_advertise_hosts main "host list&!!" *
14801 .cindex "authentication" "advertising"
14802 .cindex "AUTH" "advertising"
14803 If any server authentication mechanisms are configured, Exim advertises them in
14804 response to an EHLO command only if the calling host matches this list.
14805 Otherwise, Exim does not advertise AUTH.
14806 Exim does not accept AUTH commands from clients to which it has not
14807 advertised the availability of AUTH. The advertising of individual
14808 authentication mechanisms can be controlled by the use of the
14809 &%server_advertise_condition%& generic authenticator option on the individual
14810 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14811
14812 Certain mail clients (for example, Netscape) require the user to provide a name
14813 and password for authentication if AUTH is advertised, even though it may
14814 not be needed (the host may accept messages from hosts on its local LAN without
14815 authentication, for example). The &%auth_advertise_hosts%& option can be used
14816 to make these clients more friendly by excluding them from the set of hosts to
14817 which Exim advertises AUTH.
14818
14819 .cindex "AUTH" "advertising when encrypted"
14820 If you want to advertise the availability of AUTH only when the connection
14821 is encrypted using TLS, you can make use of the fact that the value of this
14822 option is expanded, with a setting like this:
14823 .code
14824 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14825 .endd
14826 .vindex "&$tls_in_cipher$&"
14827 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14828 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14829 expansion is *, which matches all hosts.
14830
14831
14832 .option auto_thaw main time 0s
14833 .cindex "thawing messages"
14834 .cindex "unfreezing messages"
14835 If this option is set to a time greater than zero, a queue runner will try a
14836 new delivery attempt on any frozen message, other than a bounce message, if
14837 this much time has passed since it was frozen. This may result in the message
14838 being re-frozen if nothing has changed since the last attempt. It is a way of
14839 saying &"keep on trying, even though there are big problems"&.
14840
14841 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14842 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14843 thought to be very useful any more, and its use should probably be avoided.
14844
14845
14846 .option av_scanner main string "see below"
14847 This option is available if Exim is built with the content-scanning extension.
14848 It specifies which anti-virus scanner to use. The default value is:
14849 .code
14850 sophie:/var/run/sophie
14851 .endd
14852 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14853 before use. See section &<<SECTscanvirus>>& for further details.
14854
14855
14856 .option bi_command main string unset
14857 .oindex "&%-bi%&"
14858 This option supplies the name of a command that is run when Exim is called with
14859 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14860 just the command name, it is not a complete command line. If an argument is
14861 required, it must come from the &%-oA%& command line option.
14862
14863
14864 .option bounce_message_file main string unset
14865 .cindex "bounce message" "customizing"
14866 .cindex "customizing" "bounce message"
14867 This option defines a template file containing paragraphs of text to be used
14868 for constructing bounce messages.  Details of the file's contents are given in
14869 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14870
14871
14872 .option bounce_message_text main string unset
14873 When this option is set, its contents are included in the default bounce
14874 message immediately after &"This message was created automatically by mail
14875 delivery software."& It is not used if &%bounce_message_file%& is set.
14876
14877 .option bounce_return_body main boolean true
14878 .cindex "bounce message" "including body"
14879 This option controls whether the body of an incoming message is included in a
14880 bounce message when &%bounce_return_message%& is true. The default setting
14881 causes the entire message, both header and body, to be returned (subject to the
14882 value of &%bounce_return_size_limit%&). If this option is false, only the
14883 message header is included. In the case of a non-SMTP message containing an
14884 error that is detected during reception, only those header lines preceding the
14885 point at which the error was detected are returned.
14886 .cindex "bounce message" "including original"
14887
14888 .option bounce_return_linesize_limit main integer 998
14889 .cindex "size" "of bounce lines, limit"
14890 .cindex "bounce message" "line length limit"
14891 .cindex "limit" "bounce message line length"
14892 This option sets a limit in bytes on the line length of messages
14893 that are returned to senders due to delivery problems,
14894 when &%bounce_return_message%& is true.
14895 The default value corresponds to RFC limits.
14896 If the message being returned has lines longer than this value it is
14897 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14898
14899 The option also applies to bounces returned when an error is detected
14900 during reception of a message.
14901 In this case lines from the original are truncated.
14902
14903 The option does not apply to messages generated by an &(autoreply)& transport.
14904
14905
14906 .option bounce_return_message main boolean true
14907 If this option is set false, none of the original message is included in
14908 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14909 &%bounce_return_body%&.
14910
14911
14912 .option bounce_return_size_limit main integer 100K
14913 .cindex "size" "of bounce, limit"
14914 .cindex "bounce message" "size limit"
14915 .cindex "limit" "bounce message size"
14916 This option sets a limit in bytes on the size of messages that are returned to
14917 senders as part of bounce messages when &%bounce_return_message%& is true. The
14918 limit should be less than the value of the global &%message_size_limit%& and of
14919 any &%message_size_limit%& settings on transports, to allow for the bounce text
14920 that Exim generates. If this option is set to zero there is no limit.
14921
14922 When the body of any message that is to be included in a bounce message is
14923 greater than the limit, it is truncated, and a comment pointing this out is
14924 added at the top. The actual cutoff may be greater than the value given, owing
14925 to the use of buffering for transferring the message in chunks (typically 8K in
14926 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14927 messages.
14928
14929 .option bounce_sender_authentication main string unset
14930 .cindex "bounce message" "sender authentication"
14931 .cindex "authentication" "bounce message"
14932 .cindex "AUTH" "on bounce message"
14933 This option provides an authenticated sender address that is sent with any
14934 bounce messages generated by Exim that are sent over an authenticated SMTP
14935 connection. A typical setting might be:
14936 .code
14937 bounce_sender_authentication = mailer-daemon@my.domain.example
14938 .endd
14939 which would cause bounce messages to be sent using the SMTP command:
14940 .code
14941 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14942 .endd
14943 The value of &%bounce_sender_authentication%& must always be a complete email
14944 address.
14945
14946 .option callout_domain_negative_expire main time 3h
14947 .cindex "caching" "callout timeouts"
14948 .cindex "callout" "caching timeouts"
14949 This option specifies the expiry time for negative callout cache data for a
14950 domain. See section &<<SECTcallver>>& for details of callout verification, and
14951 section &<<SECTcallvercache>>& for details of the caching.
14952
14953
14954 .option callout_domain_positive_expire main time 7d
14955 This option specifies the expiry time for positive callout cache data for a
14956 domain. See section &<<SECTcallver>>& for details of callout verification, and
14957 section &<<SECTcallvercache>>& for details of the caching.
14958
14959
14960 .option callout_negative_expire main time 2h
14961 This option specifies the expiry time for negative callout cache data for an
14962 address. See section &<<SECTcallver>>& for details of callout verification, and
14963 section &<<SECTcallvercache>>& for details of the caching.
14964
14965
14966 .option callout_positive_expire main time 24h
14967 This option specifies the expiry time for positive callout cache data for an
14968 address. See section &<<SECTcallver>>& for details of callout verification, and
14969 section &<<SECTcallvercache>>& for details of the caching.
14970
14971
14972 .option callout_random_local_part main string&!! "see below"
14973 This option defines the &"random"& local part that can be used as part of
14974 callout verification. The default value is
14975 .code
14976 $primary_hostname-$tod_epoch-testing
14977 .endd
14978 See section &<<CALLaddparcall>>& for details of how this value is used.
14979
14980
14981 .option check_log_inodes main integer 100
14982 See &%check_spool_space%& below.
14983
14984
14985 .option check_log_space main integer 10M
14986 See &%check_spool_space%& below.
14987
14988 .oindex "&%check_rfc2047_length%&"
14989 .cindex "RFC 2047" "disabling length check"
14990 .option check_rfc2047_length main boolean true
14991 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14992 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14993 word; strings to be encoded that exceed this length are supposed to use
14994 multiple encoded words. By default, Exim does not recognize encoded words that
14995 exceed the maximum length. However, it seems that some software, in violation
14996 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14997 set false, Exim recognizes encoded words of any length.
14998
14999
15000 .option check_spool_inodes main integer 100
15001 See &%check_spool_space%& below.
15002
15003
15004 .option check_spool_space main integer 10M
15005 .cindex "checking disk space"
15006 .cindex "disk space, checking"
15007 .cindex "spool directory" "checking space"
15008 The four &%check_...%& options allow for checking of disk resources before a
15009 message is accepted.
15010
15011 .vindex "&$log_inodes$&"
15012 .vindex "&$log_space$&"
15013 .vindex "&$spool_inodes$&"
15014 .vindex "&$spool_space$&"
15015 When any of these options are nonzero, they apply to all incoming messages. If you
15016 want to apply different checks to different kinds of message, you can do so by
15017 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15018 &$spool_space$& in an ACL with appropriate additional conditions.
15019
15020
15021 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15022 either value is greater than zero, for example:
15023 .code
15024 check_spool_space = 100M
15025 check_spool_inodes = 100
15026 .endd
15027 The spool partition is the one that contains the directory defined by
15028 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15029 transit.
15030
15031 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15032 files are written if either is greater than zero. These should be set only if
15033 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15034
15035 If there is less space or fewer inodes than requested, Exim refuses to accept
15036 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15037 error response to the MAIL command. If ESMTP is in use and there was a
15038 SIZE parameter on the MAIL command, its value is added to the
15039 &%check_spool_space%& value, and the check is performed even if
15040 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15041
15042 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15043 number of kilobytes (though specified in bytes).
15044 If a non-multiple of 1024 is specified, it is rounded up.
15045
15046 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15047 failure a message is written to stderr and Exim exits with a non-zero code, as
15048 it obviously cannot send an error message of any kind.
15049
15050 There is a slight performance penalty for these checks.
15051 Versions of Exim preceding 4.88 had these disabled by default;
15052 high-rate installations confident they will never run out of resources
15053 may wish to deliberately disable them.
15054
15055 .option chunking_advertise_hosts main "host list&!!" *
15056 .cindex CHUNKING advertisement
15057 .cindex "RFC 3030" "CHUNKING"
15058 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15059 these hosts.
15060 Hosts may use the BDAT command as an alternate to DATA.
15061
15062 .option commandline_checks_require_admin main boolean &`false`&
15063 .cindex "restricting access to features"
15064 This option restricts various basic checking features to require an
15065 administrative user.
15066 This affects most of the &%-b*%& options, such as &%-be%&.
15067
15068 .option debug_store main boolean &`false`&
15069 .cindex debugging "memory corruption"
15070 .cindex memory debugging
15071 This option, when true, enables extra checking in Exim's internal memory
15072 management.  For use when a memory corruption issue is being investigated,
15073 it should normally be left as default.
15074
15075 .option daemon_smtp_ports main string &`smtp`&
15076 .cindex "port" "for daemon"
15077 .cindex "TCP/IP" "setting listening ports"
15078 This option specifies one or more default SMTP ports on which the Exim daemon
15079 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15080 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15081
15082 .option daemon_startup_retries main integer 9
15083 .cindex "daemon startup, retrying"
15084 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15085 the daemon at startup when it cannot immediately bind a listening socket
15086 (typically because the socket is already in use): &%daemon_startup_retries%&
15087 defines the number of retries after the first failure, and
15088 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15089
15090 .option daemon_startup_sleep main time 30s
15091 See &%daemon_startup_retries%&.
15092
15093 .option delay_warning main "time list" 24h
15094 .cindex "warning of delay"
15095 .cindex "delay warning, specifying"
15096 .cindex "queue" "delay warning"
15097 When a message is delayed, Exim sends a warning message to the sender at
15098 intervals specified by this option. The data is a colon-separated list of times
15099 after which to send warning messages. If the value of the option is an empty
15100 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15101 message has been in the queue for longer than the last time, the last interval
15102 between the times is used to compute subsequent warning times. For example,
15103 with
15104 .code
15105 delay_warning = 4h:8h:24h
15106 .endd
15107 the first message is sent after 4 hours, the second after 8 hours, and
15108 the third one after 24 hours. After that, messages are sent every 16 hours,
15109 because that is the interval between the last two times on the list. If you set
15110 just one time, it specifies the repeat interval. For example, with:
15111 .code
15112 delay_warning = 6h
15113 .endd
15114 messages are repeated every six hours. To stop warnings after a given time, set
15115 a very large time at the end of the list. For example:
15116 .code
15117 delay_warning = 2h:12h:99d
15118 .endd
15119 Note that the option is only evaluated at the time a delivery attempt fails,
15120 which depends on retry and queue-runner configuration.
15121 Typically retries will be configured more frequently than warning messages.
15122
15123 .option delay_warning_condition main string&!! "see below"
15124 .vindex "&$domain$&"
15125 The string is expanded at the time a warning message might be sent. If all the
15126 deferred addresses have the same domain, it is set in &$domain$& during the
15127 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15128 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15129 &"false"& (the comparison being done caselessly) then the warning message is
15130 not sent. The default is:
15131 .code
15132 delay_warning_condition = ${if or {\
15133   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15134   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15135   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15136   } {no}{yes}}
15137 .endd
15138 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15139 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15140 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15141 &"auto-replied"& in an &'Auto-Submitted:'& header.
15142
15143 .option deliver_drop_privilege main boolean false
15144 .cindex "unprivileged delivery"
15145 .cindex "delivery" "unprivileged"
15146 If this option is set true, Exim drops its root privilege at the start of a
15147 delivery process, and runs as the Exim user throughout. This severely restricts
15148 the kinds of local delivery that are possible, but is viable in certain types
15149 of configuration. There is a discussion about the use of root privilege in
15150 chapter &<<CHAPsecurity>>&.
15151
15152 .option deliver_queue_load_max main fixed-point unset
15153 .cindex "load average"
15154 .cindex "queue runner" "abandoning"
15155 When this option is set, a queue run is abandoned if the system load average
15156 becomes greater than the value of the option. The option has no effect on
15157 ancient operating systems on which Exim cannot determine the load average.
15158 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15159
15160
15161 .option delivery_date_remove main boolean true
15162 .cindex "&'Delivery-date:'& header line"
15163 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15164 message when it is delivered, in exactly the same way as &'Return-path:'& is
15165 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15166 should not be present in incoming messages, and this option causes them to be
15167 removed at the time the message is received, to avoid any problems that might
15168 occur when a delivered message is subsequently sent on to some other recipient.
15169
15170 .option disable_fsync main boolean false
15171 .cindex "&[fsync()]&, disabling"
15172 This option is available only if Exim was built with the compile-time option
15173 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15174 a runtime configuration generates an &"unknown option"& error. You should not
15175 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15176 really, really, really understand what you are doing. &'No pre-compiled
15177 distributions of Exim should ever make this option available.'&
15178
15179 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15180 updated files' data to be written to disc before continuing. Unexpected events
15181 such as crashes and power outages may cause data to be lost or scrambled.
15182 Here be Dragons. &*Beware.*&
15183
15184
15185 .option disable_ipv6 main boolean false
15186 .cindex "IPv6" "disabling"
15187 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15188 activities take place. AAAA records are never looked up, and any IPv6 addresses
15189 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15190 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15191 to handle IPv6 literal addresses.
15192
15193
15194 .new
15195 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15196 .cindex DKIM "selecting signature algorithms"
15197 This option gives a list of hash types which are acceptable in signatures,
15198 .wen
15199 and an order of processing.
15200 Signatures with algorithms not in the list will be ignored.
15201
15202 Acceptable values include:
15203 .code
15204 sha1
15205 sha256
15206 sha512
15207 .endd
15208
15209 Note that the acceptance of sha1 violates RFC 8301.
15210
15211 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15212 This option gives a list of key types which are acceptable in signatures,
15213 and an order of processing.
15214 Signatures with algorithms not in the list will be ignored.
15215
15216 .option dkim_verify_minimal main boolean false
15217 If set to true, verification of signatures will terminate after the
15218 first success.
15219
15220 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15221 .cindex DKIM "controlling calls to the ACL"
15222 This option gives a list of DKIM domains for which the DKIM ACL is run.
15223 It is expanded after the message is received; by default it runs
15224 the ACL once for each signature in the message.
15225 See section &<<SECDKIMVFY>>&.
15226
15227
15228 .option dns_again_means_nonexist main "domain list&!!" unset
15229 .cindex "DNS" "&""try again""& response; overriding"
15230 DNS lookups give a &"try again"& response for the DNS errors
15231 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15232 keep trying to deliver a message, or to give repeated temporary errors to
15233 incoming mail. Sometimes the effect is caused by a badly set up name server and
15234 may persist for a long time. If a domain which exhibits this problem matches
15235 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15236 This option should be used with care. You can make it apply to reverse lookups
15237 by a setting such as this:
15238 .code
15239 dns_again_means_nonexist = *.in-addr.arpa
15240 .endd
15241 This option applies to all DNS lookups that Exim does. It also applies when the
15242 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15243 since these are most likely to be caused by DNS lookup problems. The
15244 &(dnslookup)& router has some options of its own for controlling what happens
15245 when lookups for MX or SRV records give temporary errors. These more specific
15246 options are applied after this global option.
15247
15248 .option dns_check_names_pattern main string "see below"
15249 .cindex "DNS" "pre-check of name syntax"
15250 When this option is set to a non-empty string, it causes Exim to check domain
15251 names for characters that are not allowed in host names before handing them to
15252 the DNS resolver, because some resolvers give temporary errors for names that
15253 contain unusual characters. If a domain name contains any unwanted characters,
15254 a &"not found"& result is forced, and the resolver is not called. The check is
15255 done by matching the domain name against a regular expression, which is the
15256 value of this option. The default pattern is
15257 .code
15258 dns_check_names_pattern = \
15259   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15260 .endd
15261 which permits only letters, digits, slashes, and hyphens in components, but
15262 they must start and end with a letter or digit. Slashes are not, in fact,
15263 permitted in host names, but they are found in certain NS records (which can be
15264 accessed in Exim by using a &%dnsdb%& lookup). If you set
15265 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15266 empty string.
15267
15268 .option dns_csa_search_limit main integer 5
15269 This option controls the depth of parental searching for CSA SRV records in the
15270 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15271
15272 .option dns_csa_use_reverse main boolean true
15273 This option controls whether or not an IP address, given as a CSA domain, is
15274 reversed and looked up in the reverse DNS, as described in more detail in
15275 section &<<SECTverifyCSA>>&.
15276
15277 .option dns_cname_loops main integer 1
15278 .cindex DNS "CNAME following"
15279 This option controls the following of CNAME chains, needed if the resolver does
15280 not do it internally.
15281 As of 2018 most should, and the default can be left.
15282 If you have an ancient one, a value of 10 is likely needed.
15283
15284 The default value of one CNAME-follow is needed
15285 thanks to the observed return for an MX request,
15286 given no MX presence but a CNAME to an A, of the CNAME.
15287
15288
15289 .option dns_dnssec_ok main integer -1
15290 .cindex "DNS" "resolver options"
15291 .cindex "DNS" "DNSSEC"
15292 If this option is set to a non-negative number then Exim will initialise the
15293 DNS resolver library to either use or not use DNSSEC, overriding the system
15294 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15295
15296 If the resolver library does not support DNSSEC then this option has no effect.
15297
15298
15299 .option dns_ipv4_lookup main "domain list&!!" unset
15300 .cindex "IPv6" "DNS lookup for AAAA records"
15301 .cindex "DNS" "IPv6 lookup for AAAA records"
15302 .cindex DNS "IPv6 disabling"
15303 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15304 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15305 (A records) when trying to find IP addresses for hosts, unless the host's
15306 domain matches this list.
15307
15308 This is a fudge to help with name servers that give big delays or otherwise do
15309 not work for the AAAA record type. In due course, when the world's name
15310 servers have all been upgraded, there should be no need for this option.
15311 Note that all lookups, including those done for verification, are affected;
15312 this will result in verify failure for IPv6 connections or ones using names
15313 only valid for IPv6 addresses.
15314
15315
15316 .option dns_retrans main time 0s
15317 .cindex "DNS" "resolver options"
15318 .cindex timeout "dns lookup"
15319 .cindex "DNS" timeout
15320 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15321 retransmission and retry parameters for DNS lookups. Values of zero (the
15322 defaults) leave the system default settings unchanged. The first value is the
15323 time between retries, and the second is the number of retries. It isn't
15324 totally clear exactly how these settings affect the total time a DNS lookup may
15325 take. I haven't found any documentation about timeouts on DNS lookups; these
15326 parameter values are available in the external resolver interface structure,
15327 but nowhere does it seem to describe how they are used or what you might want
15328 to set in them.
15329 See also the &%slow_lookup_log%& option.
15330
15331
15332 .option dns_retry main integer 0
15333 See &%dns_retrans%& above.
15334
15335
15336 .option dns_trust_aa main "domain list&!!" unset
15337 .cindex "DNS" "resolver options"
15338 .cindex "DNS" "DNSSEC"
15339 If this option is set then lookup results marked with the AA bit
15340 (Authoritative Answer) are trusted the same way as if they were
15341 DNSSEC-verified. The authority section's name of the answer must
15342 match with this expanded domain list.
15343
15344 Use this option only if you talk directly to a resolver that is
15345 authoritative for some zones and does not set the AD (Authentic Data)
15346 bit in the answer. Some DNS servers may have an configuration option to
15347 mark the answers from their own zones as verified (they set the AD bit).
15348 Others do not have this option. It is considered as poor practice using
15349 a resolver that is an authoritative server for some zones.
15350
15351 Use this option only if you really have to (e.g. if you want
15352 to use DANE for remote delivery to a server that is listed in the DNS
15353 zones that your resolver is authoritative for).
15354
15355 If the DNS answer packet has the AA bit set and contains resource record
15356 in the answer section, the name of the first NS record appearing in the
15357 authority section is compared against the list. If the answer packet is
15358 authoritative but the answer section is empty, the name of the first SOA
15359 record in the authoritative section is used instead.
15360
15361 .cindex "DNS" "resolver options"
15362 .option dns_use_edns0 main integer -1
15363 .cindex "DNS" "resolver options"
15364 .cindex "DNS" "EDNS0"
15365 .cindex "DNS" "OpenBSD
15366 If this option is set to a non-negative number then Exim will initialise the
15367 DNS resolver library to either use or not use EDNS0 extensions, overriding
15368 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15369 on.
15370
15371 If the resolver library does not support EDNS0 then this option has no effect.
15372
15373 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15374 means that DNSSEC will not work with Exim on that platform either, unless Exim
15375 is linked against an alternative DNS client library.
15376
15377
15378 .option drop_cr main boolean false
15379 This is an obsolete option that is now a no-op. It used to affect the way Exim
15380 handled CR and LF characters in incoming messages. What happens now is
15381 described in section &<<SECTlineendings>>&.
15382
15383 .option dsn_advertise_hosts main "host list&!!" unset
15384 .cindex "bounce messages" "success"
15385 .cindex "DSN" "success"
15386 .cindex "Delivery Status Notification" "success"
15387 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15388 and accepted from, these hosts.
15389 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15390 and RET and ORCPT options on MAIL FROM commands.
15391 A NOTIFY=SUCCESS option requests success-DSN messages.
15392 A NOTIFY= option with no argument requests that no delay or failure DSNs
15393 are sent.
15394
15395 .option dsn_from main "string&!!" "see below"
15396 .cindex "&'From:'& header line" "in bounces"
15397 .cindex "bounce messages" "&'From:'& line, specifying"
15398 This option can be used to vary the contents of &'From:'& header lines in
15399 bounces and other automatically generated messages (&"Delivery Status
15400 Notifications"& &-- hence the name of the option). The default setting is:
15401 .code
15402 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15403 .endd
15404 The value is expanded every time it is needed. If the expansion fails, a
15405 panic is logged, and the default value is used.
15406
15407 .option envelope_to_remove main boolean true
15408 .cindex "&'Envelope-to:'& header line"
15409 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15410 message when it is delivered, in exactly the same way as &'Return-path:'& is
15411 handled. &'Envelope-to:'& records the original recipient address from the
15412 message's envelope that caused the delivery to happen. Such headers should not
15413 be present in incoming messages, and this option causes them to be removed at
15414 the time the message is received, to avoid any problems that might occur when a
15415 delivered message is subsequently sent on to some other recipient.
15416
15417
15418 .option errors_copy main "string list&!!" unset
15419 .cindex "bounce message" "copy to other address"
15420 .cindex "copy of bounce message"
15421 Setting this option causes Exim to send bcc copies of bounce messages that it
15422 generates to other addresses. &*Note*&: This does not apply to bounce messages
15423 coming from elsewhere. The value of the option is a colon-separated list of
15424 items. Each item consists of a pattern, terminated by white space, followed by
15425 a comma-separated list of email addresses. If a pattern contains spaces, it
15426 must be enclosed in double quotes.
15427
15428 Each pattern is processed in the same way as a single item in an address list
15429 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15430 the bounce message, the message is copied to the addresses on the list. The
15431 items are scanned in order, and once a matching one is found, no further items
15432 are examined. For example:
15433 .code
15434 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15435               rqps@mydomain   hostmaster@mydomain.example,\
15436                               postmaster@mydomain.example
15437 .endd
15438 .vindex "&$domain$&"
15439 .vindex "&$local_part$&"
15440 The address list is expanded before use. The expansion variables &$local_part$&
15441 and &$domain$& are set from the original recipient of the error message, and if
15442 there was any wildcard matching in the pattern, the expansion
15443 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15444 variables &$0$&, &$1$&, etc. are set in the normal way.
15445
15446
15447 .option errors_reply_to main string unset
15448 .cindex "bounce message" "&'Reply-to:'& in"
15449 By default, Exim's bounce and delivery warning messages contain the header line
15450 .display
15451 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15452 .endd
15453 .oindex &%quota_warn_message%&
15454 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15455 A warning message that is generated by the &%quota_warn_message%& option in an
15456 &(appendfile)& transport may contain its own &'From:'& header line that
15457 overrides the default.
15458
15459 Experience shows that people reply to bounce messages. If the
15460 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15461 and warning messages. For example:
15462 .code
15463 errors_reply_to = postmaster@my.domain.example
15464 .endd
15465 The value of the option is not expanded. It must specify a valid RFC 2822
15466 address. However, if a warning message that is generated by the
15467 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15468 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15469 not used.
15470
15471
15472 .option event_action main string&!! unset
15473 .cindex events
15474 This option declares a string to be expanded for Exim's events mechanism.
15475 For details see chapter &<<CHAPevents>>&.
15476
15477
15478 .option exim_group main string "compile-time configured"
15479 .cindex "gid (group id)" "Exim's own"
15480 .cindex "Exim group"
15481 This option changes the gid under which Exim runs when it gives up root
15482 privilege. The default value is compiled into the binary. The value of this
15483 option is used only when &%exim_user%& is also set. Unless it consists entirely
15484 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15485 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15486 security issues.
15487
15488
15489 .option exim_path main string "see below"
15490 .cindex "Exim binary, path name"
15491 This option specifies the path name of the Exim binary, which is used when Exim
15492 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15493 the directory configured at compile time by the BIN_DIRECTORY setting. It
15494 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15495 other place.
15496 &*Warning*&: Do not use a macro to define the value of this option, because
15497 you will break those Exim utilities that scan the configuration file to find
15498 where the binary is. (They then use the &%-bP%& option to extract option
15499 settings such as the value of &%spool_directory%&.)
15500
15501
15502 .option exim_user main string "compile-time configured"
15503 .cindex "uid (user id)" "Exim's own"
15504 .cindex "Exim user"
15505 This option changes the uid under which Exim runs when it gives up root
15506 privilege. The default value is compiled into the binary. Ownership of the run
15507 time configuration file and the use of the &%-C%& and &%-D%& command line
15508 options is checked against the values in the binary, not what is set here.
15509
15510 Unless it consists entirely of digits, the string is looked up using
15511 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15512 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15513 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15514
15515
15516 .option exim_version main string "current version"
15517 .cindex "Exim version"
15518 .cindex customizing "version number"
15519 .cindex "version number of Exim" override
15520 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15521 various places.  Use with care; this may fool stupid security scanners.
15522
15523
15524 .option extra_local_interfaces main "string list" unset
15525 This option defines network interfaces that are to be considered local when
15526 routing, but which are not used for listening by the daemon. See section
15527 &<<SECTreclocipadd>>& for details.
15528
15529
15530 . Allow this long option name to split; give it unsplit as a fifth argument
15531 . for the automatic .oindex that is generated by .option.
15532
15533 .option "extract_addresses_remove_arguments" main boolean true &&&
15534          extract_addresses_remove_arguments
15535 .oindex "&%-t%&"
15536 .cindex "command line" "addresses with &%-t%&"
15537 .cindex "Sendmail compatibility" "&%-t%& option"
15538 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15539 are present on the command line when the &%-t%& option is used to build an
15540 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15541 line addresses are removed from the recipients list. This is also how Smail
15542 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15543 command line addresses are added to those obtained from the header lines. When
15544 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15545 argument headers. If it is set false, Exim adds rather than removes argument
15546 addresses.
15547
15548
15549 .option finduser_retries main integer 0
15550 .cindex "NIS, retrying user lookups"
15551 On systems running NIS or other schemes in which user and group information is
15552 distributed from a remote system, there can be times when &[getpwnam()]& and
15553 related functions fail, even when given valid data, because things time out.
15554 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15555 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15556 many extra times to find a user or a group, waiting for one second between
15557 retries.
15558
15559 .cindex "&_/etc/passwd_&" "multiple reading of"
15560 You should not set this option greater than zero if your user information is in
15561 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15562 search the file multiple times for non-existent users, and also cause delay.
15563
15564
15565
15566 .option freeze_tell main "string list, comma separated" unset
15567 .cindex "freezing messages" "sending a message when freezing"
15568 On encountering certain errors, or when configured to do so in a system filter,
15569 ACL, or special router, Exim freezes a message. This means that no further
15570 delivery attempts take place until an administrator thaws the message, or the
15571 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15572 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15573 warning message whenever it freezes something, unless the message it is
15574 freezing is a locally-generated bounce message. (Without this exception there
15575 is the possibility of looping.) The warning message is sent to the addresses
15576 supplied as the comma-separated value of this option. If several of the
15577 message's addresses cause freezing, only a single message is sent. If the
15578 freezing was automatic, the reason(s) for freezing can be found in the message
15579 log. If you configure freezing in a filter or ACL, you must arrange for any
15580 logging that you require.
15581
15582
15583 .option gecos_name main string&!! unset
15584 .cindex "HP-UX"
15585 .cindex "&""gecos""& field, parsing"
15586 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15587 password file to hold other information in addition to users' real names. Exim
15588 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15589 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15590 of the field are used unchanged, except that, if an ampersand is encountered,
15591 it is replaced by the user's login name with the first character forced to
15592 upper case, since this is a convention that is observed on many systems.
15593
15594 When these options are set, &%gecos_pattern%& is treated as a regular
15595 expression that is to be applied to the field (again with && replaced by the
15596 login name), and if it matches, &%gecos_name%& is expanded and used as the
15597 user's name.
15598
15599 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15600 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15601 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15602 name terminates at the first comma, the following can be used:
15603 .code
15604 gecos_pattern = ([^,]*)
15605 gecos_name = $1
15606 .endd
15607
15608 .option gecos_pattern main string unset
15609 See &%gecos_name%& above.
15610
15611
15612 .option gnutls_compat_mode main boolean unset
15613 This option controls whether GnuTLS is used in compatibility mode in an Exim
15614 server. This reduces security slightly, but improves interworking with older
15615 implementations of TLS.
15616
15617
15618 .option gnutls_allow_auto_pkcs11 main boolean unset
15619 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15620 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15621
15622 See
15623 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15624 for documentation.
15625
15626
15627
15628 .option headers_charset main string "see below"
15629 This option sets a default character set for translating from encoded MIME
15630 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15631 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15632 ultimate default is ISO-8859-1. For more details see the description of header
15633 insertions in section &<<SECTexpansionitems>>&.
15634
15635
15636
15637 .option header_maxsize main integer "see below"
15638 .cindex "header section" "maximum size of"
15639 .cindex "limit" "size of message header section"
15640 This option controls the overall maximum size of a message's header
15641 section. The default is the value of HEADER_MAXSIZE in
15642 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15643 sections are rejected.
15644
15645
15646 .option header_line_maxsize main integer 0
15647 .cindex "header lines" "maximum size of"
15648 .cindex "limit" "size of one header line"
15649 This option limits the length of any individual header line in a message, after
15650 all the continuations have been joined together. Messages with individual
15651 header lines that are longer than the limit are rejected. The default value of
15652 zero means &"no limit"&.
15653
15654
15655
15656
15657 .option helo_accept_junk_hosts main "host list&!!" unset
15658 .cindex "HELO" "accepting junk data"
15659 .cindex "EHLO" "accepting junk data"
15660 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15661 mail, and gives an error response for invalid data. Unfortunately, there are
15662 some SMTP clients that send syntactic junk. They can be accommodated by setting
15663 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15664 if you want to do semantic checking.
15665 See also &%helo_allow_chars%& for a way of extending the permitted character
15666 set.
15667
15668
15669 .option helo_allow_chars main string unset
15670 .cindex "HELO" "underscores in"
15671 .cindex "EHLO" "underscores in"
15672 .cindex "underscore in EHLO/HELO"
15673 This option can be set to a string of rogue characters that are permitted in
15674 all EHLO and HELO names in addition to the standard letters, digits,
15675 hyphens, and dots. If you really must allow underscores, you can set
15676 .code
15677 helo_allow_chars = _
15678 .endd
15679 Note that the value is one string, not a list.
15680
15681
15682 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15683 .cindex "HELO" "forcing reverse lookup"
15684 .cindex "EHLO" "forcing reverse lookup"
15685 If the domain given by a client in a HELO or EHLO command matches this
15686 list, a reverse lookup is done in order to establish the host's true name. The
15687 default forces a lookup if the client host gives the server's name or any of
15688 its IP addresses (in brackets), something that broken clients have been seen to
15689 do.
15690
15691
15692 .option helo_try_verify_hosts main "host list&!!" unset
15693 .cindex "HELO verifying" "optional"
15694 .cindex "EHLO" "verifying, optional"
15695 By default, Exim just checks the syntax of HELO and EHLO commands (see
15696 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15697 to do more extensive checking of the data supplied by these commands. The ACL
15698 condition &`verify = helo`& is provided to make this possible.
15699 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15700 to force the check to occur. From release 4.53 onwards, this is no longer
15701 necessary. If the check has not been done before &`verify = helo`& is
15702 encountered, it is done at that time. Consequently, this option is obsolete.
15703 Its specification is retained here for backwards compatibility.
15704
15705 When an EHLO or HELO command is received, if the calling host matches
15706 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15707 EHLO command either:
15708
15709 .ilist
15710 is an IP literal matching the calling address of the host, or
15711 .next
15712 .cindex "DNS" "reverse lookup"
15713 .cindex "reverse DNS lookup"
15714 matches the host name that Exim obtains by doing a reverse lookup of the
15715 calling host address, or
15716 .next
15717 when looked up in DNS yields the calling host address.
15718 .endlist
15719
15720 However, the EHLO or HELO command is not rejected if any of the checks
15721 fail. Processing continues, but the result of the check is remembered, and can
15722 be detected later in an ACL by the &`verify = helo`& condition.
15723
15724 If DNS was used for successful verification, the variable
15725 .cindex "DNS" "DNSSEC"
15726 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15727
15728 .option helo_verify_hosts main "host list&!!" unset
15729 .cindex "HELO verifying" "mandatory"
15730 .cindex "EHLO" "verifying, mandatory"
15731 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15732 backwards compatibility. For hosts that match this option, Exim checks the host
15733 name given in the HELO or EHLO in the same way as for
15734 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15735 rejected with a 550 error, and entries are written to the main and reject logs.
15736 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15737 error.
15738
15739 .option hold_domains main "domain list&!!" unset
15740 .cindex "domain" "delaying delivery"
15741 .cindex "delivery" "delaying certain domains"
15742 This option allows mail for particular domains to be held in the queue
15743 manually. The option is overridden if a message delivery is forced with the
15744 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15745 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15746 item in &%hold_domains%&, no routing or delivery for that address is done, and
15747 it is deferred every time the message is looked at.
15748
15749 This option is intended as a temporary operational measure for delaying the
15750 delivery of mail while some problem is being sorted out, or some new
15751 configuration tested. If you just want to delay the processing of some
15752 domains until a queue run occurs, you should use &%queue_domains%& or
15753 &%queue_smtp_domains%&, not &%hold_domains%&.
15754
15755 A setting of &%hold_domains%& does not override Exim's code for removing
15756 messages from the queue if they have been there longer than the longest retry
15757 time in any retry rule. If you want to hold messages for longer than the normal
15758 retry times, insert a dummy retry rule with a long retry time.
15759
15760
15761 .option host_lookup main "host list&!!" unset
15762 .cindex "host name" "lookup, forcing"
15763 Exim does not look up the name of a calling host from its IP address unless it
15764 is required to compare against some host list, or the host matches
15765 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15766 option (which normally contains IP addresses rather than host names). The
15767 default configuration file contains
15768 .code
15769 host_lookup = *
15770 .endd
15771 which causes a lookup to happen for all hosts. If the expense of these lookups
15772 is felt to be too great, the setting can be changed or removed.
15773
15774 After a successful reverse lookup, Exim does a forward lookup on the name it
15775 has obtained, to verify that it yields the IP address that it started with. If
15776 this check fails, Exim behaves as if the name lookup failed.
15777
15778 .vindex "&$host_lookup_failed$&"
15779 .vindex "&$sender_host_name$&"
15780 After any kind of failure, the host name (in &$sender_host_name$&) remains
15781 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15782 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15783 &`verify = reverse_host_lookup`& in ACLs.
15784
15785
15786 .option host_lookup_order main "string list" &`bydns:byaddr`&
15787 This option specifies the order of different lookup methods when Exim is trying
15788 to find a host name from an IP address. The default is to do a DNS lookup
15789 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15790 if that fails. You can change the order of these lookups, or omit one entirely,
15791 if you want.
15792
15793 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15794 multiple PTR records in the DNS and the IP address is not listed in
15795 &_/etc/hosts_&. Different operating systems give different results in this
15796 case. That is why the default tries a DNS lookup first.
15797
15798
15799
15800 .option host_reject_connection main "host list&!!" unset
15801 .cindex "host" "rejecting connections from"
15802 If this option is set, incoming SMTP calls from the hosts listed are rejected
15803 as soon as the connection is made.
15804 This option is obsolete, and retained only for backward compatibility, because
15805 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15806 connections immediately.
15807
15808 The ability to give an immediate rejection (either by this option or using an
15809 ACL) is provided for use in unusual cases. Many hosts will just try again,
15810 sometimes without much delay. Normally, it is better to use an ACL to reject
15811 incoming messages at a later stage, such as after RCPT commands. See
15812 chapter &<<CHAPACL>>&.
15813
15814
15815 .option hosts_connection_nolog main "host list&!!" unset
15816 .cindex "host" "not logging connections from"
15817 This option defines a list of hosts for which connection logging does not
15818 happen, even though the &%smtp_connection%& log selector is set. For example,
15819 you might want not to log SMTP connections from local processes, or from
15820 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15821 the daemon; you should therefore strive to restrict its value to a short inline
15822 list of IP addresses and networks. To disable logging SMTP connections from
15823 local processes, you must create a host list with an empty item. For example:
15824 .code
15825 hosts_connection_nolog = :
15826 .endd
15827 If the &%smtp_connection%& log selector is not set, this option has no effect.
15828
15829
15830
15831 .option hosts_proxy main "host list&!!" unset
15832 .cindex proxy "proxy protocol"
15833 This option enables use of Proxy Protocol proxies for incoming
15834 connections.  For details see section &<<SECTproxyInbound>>&.
15835
15836
15837 .option hosts_treat_as_local main "domain list&!!" unset
15838 .cindex "local host" "domains treated as"
15839 .cindex "host" "treated as local"
15840 If this option is set, any host names that match the domain list are treated as
15841 if they were the local host when Exim is scanning host lists obtained from MX
15842 records
15843 or other sources. Note that the value of this option is a domain list, not a
15844 host list, because it is always used to check host names, not IP addresses.
15845
15846 This option also applies when Exim is matching the special items
15847 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15848 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15849 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15850 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15851 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15852 interfaces and recognizing the local host.
15853
15854
15855 .option ibase_servers main "string list" unset
15856 .cindex "InterBase" "server list"
15857 This option provides a list of InterBase servers and associated connection data,
15858 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15859 The option is available only if Exim has been built with InterBase support.
15860
15861
15862
15863 .option ignore_bounce_errors_after main time 10w
15864 .cindex "bounce message" "discarding"
15865 .cindex "discarding bounce message"
15866 This option affects the processing of bounce messages that cannot be delivered,
15867 that is, those that suffer a permanent delivery failure. (Bounce messages that
15868 suffer temporary delivery failures are of course retried in the usual way.)
15869
15870 After a permanent delivery failure, bounce messages are frozen,
15871 because there is no sender to whom they can be returned. When a frozen bounce
15872 message has been in the queue for more than the given time, it is unfrozen at
15873 the next queue run, and a further delivery is attempted. If delivery fails
15874 again, the bounce message is discarded. This makes it possible to keep failed
15875 bounce messages around for a shorter time than the normal maximum retry time
15876 for frozen messages. For example,
15877 .code
15878 ignore_bounce_errors_after = 12h
15879 .endd
15880 retries failed bounce message deliveries after 12 hours, discarding any further
15881 failures. If the value of this option is set to a zero time period, bounce
15882 failures are discarded immediately. Setting a very long time (as in the default
15883 value) has the effect of disabling this option. For ways of automatically
15884 dealing with other kinds of frozen message, see &%auto_thaw%& and
15885 &%timeout_frozen_after%&.
15886
15887
15888 .option ignore_fromline_hosts main "host list&!!" unset
15889 .cindex "&""From""& line"
15890 .cindex "UUCP" "&""From""& line"
15891 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15892 the headers of a message. By default this is treated as the start of the
15893 message's body, which means that any following headers are not recognized as
15894 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15895 match those hosts that insist on sending it. If the sender is actually a local
15896 process rather than a remote host, and is using &%-bs%& to inject the messages,
15897 &%ignore_fromline_local%& must be set to achieve this effect.
15898
15899
15900 .option ignore_fromline_local main boolean false
15901 See &%ignore_fromline_hosts%& above.
15902
15903 .option keep_environment main "string list" unset
15904 .cindex "environment" "values from"
15905 This option contains a string list of environment variables to keep.
15906 You have to trust these variables or you have to be sure that
15907 these variables do not impose any security risk. Keep in mind that
15908 during the startup phase Exim is running with an effective UID 0 in most
15909 installations. As the default value is an empty list, the default
15910 environment for using libraries, running embedded Perl code, or running
15911 external binaries is empty, and does not not even contain PATH or HOME.
15912
15913 Actually the list is interpreted as a list of patterns
15914 (&<<SECTlistexpand>>&), except that it is not expanded first.
15915
15916 WARNING: Macro substitution is still done first, so having a macro
15917 FOO and having FOO_HOME in your &%keep_environment%& option may have
15918 unexpected results. You may work around this using a regular expression
15919 that does not match the macro name: ^[F]OO_HOME$.
15920
15921 Current versions of Exim issue a warning during startup if you do not mention
15922 &%keep_environment%& in your runtime configuration file and if your
15923 current environment is not empty. Future versions may not issue that warning
15924 anymore.
15925
15926 See the &%add_environment%& main config option for a way to set
15927 environment variables to a fixed value.  The environment for &(pipe)&
15928 transports is handled separately, see section &<<SECTpipeenv>>& for
15929 details.
15930
15931
15932 .option keep_malformed main time 4d
15933 This option specifies the length of time to keep messages whose spool files
15934 have been corrupted in some way. This should, of course, never happen. At the
15935 next attempt to deliver such a message, it gets removed. The incident is
15936 logged.
15937
15938
15939 .option ldap_ca_cert_dir main string unset
15940 .cindex "LDAP", "TLS CA certificate directory"
15941 .cindex certificate "directory for LDAP"
15942 This option indicates which directory contains CA certificates for verifying
15943 a TLS certificate presented by an LDAP server.
15944 While Exim does not provide a default value, your SSL library may.
15945 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15946 and constrained to be a directory.
15947
15948
15949 .option ldap_ca_cert_file main string unset
15950 .cindex "LDAP", "TLS CA certificate file"
15951 .cindex certificate "file for LDAP"
15952 This option indicates which file contains CA certificates for verifying
15953 a TLS certificate presented by an LDAP server.
15954 While Exim does not provide a default value, your SSL library may.
15955 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15956 and constrained to be a file.
15957
15958
15959 .option ldap_cert_file main string unset
15960 .cindex "LDAP" "TLS client certificate file"
15961 .cindex certificate "file for LDAP"
15962 This option indicates which file contains an TLS client certificate which
15963 Exim should present to the LDAP server during TLS negotiation.
15964 Should be used together with &%ldap_cert_key%&.
15965
15966
15967 .option ldap_cert_key main string unset
15968 .cindex "LDAP" "TLS client key file"
15969 .cindex certificate "key for LDAP"
15970 This option indicates which file contains the secret/private key to use
15971 to prove identity to the LDAP server during TLS negotiation.
15972 Should be used together with &%ldap_cert_file%&, which contains the
15973 identity to be proven.
15974
15975
15976 .option ldap_cipher_suite main string unset
15977 .cindex "LDAP" "TLS cipher suite"
15978 This controls the TLS cipher-suite negotiation during TLS negotiation with
15979 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15980 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15981
15982
15983 .option ldap_default_servers main "string list" unset
15984 .cindex "LDAP" "default servers"
15985 This option provides a list of LDAP servers which are tried in turn when an
15986 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15987 details of LDAP queries. This option is available only when Exim has been built
15988 with LDAP support.
15989
15990
15991 .option ldap_require_cert main string unset.
15992 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15993 This should be one of the values "hard", "demand", "allow", "try" or "never".
15994 A value other than one of these is interpreted as "never".
15995 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15996 Although Exim does not set a default, the LDAP library probably defaults
15997 to hard/demand.
15998
15999
16000 .option ldap_start_tls main boolean false
16001 .cindex "LDAP" "whether or not to negotiate TLS"
16002 If set, Exim will attempt to negotiate TLS with the LDAP server when
16003 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16004 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16005 of SSL-on-connect.
16006 In the event of failure to negotiate TLS, the action taken is controlled
16007 by &%ldap_require_cert%&.
16008 This option is ignored for &`ldapi`& connections.
16009
16010
16011 .option ldap_version main integer unset
16012 .cindex "LDAP" "protocol version, forcing"
16013 This option can be used to force Exim to set a specific protocol version for
16014 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16015 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16016 the LDAP headers; otherwise it is 2. This option is available only when Exim
16017 has been built with LDAP support.
16018
16019
16020
16021 .option local_from_check main boolean true
16022 .cindex "&'Sender:'& header line" "disabling addition of"
16023 .cindex "&'From:'& header line" "disabling checking of"
16024 When a message is submitted locally (that is, not over a TCP/IP connection) by
16025 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16026 checks that the &'From:'& header line matches the login of the calling user and
16027 the domain specified by &%qualify_domain%&.
16028
16029 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16030 locally submitted message is automatically qualified by Exim, unless the
16031 &%-bnq%& command line option is used.
16032
16033 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16034 on the local part. If the &'From:'& header line does not match, Exim adds a
16035 &'Sender:'& header with an address constructed from the calling user's login
16036 and the default qualify domain.
16037
16038 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16039 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16040 &'Sender:'& header lines supplied by untrusted users, you must also set
16041 &%local_sender_retain%& to be true.
16042
16043 .cindex "envelope from"
16044 .cindex "envelope sender"
16045 These options affect only the header lines in the message. The envelope sender
16046 is still forced to be the login id at the qualify domain unless
16047 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16048
16049 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16050 request similar header line checking. See section &<<SECTthesenhea>>&, which
16051 has more details about &'Sender:'& processing.
16052
16053
16054
16055
16056 .option local_from_prefix main string unset
16057 When Exim checks the &'From:'& header line of locally submitted messages for
16058 matching the login id (see &%local_from_check%& above), it can be configured to
16059 ignore certain prefixes and suffixes in the local part of the address. This is
16060 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16061 appropriate lists, in the same form as the &%local_part_prefix%& and
16062 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16063 example, if
16064 .code
16065 local_from_prefix = *-
16066 .endd
16067 is set, a &'From:'& line containing
16068 .code
16069 From: anything-user@your.domain.example
16070 .endd
16071 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16072 matches the actual sender address that is constructed from the login name and
16073 qualify domain.
16074
16075
16076 .option local_from_suffix main string unset
16077 See &%local_from_prefix%& above.
16078
16079
16080 .option local_interfaces main "string list" "see below"
16081 This option controls which network interfaces are used by the daemon for
16082 listening; they are also used to identify the local host when routing. Chapter
16083 &<<CHAPinterfaces>>& contains a full description of this option and the related
16084 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16085 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16086 &%local_interfaces%& is
16087 .code
16088 local_interfaces = 0.0.0.0
16089 .endd
16090 when Exim is built without IPv6 support; otherwise it is
16091 .code
16092 local_interfaces = <; ::0 ; 0.0.0.0
16093 .endd
16094
16095 .option local_scan_timeout main time 5m
16096 .cindex "timeout" "for &[local_scan()]& function"
16097 .cindex "&[local_scan()]& function" "timeout"
16098 This timeout applies to the &[local_scan()]& function (see chapter
16099 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16100 the incoming message is rejected with a temporary error if it is an SMTP
16101 message. For a non-SMTP message, the message is dropped and Exim ends with a
16102 non-zero code. The incident is logged on the main and reject logs.
16103
16104
16105
16106 .option local_sender_retain main boolean false
16107 .cindex "&'Sender:'& header line" "retaining from local submission"
16108 When a message is submitted locally (that is, not over a TCP/IP connection) by
16109 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16110 do not want this to happen, you must set &%local_sender_retain%&, and you must
16111 also set &%local_from_check%& to be false (Exim will complain if you do not).
16112 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16113 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16114
16115
16116
16117
16118 .option localhost_number main string&!! unset
16119 .cindex "host" "locally unique number for"
16120 .cindex "message ids" "with multiple hosts"
16121 .vindex "&$localhost_number$&"
16122 Exim's message ids are normally unique only within the local host. If
16123 uniqueness among a set of hosts is required, each host must set a different
16124 value for the &%localhost_number%& option. The string is expanded immediately
16125 after reading the configuration file (so that a number can be computed from the
16126 host name, for example) and the result of the expansion must be a number in the
16127 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16128 systems). This is available in subsequent string expansions via the variable
16129 &$localhost_number$&. When &%localhost_number is set%&, the final two
16130 characters of the message id, instead of just being a fractional part of the
16131 time, are computed from the time and the local host number as described in
16132 section &<<SECTmessiden>>&.
16133
16134
16135
16136 .option log_file_path main "string list&!!" "set at compile time"
16137 .cindex "log" "file path for"
16138 This option sets the path which is used to determine the names of Exim's log
16139 files, or indicates that logging is to be to syslog, or both. It is expanded
16140 when Exim is entered, so it can, for example, contain a reference to the host
16141 name. If no specific path is set for the log files at compile or runtime,
16142 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16143 they are written in a sub-directory called &_log_& in Exim's spool directory.
16144 A path must start with a slash.
16145 To send to syslog, use the word &"syslog"&.
16146 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16147 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16148 used. If this string is fixed at your installation (contains no expansion
16149 variables) it is recommended that you do not set this option in the
16150 configuration file, but instead supply the path using LOG_FILE_PATH in
16151 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16152 early on &-- in particular, failure to read the configuration file.
16153
16154
16155 .option log_selector main string unset
16156 .cindex "log" "selectors"
16157 This option can be used to reduce or increase the number of things that Exim
16158 writes to its log files. Its argument is made up of names preceded by plus or
16159 minus characters. For example:
16160 .code
16161 log_selector = +arguments -retry_defer
16162 .endd
16163 A list of possible names and what they control is given in the chapter on
16164 logging, in section &<<SECTlogselector>>&.
16165
16166
16167 .option log_timezone main boolean false
16168 .cindex "log" "timezone for entries"
16169 .vindex "&$tod_log$&"
16170 .vindex "&$tod_zone$&"
16171 By default, the timestamps on log lines are in local time without the
16172 timezone. This means that if your timezone changes twice a year, the timestamps
16173 in log lines are ambiguous for an hour when the clocks go back. One way of
16174 avoiding this problem is to set the timezone to UTC. An alternative is to set
16175 &%log_timezone%& true. This turns on the addition of the timezone offset to
16176 timestamps in log lines. Turning on this option can add quite a lot to the size
16177 of log files because each line is extended by 6 characters. Note that the
16178 &$tod_log$& variable contains the log timestamp without the zone, but there is
16179 another variable called &$tod_zone$& that contains just the timezone offset.
16180
16181
16182 .option lookup_open_max main integer 25
16183 .cindex "too many open files"
16184 .cindex "open files, too many"
16185 .cindex "file" "too many open"
16186 .cindex "lookup" "maximum open files"
16187 .cindex "limit" "open files for lookups"
16188 This option limits the number of simultaneously open files for single-key
16189 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16190 Exim normally keeps these files open during routing, because often the same
16191 file is required several times. If the limit is reached, Exim closes the least
16192 recently used file. Note that if you are using the &'ndbm'& library, it
16193 actually opens two files for each logical DBM database, though it still counts
16194 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16195 open files"& errors with NDBM, you need to reduce the value of
16196 &%lookup_open_max%&.
16197
16198
16199 .option max_username_length main integer 0
16200 .cindex "length of login name"
16201 .cindex "user name" "maximum length"
16202 .cindex "limit" "user name length"
16203 Some operating systems are broken in that they truncate long arguments to
16204 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16205 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16206 an argument that is longer behaves as if &[getpwnam()]& failed.
16207
16208
16209 .option message_body_newlines main bool false
16210 .cindex "message body" "newlines in variables"
16211 .cindex "newline" "in message body variables"
16212 .vindex "&$message_body$&"
16213 .vindex "&$message_body_end$&"
16214 By default, newlines in the message body are replaced by spaces when setting
16215 the &$message_body$& and &$message_body_end$& expansion variables. If this
16216 option is set true, this no longer happens.
16217
16218
16219 .option message_body_visible main integer 500
16220 .cindex "body of message" "visible size"
16221 .cindex "message body" "visible size"
16222 .vindex "&$message_body$&"
16223 .vindex "&$message_body_end$&"
16224 This option specifies how much of a message's body is to be included in the
16225 &$message_body$& and &$message_body_end$& expansion variables.
16226
16227
16228 .option message_id_header_domain main string&!! unset
16229 .cindex "&'Message-ID:'& header line"
16230 If this option is set, the string is expanded and used as the right hand side
16231 (domain) of the &'Message-ID:'& header that Exim creates if a
16232 locally-originated incoming message does not have one. &"Locally-originated"&
16233 means &"not received over TCP/IP."&
16234 Otherwise, the primary host name is used.
16235 Only letters, digits, dot and hyphen are accepted; any other characters are
16236 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16237 empty string, the option is ignored.
16238
16239
16240 .option message_id_header_text main string&!! unset
16241 If this variable is set, the string is expanded and used to augment the text of
16242 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16243 message does not have one. The text of this header is required by RFC 2822 to
16244 take the form of an address. By default, Exim uses its internal message id as
16245 the local part, and the primary host name as the domain. If this option is set,
16246 it is expanded, and provided the expansion is not forced to fail, and does not
16247 yield an empty string, the result is inserted into the header immediately
16248 before the @, separated from the internal message id by a dot. Any characters
16249 that are illegal in an address are automatically converted into hyphens. This
16250 means that variables such as &$tod_log$& can be used, because the spaces and
16251 colons will become hyphens.
16252
16253
16254 .option message_logs main boolean true
16255 .cindex "message logs" "disabling"
16256 .cindex "log" "message log; disabling"
16257 If this option is turned off, per-message log files are not created in the
16258 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16259 Exim, by reducing the number of files involved in handling a message from a
16260 minimum of four (header spool file, body spool file, delivery journal, and
16261 per-message log) to three. The other major I/O activity is Exim's main log,
16262 which is not affected by this option.
16263
16264
16265 .option message_size_limit main string&!! 50M
16266 .cindex "message" "size limit"
16267 .cindex "limit" "message size"
16268 .cindex "size" "of message, limit"
16269 This option limits the maximum size of message that Exim will process. The
16270 value is expanded for each incoming connection so, for example, it can be made
16271 to depend on the IP address of the remote host for messages arriving via
16272 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16273 optionally followed by K or M.
16274
16275 &*Note*&: This limit cannot be made to depend on a message's sender or any
16276 other properties of an individual message, because it has to be advertised in
16277 the server's response to EHLO. String expansion failure causes a temporary
16278 error. A value of zero means no limit, but its use is not recommended. See also
16279 &%bounce_return_size_limit%&.
16280
16281 Incoming SMTP messages are failed with a 552 error if the limit is
16282 exceeded; locally-generated messages either get a stderr message or a delivery
16283 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16284 an oversized message is logged in both the main and the reject logs. See also
16285 the generic transport option &%message_size_limit%&, which limits the size of
16286 message that an individual transport can process.
16287
16288 If you use a virus-scanner and set this option to to a value larger than the
16289 maximum size that your virus-scanner is configured to support, you may get
16290 failures triggered by large mails.  The right size to configure for the
16291 virus-scanner depends upon what data is passed and the options in use but it's
16292 probably safest to just set it to a little larger than this value.  E.g., with a
16293 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16294 some problems may result.
16295
16296 A value of 0 will disable size limit checking; Exim will still advertise the
16297 SIZE extension in an EHLO response, but without a limit, so as to permit
16298 SMTP clients to still indicate the message size along with the MAIL verb.
16299
16300
16301 .option move_frozen_messages main boolean false
16302 .cindex "frozen messages" "moving"
16303 This option, which is available only if Exim has been built with the setting
16304 .code
16305 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16306 .endd
16307 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16308 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16309 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16310 standard utilities for handling such moved messages, and they do not show up in
16311 lists generated by &%-bp%& or by the Exim monitor.
16312
16313
16314 .option mua_wrapper main boolean false
16315 Setting this option true causes Exim to run in a very restrictive mode in which
16316 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16317 contains a full description of this facility.
16318
16319
16320
16321 .option mysql_servers main "string list" unset
16322 .cindex "MySQL" "server list"
16323 This option provides a list of MySQL servers and associated connection data, to
16324 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16325 option is available only if Exim has been built with MySQL support.
16326
16327
16328 .option never_users main "string list&!!" unset
16329 This option is expanded just once, at the start of Exim's processing. Local
16330 message deliveries are normally run in processes that are setuid to the
16331 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16332 It is usually desirable to prevent any deliveries from running as root, as a
16333 safety precaution.
16334
16335 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16336 list of users that must not be used for local deliveries. This list is fixed in
16337 the binary and cannot be overridden by the configuration file. By default, it
16338 contains just the single user name &"root"&. The &%never_users%& runtime option
16339 can be used to add more users to the fixed list.
16340
16341 If a message is to be delivered as one of the users on the fixed list or the
16342 &%never_users%& list, an error occurs, and delivery is deferred. A common
16343 example is
16344 .code
16345 never_users = root:daemon:bin
16346 .endd
16347 Including root is redundant if it is also on the fixed list, but it does no
16348 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16349 transport driver.
16350
16351
16352 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16353 .cindex "OpenSSL "compatibility options"
16354 This option allows an administrator to adjust the SSL options applied
16355 by OpenSSL to connections.  It is given as a space-separated list of items,
16356 each one to be +added or -subtracted from the current value.
16357
16358 This option is only available if Exim is built against OpenSSL.  The values
16359 available for this option vary according to the age of your OpenSSL install.
16360 The &"all"& value controls a subset of flags which are available, typically
16361 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16362 list the values known on your system and Exim should support all the
16363 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16364 names lose the leading &"SSL_OP_"& and are lower-cased.
16365
16366 Note that adjusting the options can have severe impact upon the security of
16367 SSL as used by Exim.  It is possible to disable safety checks and shoot
16368 yourself in the foot in various unpleasant ways.  This option should not be
16369 adjusted lightly.  An unrecognised item will be detected at startup, by
16370 invoking Exim with the &%-bV%& flag.
16371
16372 The option affects Exim operating both as a server and as a client.
16373
16374 Historical note: prior to release 4.80, Exim defaulted this value to
16375 "+dont_insert_empty_fragments", which may still be needed for compatibility
16376 with some clients, but which lowers security by increasing exposure to
16377 some now infamous attacks.
16378
16379 Examples:
16380 .code
16381 # Make both old MS and old Eudora happy:
16382 openssl_options = -all +microsoft_big_sslv3_buffer \
16383                        +dont_insert_empty_fragments
16384
16385 # Disable older protocol versions:
16386 openssl_options = +no_sslv2 +no_sslv3
16387 .endd
16388
16389 Possible options may include:
16390 .ilist
16391 &`all`&
16392 .next
16393 &`allow_unsafe_legacy_renegotiation`&
16394 .next
16395 &`cipher_server_preference`&
16396 .next
16397 &`dont_insert_empty_fragments`&
16398 .next
16399 &`ephemeral_rsa`&
16400 .next
16401 &`legacy_server_connect`&
16402 .next
16403 &`microsoft_big_sslv3_buffer`&
16404 .next
16405 &`microsoft_sess_id_bug`&
16406 .next
16407 &`msie_sslv2_rsa_padding`&
16408 .next
16409 &`netscape_challenge_bug`&
16410 .next
16411 &`netscape_reuse_cipher_change_bug`&
16412 .next
16413 &`no_compression`&
16414 .next
16415 &`no_session_resumption_on_renegotiation`&
16416 .next
16417 &`no_sslv2`&
16418 .next
16419 &`no_sslv3`&
16420 .next
16421 &`no_ticket`&
16422 .next
16423 &`no_tlsv1`&
16424 .next
16425 &`no_tlsv1_1`&
16426 .next
16427 &`no_tlsv1_2`&
16428 .next
16429 &`safari_ecdhe_ecdsa_bug`&
16430 .next
16431 &`single_dh_use`&
16432 .next
16433 &`single_ecdh_use`&
16434 .next
16435 &`ssleay_080_client_dh_bug`&
16436 .next
16437 &`sslref2_reuse_cert_type_bug`&
16438 .next
16439 &`tls_block_padding_bug`&
16440 .next
16441 &`tls_d5_bug`&
16442 .next
16443 &`tls_rollback_bug`&
16444 .endlist
16445
16446 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16447 all clients connecting using the MacOS SecureTransport TLS facility prior
16448 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16449 to negotiate TLS then this option value might help, provided that your OpenSSL
16450 release is new enough to contain this work-around.  This may be a situation
16451 where you have to upgrade OpenSSL to get buggy clients working.
16452
16453
16454 .option oracle_servers main "string list" unset
16455 .cindex "Oracle" "server list"
16456 This option provides a list of Oracle servers and associated connection data,
16457 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16458 The option is available only if Exim has been built with Oracle support.
16459
16460
16461 .option percent_hack_domains main "domain list&!!" unset
16462 .cindex "&""percent hack""&"
16463 .cindex "source routing" "in email address"
16464 .cindex "address" "source-routed"
16465 The &"percent hack"& is the convention whereby a local part containing a
16466 percent sign is re-interpreted as a new email address, with the percent
16467 replaced by @. This is sometimes called &"source routing"&, though that term is
16468 also applied to RFC 2822 addresses that begin with an @ character. If this
16469 option is set, Exim implements the percent facility for those domains listed,
16470 but no others. This happens before an incoming SMTP address is tested against
16471 an ACL.
16472
16473 &*Warning*&: The &"percent hack"& has often been abused by people who are
16474 trying to get round relaying restrictions. For this reason, it is best avoided
16475 if at all possible. Unfortunately, a number of less security-conscious MTAs
16476 implement it unconditionally. If you are running Exim on a gateway host, and
16477 routing mail through to internal MTAs without processing the local parts, it is
16478 a good idea to reject recipient addresses with percent characters in their
16479 local parts. Exim's default configuration does this.
16480
16481
16482 .option perl_at_start main boolean false
16483 .cindex "Perl"
16484 This option is available only when Exim is built with an embedded Perl
16485 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16486
16487
16488 .option perl_startup main string unset
16489 .cindex "Perl"
16490 This option is available only when Exim is built with an embedded Perl
16491 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16492
16493 .option perl_taintmode main boolean false
16494 .cindex "Perl"
16495 This option enables the taint mode of the embedded Perl interpreter.
16496
16497
16498 .option pgsql_servers main "string list" unset
16499 .cindex "PostgreSQL lookup type" "server list"
16500 This option provides a list of PostgreSQL servers and associated connection
16501 data, to be used in conjunction with &(pgsql)& lookups (see section
16502 &<<SECID72>>&). The option is available only if Exim has been built with
16503 PostgreSQL support.
16504
16505
16506 .option pid_file_path main string&!! "set at compile time"
16507 .cindex "daemon" "pid file path"
16508 .cindex "pid file, path for"
16509 This option sets the name of the file to which the Exim daemon writes its
16510 process id. The string is expanded, so it can contain, for example, references
16511 to the host name:
16512 .code
16513 pid_file_path = /var/log/$primary_hostname/exim.pid
16514 .endd
16515 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16516 spool directory.
16517 The value set by the option can be overridden by the &%-oP%& command line
16518 option. A pid file is not written if a &"non-standard"& daemon is run by means
16519 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16520
16521
16522 .option pipelining_advertise_hosts main "host list&!!" *
16523 .cindex "PIPELINING" "suppressing advertising"
16524 This option can be used to suppress the advertisement of the SMTP
16525 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16526 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16527 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16528 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16529 that clients will use it; &"out of order"& commands that are &"expected"& do
16530 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16531
16532 .option pipelining_connect_advertise_hosts main "host list&!!" *
16533 .cindex "pipelining" "early connection"
16534 .cindex "pipelining" PIPE_CONNECT
16535 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16536 this option controls which hosts the facility is advertised to
16537 and from which pipeline early-connection (before MAIL) SMTP
16538 commands are acceptable.
16539 When used, the pipelining saves on roundtrip times.
16540
16541 See also the &%hosts_pipe_connect%& smtp transport option.
16542
16543 Currently the option name &"X_PIPE_CONNECT"& is used.
16544
16545
16546 .option prdr_enable main boolean false
16547 .cindex "PRDR" "enabling on server"
16548 This option can be used to enable the Per-Recipient Data Response extension
16549 to SMTP, defined by Eric Hall.
16550 If the option is set, PRDR is advertised by Exim when operating as a server.
16551 If the client requests PRDR, and more than one recipient, for a message
16552 an additional ACL is called for each recipient after the message content
16553 is received.  See section &<<SECTPRDRACL>>&.
16554
16555 .option preserve_message_logs main boolean false
16556 .cindex "message logs" "preserving"
16557 If this option is set, message log files are not deleted when messages are
16558 completed. Instead, they are moved to a sub-directory of the spool directory
16559 called &_msglog.OLD_&, where they remain available for statistical or debugging
16560 purposes. This is a dangerous option to set on systems with any appreciable
16561 volume of mail. Use with care!
16562
16563
16564 .option primary_hostname main string "see below"
16565 .cindex "name" "of local host"
16566 .cindex "host" "name of local"
16567 .cindex "local host" "name of"
16568 .vindex "&$primary_hostname$&"
16569 This specifies the name of the current host. It is used in the default EHLO or
16570 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16571 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16572 The value is also used by default in some SMTP response messages from an Exim
16573 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16574
16575 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16576 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16577 contains only one component, Exim passes it to &[gethostbyname()]& (or
16578 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16579 version. The variable &$primary_hostname$& contains the host name, whether set
16580 explicitly by this option, or defaulted.
16581
16582
16583 .option print_topbitchars main boolean false
16584 .cindex "printing characters"
16585 .cindex "8-bit characters"
16586 By default, Exim considers only those characters whose codes lie in the range
16587 32&--126 to be printing characters. In a number of circumstances (for example,
16588 when writing log entries) non-printing characters are converted into escape
16589 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16590 is set, code values of 128 and above are also considered to be printing
16591 characters.
16592
16593 This option also affects the header syntax checks performed by the
16594 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16595 the user's full name when constructing From: and Sender: addresses (as
16596 described in section &<<SECTconstr>>&). Setting this option can cause
16597 Exim to generate eight bit message headers that do not conform to the
16598 standards.
16599
16600
16601 .option process_log_path main string unset
16602 .cindex "process log path"
16603 .cindex "log" "process log"
16604 .cindex "&'exiwhat'&"
16605 This option sets the name of the file to which an Exim process writes its
16606 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16607 utility script. If this option is unset, the file called &_exim-process.info_&
16608 in Exim's spool directory is used. The ability to specify the name explicitly
16609 can be useful in environments where two different Exims are running, using
16610 different spool directories.
16611
16612
16613 .option prod_requires_admin main boolean true
16614 .cindex "restricting access to features"
16615 .oindex "&%-M%&"
16616 .oindex "&%-R%&"
16617 .oindex "&%-q%&"
16618 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16619 admin user unless &%prod_requires_admin%& is set false. See also
16620 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16621
16622
16623 .option qualify_domain main string "see below"
16624 .cindex "domain" "for qualifying addresses"
16625 .cindex "address" "qualification"
16626 This option specifies the domain name that is added to any envelope sender
16627 addresses that do not have a domain qualification. It also applies to
16628 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16629 are accepted by default only for locally-generated messages. Qualification is
16630 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16631 locally-generated messages, unless the &%-bnq%& command line option is used.
16632
16633 Messages from external sources must always contain fully qualified addresses,
16634 unless the sending host matches &%sender_unqualified_hosts%& or
16635 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16636 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16637 necessary. Internally, Exim always works with fully qualified envelope
16638 addresses. If &%qualify_domain%& is not set, it defaults to the
16639 &%primary_hostname%& value.
16640
16641
16642 .option qualify_recipient main string "see below"
16643 This option allows you to specify a different domain for qualifying recipient
16644 addresses to the one that is used for senders. See &%qualify_domain%& above.
16645
16646
16647
16648 .option queue_domains main "domain list&!!" unset
16649 .cindex "domain" "specifying non-immediate delivery"
16650 .cindex "queueing incoming messages"
16651 .cindex "message" "queueing certain domains"
16652 This option lists domains for which immediate delivery is not required.
16653 A delivery process is started whenever a message is received, but only those
16654 domains that do not match are processed. All other deliveries wait until the
16655 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16656
16657
16658 .option queue_list_requires_admin main boolean true
16659 .cindex "restricting access to features"
16660 .oindex "&%-bp%&"
16661 The &%-bp%& command-line option, which lists the messages that are on the
16662 queue, requires the caller to be an admin user unless
16663 &%queue_list_requires_admin%& is set false.
16664 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16665
16666
16667 .option queue_only main boolean false
16668 .cindex "queueing incoming messages"
16669 .cindex "message" "queueing unconditionally"
16670 If &%queue_only%& is set, a delivery process is not automatically started
16671 whenever a message is received. Instead, the message waits in the queue for the
16672 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16673 delivered immediately when certain conditions (such as heavy load) occur.
16674
16675 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16676 and &%-odi%& command line options override &%queue_only%& unless
16677 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16678 &%queue_only_load%&, and &%smtp_accept_queue%&.
16679
16680
16681 .option queue_only_file main string unset
16682 .cindex "queueing incoming messages"
16683 .cindex "message" "queueing by file existence"
16684 This option can be set to a colon-separated list of absolute path names, each
16685 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16686 it tests for the existence of each listed path using a call to &[stat()]&. For
16687 each path that exists, the corresponding queueing option is set.
16688 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16689 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16690 .code
16691 queue_only_file = smtp/some/file
16692 .endd
16693 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16694 &_/some/file_& exists.
16695
16696
16697 .option queue_only_load main fixed-point unset
16698 .cindex "load average"
16699 .cindex "queueing incoming messages"
16700 .cindex "message" "queueing by load"
16701 If the system load average is higher than this value, incoming messages from
16702 all sources are queued, and no automatic deliveries are started. If this
16703 happens during local or remote SMTP input, all subsequent messages received on
16704 the same SMTP connection are queued by default, whatever happens to the load in
16705 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16706 false.
16707
16708 Deliveries will subsequently be performed by queue runner processes. This
16709 option has no effect on ancient operating systems on which Exim cannot
16710 determine the load average. See also &%deliver_queue_load_max%& and
16711 &%smtp_load_reserve%&.
16712
16713
16714 .option queue_only_load_latch main boolean true
16715 .cindex "load average" "re-evaluating per message"
16716 When this option is true (the default), once one message has been queued
16717 because the load average is higher than the value set by &%queue_only_load%&,
16718 all subsequent messages received on the same SMTP connection are also queued.
16719 This is a deliberate choice; even though the load average may fall below the
16720 threshold, it doesn't seem right to deliver later messages on the same
16721 connection when not delivering earlier ones. However, there are special
16722 circumstances such as very long-lived connections from scanning appliances
16723 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16724 should be set false. This causes the value of the load average to be
16725 re-evaluated for each message.
16726
16727
16728 .option queue_only_override main boolean true
16729 .cindex "queueing incoming messages"
16730 When this option is true, the &%-od%&&'x'& command line options override the
16731 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16732 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16733 to override; they are accepted, but ignored.
16734
16735
16736 .option queue_run_in_order main boolean false
16737 .cindex "queue runner" "processing messages in order"
16738 If this option is set, queue runs happen in order of message arrival instead of
16739 in an arbitrary order. For this to happen, a complete list of the entire queue
16740 must be set up before the deliveries start. When the queue is all held in a
16741 single directory (the default), a single list is created for both the ordered
16742 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16743 single list is not created when &%queue_run_in_order%& is false. In this case,
16744 the sub-directories are processed one at a time (in a random order), and this
16745 avoids setting up one huge list for the whole queue. Thus, setting
16746 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16747 when the queue is large, because of the extra work in setting up the single,
16748 large list. In most situations, &%queue_run_in_order%& should not be set.
16749
16750
16751
16752 .option queue_run_max main integer&!! 5
16753 .cindex "queue runner" "maximum number of"
16754 This controls the maximum number of queue runner processes that an Exim daemon
16755 can run simultaneously. This does not mean that it starts them all at once,
16756 but rather that if the maximum number are still running when the time comes to
16757 start another one, it refrains from starting another one. This can happen with
16758 very large queues and/or very sluggish deliveries. This option does not,
16759 however, interlock with other processes, so additional queue runners can be
16760 started by other means, or by killing and restarting the daemon.
16761
16762 Setting this option to zero does not suppress queue runs; rather, it disables
16763 the limit, allowing any number of simultaneous queue runner processes to be
16764 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16765 the daemon's command line.
16766
16767 .cindex queues named
16768 .cindex "named queues" "resource limit"
16769 To set limits for different named queues use
16770 an expansion depending on the &$queue_name$& variable.
16771
16772 .option queue_smtp_domains main "domain list&!!" unset
16773 .cindex "queueing incoming messages"
16774 .cindex "message" "queueing remote deliveries"
16775 .cindex "first pass routing"
16776 When this option is set, a delivery process is started whenever a message is
16777 received, routing is performed, and local deliveries take place.
16778 However, if any SMTP deliveries are required for domains that match
16779 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16780 message waits in the queue for the next queue run. Since routing of the message
16781 has taken place, Exim knows to which remote hosts it must be delivered, and so
16782 when the queue run happens, multiple messages for the same host are delivered
16783 over a single SMTP connection. The &%-odqs%& command line option causes all
16784 SMTP deliveries to be queued in this way, and is equivalent to setting
16785 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16786 &%queue_domains%&.
16787
16788
16789 .option receive_timeout main time 0s
16790 .cindex "timeout" "for non-SMTP input"
16791 This option sets the timeout for accepting a non-SMTP message, that is, the
16792 maximum time that Exim waits when reading a message on the standard input. If
16793 the value is zero, it will wait forever. This setting is overridden by the
16794 &%-or%& command line option. The timeout for incoming SMTP messages is
16795 controlled by &%smtp_receive_timeout%&.
16796
16797 .option received_header_text main string&!! "see below"
16798 .cindex "customizing" "&'Received:'& header"
16799 .cindex "&'Received:'& header line" "customizing"
16800 This string defines the contents of the &'Received:'& message header that is
16801 added to each message, except for the timestamp, which is automatically added
16802 on at the end (preceded by a semicolon). The string is expanded each time it is
16803 used. If the expansion yields an empty string, no &'Received:'& header line is
16804 added to the message. Otherwise, the string should start with the text
16805 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16806 header lines.
16807 The default setting is:
16808
16809 .code
16810 received_header_text = Received: \
16811   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16812     {${if def:sender_ident \
16813       {from ${quote_local_part:$sender_ident} }}\
16814         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16815   by $primary_hostname \
16816   ${if def:received_protocol {with $received_protocol }}\
16817   ${if def:tls_ver           { ($tls_ver)}}\
16818   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16819   (Exim $version_number)\n\t\
16820   ${if def:sender_address \
16821   {(envelope-from <$sender_address>)\n\t}}\
16822   id $message_exim_id\
16823   ${if def:received_for {\n\tfor $received_for}}
16824 .endd
16825
16826 The reference to the TLS cipher is omitted when Exim is built without TLS
16827 support. The use of conditional expansions ensures that this works for both
16828 locally generated messages and messages received from remote hosts, giving
16829 header lines such as the following:
16830 .code
16831 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16832 by marley.carol.example with esmtp (Exim 4.00)
16833 (envelope-from <bob@carol.example>)
16834 id 16IOWa-00019l-00
16835 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16836 Received: by scrooge.carol.example with local (Exim 4.00)
16837 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16838 .endd
16839 Until the body of the message has been received, the timestamp is the time when
16840 the message started to be received. Once the body has arrived, and all policy
16841 checks have taken place, the timestamp is updated to the time at which the
16842 message was accepted.
16843
16844
16845 .option received_headers_max main integer 30
16846 .cindex "loop" "prevention"
16847 .cindex "mail loop prevention"
16848 .cindex "&'Received:'& header line" "counting"
16849 When a message is to be delivered, the number of &'Received:'& headers is
16850 counted, and if it is greater than this parameter, a mail loop is assumed to
16851 have occurred, the delivery is abandoned, and an error message is generated.
16852 This applies to both local and remote deliveries.
16853
16854
16855 .option recipient_unqualified_hosts main "host list&!!" unset
16856 .cindex "unqualified addresses"
16857 .cindex "host" "unqualified addresses from"
16858 This option lists those hosts from which Exim is prepared to accept unqualified
16859 recipient addresses in message envelopes. The addresses are made fully
16860 qualified by the addition of the &%qualify_recipient%& value. This option also
16861 affects message header lines. Exim does not reject unqualified recipient
16862 addresses in headers, but it qualifies them only if the message came from a
16863 host that matches &%recipient_unqualified_hosts%&,
16864 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16865 option was not set.
16866
16867
16868 .option recipients_max main integer 0
16869 .cindex "limit" "number of recipients"
16870 .cindex "recipient" "maximum number"
16871 If this option is set greater than zero, it specifies the maximum number of
16872 original recipients for any message. Additional recipients that are generated
16873 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16874 all recipients over the limit; earlier recipients are delivered as normal.
16875 Non-SMTP messages with too many recipients are failed, and no deliveries are
16876 done.
16877
16878 .cindex "RCPT" "maximum number of incoming"
16879 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16880 RCPT commands in a single message.
16881
16882
16883 .option recipients_max_reject main boolean false
16884 If this option is set true, Exim rejects SMTP messages containing too many
16885 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16886 error to the eventual DATA command. Otherwise (the default) it gives a 452
16887 error to the surplus RCPT commands and accepts the message on behalf of the
16888 initial set of recipients. The remote server should then re-send the message
16889 for the remaining recipients at a later time.
16890
16891
16892 .option remote_max_parallel main integer 2
16893 .cindex "delivery" "parallelism for remote"
16894 This option controls parallel delivery of one message to a number of remote
16895 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16896 does all the remote deliveries for a message one by one. Otherwise, if a single
16897 message has to be delivered to more than one remote host, or if several copies
16898 have to be sent to the same remote host, up to &%remote_max_parallel%&
16899 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16900 deliveries are required, the maximum number of processes are started, and as
16901 each one finishes, another is begun. The order of starting processes is the
16902 same as if sequential delivery were being done, and can be controlled by the
16903 &%remote_sort_domains%& option. If parallel delivery takes place while running
16904 with debugging turned on, the debugging output from each delivery process is
16905 tagged with its process id.
16906
16907 This option controls only the maximum number of parallel deliveries for one
16908 message in one Exim delivery process. Because Exim has no central queue
16909 manager, there is no way of controlling the total number of simultaneous
16910 deliveries if the configuration allows a delivery attempt as soon as a message
16911 is received.
16912
16913 .cindex "number of deliveries"
16914 .cindex "delivery" "maximum number of"
16915 If you want to control the total number of deliveries on the system, you
16916 need to set the &%queue_only%& option. This ensures that all incoming messages
16917 are added to the queue without starting a delivery process. Then set up an Exim
16918 daemon to start queue runner processes at appropriate intervals (probably
16919 fairly often, for example, every minute), and limit the total number of queue
16920 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16921 delivers only one message at a time, the maximum number of deliveries that can
16922 then take place at once is &%queue_run_max%& multiplied by
16923 &%remote_max_parallel%&.
16924
16925 If it is purely remote deliveries you want to control, use
16926 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16927 doing the SMTP routing before queueing, so that several messages for the same
16928 host will eventually get delivered down the same connection.
16929
16930
16931 .option remote_sort_domains main "domain list&!!" unset
16932 .cindex "sorting remote deliveries"
16933 .cindex "delivery" "sorting remote"
16934 When there are a number of remote deliveries for a message, they are sorted by
16935 domain into the order given by this list. For example,
16936 .code
16937 remote_sort_domains = *.cam.ac.uk:*.uk
16938 .endd
16939 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16940 then to those in the &%uk%& domain, then to any others.
16941
16942
16943 .option retry_data_expire main time 7d
16944 .cindex "hints database" "data expiry"
16945 This option sets a &"use before"& time on retry information in Exim's hints
16946 database. Any older retry data is ignored. This means that, for example, once a
16947 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16948 past failures.
16949
16950
16951 .option retry_interval_max main time 24h
16952 .cindex "retry" "limit on interval"
16953 .cindex "limit" "on retry interval"
16954 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16955 intervals between delivery attempts for messages that cannot be delivered
16956 straight away. This option sets an overall limit to the length of time between
16957 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16958 the default value.
16959
16960
16961 .option return_path_remove main boolean true
16962 .cindex "&'Return-path:'& header line" "removing"
16963 RFC 2821, section 4.4, states that an SMTP server must insert a
16964 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16965 The &'Return-path:'& header preserves the sender address as received in the
16966 MAIL command. This description implies that this header should not be present
16967 in an incoming message. If &%return_path_remove%& is true, any existing
16968 &'Return-path:'& headers are removed from messages at the time they are
16969 received. Exim's transports have options for adding &'Return-path:'& headers at
16970 the time of delivery. They are normally used only for final local deliveries.
16971
16972
16973 .option return_size_limit main integer 100K
16974 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16975
16976
16977 .option rfc1413_hosts main "host list&!!" @[]
16978 .cindex "RFC 1413"
16979 .cindex "host" "for RFC 1413 calls"
16980 RFC 1413 identification calls are made to any client host which matches
16981 an item in the list.
16982 The default value specifies just this host, being any local interface
16983 for the system.
16984
16985 .option rfc1413_query_timeout main time 0s
16986 .cindex "RFC 1413" "query timeout"
16987 .cindex "timeout" "for RFC 1413 call"
16988 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16989 no RFC 1413 calls are ever made.
16990
16991
16992 .option sender_unqualified_hosts main "host list&!!" unset
16993 .cindex "unqualified addresses"
16994 .cindex "host" "unqualified addresses from"
16995 This option lists those hosts from which Exim is prepared to accept unqualified
16996 sender addresses. The addresses are made fully qualified by the addition of
16997 &%qualify_domain%&. This option also affects message header lines. Exim does
16998 not reject unqualified addresses in headers that contain sender addresses, but
16999 it qualifies them only if the message came from a host that matches
17000 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17001 using TCP/IP), and the &%-bnq%& option was not set.
17002
17003
17004 .option slow_lookup_log main integer 0
17005 .cindex "logging" "slow lookups"
17006 .cindex "dns" "logging slow lookups"
17007 This option controls logging of slow lookups.
17008 If the value is nonzero it is taken as a number of milliseconds
17009 and lookups taking longer than this are logged.
17010 Currently this applies only to DNS lookups.
17011
17012
17013
17014 .option smtp_accept_keepalive main boolean true
17015 .cindex "keepalive" "on incoming connection"
17016 This option controls the setting of the SO_KEEPALIVE option on incoming
17017 TCP/IP socket connections. When set, it causes the kernel to probe idle
17018 connections periodically, by sending packets with &"old"& sequence numbers. The
17019 other end of the connection should send an acknowledgment if the connection is
17020 still okay or a reset if the connection has been aborted. The reason for doing
17021 this is that it has the beneficial effect of freeing up certain types of
17022 connection that can get stuck when the remote host is disconnected without
17023 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17024 hours to detect unreachable hosts.
17025
17026
17027
17028 .option smtp_accept_max main integer 20
17029 .cindex "limit" "incoming SMTP connections"
17030 .cindex "SMTP" "incoming connection count"
17031 .cindex "inetd"
17032 This option specifies the maximum number of simultaneous incoming SMTP calls
17033 that Exim will accept. It applies only to the listening daemon; there is no
17034 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17035 value is set to zero, no limit is applied. However, it is required to be
17036 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17037 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17038
17039 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17040 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17041 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17042 and &%smtp_load_reserve%& are then checked before accepting the connection.
17043
17044
17045 .option smtp_accept_max_nonmail main integer 10
17046 .cindex "limit" "non-mail SMTP commands"
17047 .cindex "SMTP" "limiting non-mail commands"
17048 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17049 the connection if there are too many. This option defines &"too many"&. The
17050 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17051 client looping sending EHLO, for example. The check is applied only if the
17052 client host matches &%smtp_accept_max_nonmail_hosts%&.
17053
17054 When a new message is expected, one occurrence of RSET is not counted. This
17055 allows a client to send one RSET between messages (this is not necessary,
17056 but some clients do it). Exim also allows one uncounted occurrence of HELO
17057 or EHLO, and one occurrence of STARTTLS between messages. After
17058 starting up a TLS session, another EHLO is expected, and so it too is not
17059 counted. The first occurrence of AUTH in a connection, or immediately
17060 following STARTTLS is not counted. Otherwise, all commands other than
17061 MAIL, RCPT, DATA, and QUIT are counted.
17062
17063
17064 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17065 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17066 check by setting this option. The default value makes it apply to all hosts. By
17067 changing the value, you can exclude any badly-behaved hosts that you have to
17068 live with.
17069
17070
17071 . Allow this long option name to split; give it unsplit as a fifth argument
17072 . for the automatic .oindex that is generated by .option.
17073 . We insert " &~&~" which is both pretty nasty visually and results in
17074 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17075 . zero-width-space, which would be nicer visually and results in (at least)
17076 . html that Firefox will split on when it's forced to reflow (rather than
17077 . inserting a horizontal scrollbar).  However, the text is still not
17078 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17079 . the option name to split.
17080
17081 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17082          smtp_accept_max_per_connection
17083 .cindex "SMTP" "limiting incoming message count"
17084 .cindex "limit" "messages per SMTP connection"
17085 The value of this option limits the number of MAIL commands that Exim is
17086 prepared to accept over a single SMTP connection, whether or not each command
17087 results in the transfer of a message. After the limit is reached, a 421
17088 response is given to subsequent MAIL commands. This limit is a safety
17089 precaution against a client that goes mad (incidents of this type have been
17090 seen).
17091
17092
17093 .option smtp_accept_max_per_host main string&!! unset
17094 .cindex "limit" "SMTP connections from one host"
17095 .cindex "host" "limiting SMTP connections from"
17096 This option restricts the number of simultaneous IP connections from a single
17097 host (strictly, from a single IP address) to the Exim daemon. The option is
17098 expanded, to enable different limits to be applied to different hosts by
17099 reference to &$sender_host_address$&. Once the limit is reached, additional
17100 connection attempts from the same host are rejected with error code 421. This
17101 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17102 of zero imposes no limit. If this option is set greater than zero, it is
17103 required that &%smtp_accept_max%& be non-zero.
17104
17105 &*Warning*&: When setting this option you should not use any expansion
17106 constructions that take an appreciable amount of time. The expansion and test
17107 happen in the main daemon loop, in order to reject additional connections
17108 without forking additional processes (otherwise a denial-of-service attack
17109 could cause a vast number or processes to be created). While the daemon is
17110 doing this processing, it cannot accept any other incoming connections.
17111
17112
17113
17114 .option smtp_accept_queue main integer 0
17115 .cindex "SMTP" "incoming connection count"
17116 .cindex "queueing incoming messages"
17117 .cindex "message" "queueing by SMTP connection count"
17118 If the number of simultaneous incoming SMTP connections being handled via the
17119 listening daemon exceeds this value, messages received by SMTP are just placed
17120 in the queue; no delivery processes are started automatically. The count is
17121 fixed at the start of an SMTP connection. It cannot be updated in the
17122 subprocess that receives messages, and so the queueing or not queueing applies
17123 to all messages received in the same connection.
17124
17125 A value of zero implies no limit, and clearly any non-zero value is useful only
17126 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17127 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17128 various &%-od%&&'x'& command line options.
17129
17130
17131 . See the comment on smtp_accept_max_per_connection
17132
17133 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17134          smtp_accept_queue_per_connection
17135 .cindex "queueing incoming messages"
17136 .cindex "message" "queueing by message count"
17137 This option limits the number of delivery processes that Exim starts
17138 automatically when receiving messages via SMTP, whether via the daemon or by
17139 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17140 and the number of messages received in a single SMTP session exceeds this
17141 number, subsequent messages are placed in the queue, but no delivery processes
17142 are started. This helps to limit the number of Exim processes when a server
17143 restarts after downtime and there is a lot of mail waiting for it on other
17144 systems. On large systems, the default should probably be increased, and on
17145 dial-in client systems it should probably be set to zero (that is, disabled).
17146
17147
17148 .option smtp_accept_reserve main integer 0
17149 .cindex "SMTP" "incoming call count"
17150 .cindex "host" "reserved"
17151 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17152 number of SMTP connections that are reserved for connections from the hosts
17153 that are specified in &%smtp_reserve_hosts%&. The value set in
17154 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17155 restricted to this number of connections; the option specifies a minimum number
17156 of connection slots for them, not a maximum. It is a guarantee that this group
17157 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17158 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17159 individual host.
17160
17161 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17162 set to 5, once there are 45 active connections (from any hosts), new
17163 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17164 provided the other criteria for acceptance are met.
17165
17166
17167 .option smtp_active_hostname main string&!! unset
17168 .cindex "host" "name in SMTP responses"
17169 .cindex "SMTP" "host name in responses"
17170 .vindex "&$primary_hostname$&"
17171 This option is provided for multi-homed servers that want to masquerade as
17172 several different hosts. At the start of an incoming SMTP connection, its value
17173 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17174 responses. For example, it is used as domain name in the response to an
17175 incoming HELO or EHLO command.
17176
17177 .vindex "&$smtp_active_hostname$&"
17178 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17179 is saved with any messages that are received. It is therefore available for use
17180 in routers and transports when the message is later delivered.
17181
17182 If this option is unset, or if its expansion is forced to fail, or if the
17183 expansion results in an empty string, the value of &$primary_hostname$& is
17184 used. Other expansion failures cause a message to be written to the main and
17185 panic logs, and the SMTP command receives a temporary error. Typically, the
17186 value of &%smtp_active_hostname%& depends on the incoming interface address.
17187 For example:
17188 .code
17189 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17190   {cox.mydomain}{box.mydomain}}
17191 .endd
17192
17193 Although &$smtp_active_hostname$& is primarily concerned with incoming
17194 messages, it is also used as the default for HELO commands in callout
17195 verification if there is no remote transport from which to obtain a
17196 &%helo_data%& value.
17197
17198 .option smtp_banner main string&!! "see below"
17199 .cindex "SMTP" "welcome banner"
17200 .cindex "banner for SMTP"
17201 .cindex "welcome banner for SMTP"
17202 .cindex "customizing" "SMTP banner"
17203 This string, which is expanded every time it is used, is output as the initial
17204 positive response to an SMTP connection. The default setting is:
17205 .code
17206 smtp_banner = $smtp_active_hostname ESMTP Exim \
17207   $version_number $tod_full
17208 .endd
17209 Failure to expand the string causes a panic error. If you want to create a
17210 multiline response to the initial SMTP connection, use &"\n"& in the string at
17211 appropriate points, but not at the end. Note that the 220 code is not included
17212 in this string. Exim adds it automatically (several times in the case of a
17213 multiline response).
17214
17215
17216 .option smtp_check_spool_space main boolean true
17217 .cindex "checking disk space"
17218 .cindex "disk space, checking"
17219 .cindex "spool directory" "checking space"
17220 When this option is set, if an incoming SMTP session encounters the SIZE
17221 option on a MAIL command, it checks that there is enough space in the
17222 spool directory's partition to accept a message of that size, while still
17223 leaving free the amount specified by &%check_spool_space%& (even if that value
17224 is zero). If there isn't enough space, a temporary error code is returned.
17225
17226
17227 .option smtp_connect_backlog main integer 20
17228 .cindex "connection backlog"
17229 .cindex "SMTP" "connection backlog"
17230 .cindex "backlog of connections"
17231 This option specifies a maximum number of waiting SMTP connections. Exim passes
17232 this value to the TCP/IP system when it sets up its listener. Once this number
17233 of connections are waiting for the daemon's attention, subsequent connection
17234 attempts are refused at the TCP/IP level. At least, that is what the manuals
17235 say; in some circumstances such connection attempts have been observed to time
17236 out instead. For large systems it is probably a good idea to increase the
17237 value (to 50, say). It also gives some protection against denial-of-service
17238 attacks by SYN flooding.
17239
17240
17241 .option smtp_enforce_sync main boolean true
17242 .cindex "SMTP" "synchronization checking"
17243 .cindex "synchronization checking in SMTP"
17244 The SMTP protocol specification requires the client to wait for a response from
17245 the server at certain points in the dialogue. Without PIPELINING these
17246 synchronization points are after every command; with PIPELINING they are
17247 fewer, but they still exist.
17248
17249 Some spamming sites send out a complete set of SMTP commands without waiting
17250 for any response. Exim protects against this by rejecting a message if the
17251 client has sent further input when it should not have. The error response &"554
17252 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17253 for this error cannot be perfect because of transmission delays (unexpected
17254 input may be on its way but not yet received when Exim checks). However, it
17255 does detect many instances.
17256
17257 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17258 If you want to disable the check selectively (for example, only for certain
17259 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17260 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17261
17262
17263
17264 .option smtp_etrn_command main string&!! unset
17265 .cindex "ETRN" "command to be run"
17266 .vindex "&$domain$&"
17267 If this option is set, the given command is run whenever an SMTP ETRN
17268 command is received from a host that is permitted to issue such commands (see
17269 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17270 are independently expanded. The expansion variable &$domain$& is set to the
17271 argument of the ETRN command, and no syntax checking is done on it. For
17272 example:
17273 .code
17274 smtp_etrn_command = /etc/etrn_command $domain \
17275                     $sender_host_address
17276 .endd
17277 .new
17278 If the option is not set, the argument for the ETRN command must
17279 be a &'#'& followed by an address string.
17280 In this case an &'exim -R <string>'& command is used;
17281 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17282 .wen
17283
17284 A new process is created to run the command, but Exim does not wait for it to
17285 complete. Consequently, its status cannot be checked. If the command cannot be
17286 run, a line is written to the panic log, but the ETRN caller still receives
17287 a 250 success response. Exim is normally running under its own uid when
17288 receiving SMTP, so it is not possible for it to change the uid before running
17289 the command.
17290
17291
17292 .option smtp_etrn_serialize main boolean true
17293 .cindex "ETRN" "serializing"
17294 When this option is set, it prevents the simultaneous execution of more than
17295 one identical command as a result of ETRN in an SMTP connection. See
17296 section &<<SECTETRN>>& for details.
17297
17298
17299 .option smtp_load_reserve main fixed-point unset
17300 .cindex "load average"
17301 If the system load average ever gets higher than this, incoming SMTP calls are
17302 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17303 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17304 the load is over the limit. The option has no effect on ancient operating
17305 systems on which Exim cannot determine the load average. See also
17306 &%deliver_queue_load_max%& and &%queue_only_load%&.
17307
17308
17309
17310 .option smtp_max_synprot_errors main integer 3
17311 .cindex "SMTP" "limiting syntax and protocol errors"
17312 .cindex "limit" "SMTP syntax and protocol errors"
17313 Exim rejects SMTP commands that contain syntax or protocol errors. In
17314 particular, a syntactically invalid email address, as in this command:
17315 .code
17316 RCPT TO:<abc xyz@a.b.c>
17317 .endd
17318 causes immediate rejection of the command, before any other tests are done.
17319 (The ACL cannot be run if there is no valid address to set up for it.) An
17320 example of a protocol error is receiving RCPT before MAIL. If there are
17321 too many syntax or protocol errors in one SMTP session, the connection is
17322 dropped. The limit is set by this option.
17323
17324 .cindex "PIPELINING" "expected errors"
17325 When the PIPELINING extension to SMTP is in use, some protocol errors are
17326 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17327 Exim assumes that PIPELINING will be used if it advertises it (see
17328 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17329 not count towards the limit.
17330
17331
17332
17333 .option smtp_max_unknown_commands main integer 3
17334 .cindex "SMTP" "limiting unknown commands"
17335 .cindex "limit" "unknown SMTP commands"
17336 If there are too many unrecognized commands in an incoming SMTP session, an
17337 Exim server drops the connection. This is a defence against some kinds of abuse
17338 that subvert web
17339 clients
17340 into making connections to SMTP ports; in these circumstances, a number of
17341 non-SMTP command lines are sent first.
17342
17343
17344
17345 .option smtp_ratelimit_hosts main "host list&!!" unset
17346 .cindex "SMTP" "rate limiting"
17347 .cindex "limit" "rate of message arrival"
17348 .cindex "RCPT" "rate limiting"
17349 Some sites find it helpful to be able to limit the rate at which certain hosts
17350 can send them messages, and the rate at which an individual message can specify
17351 recipients.
17352
17353 Exim has two rate-limiting facilities. This section describes the older
17354 facility, which can limit rates within a single connection. The newer
17355 &%ratelimit%& ACL condition can limit rates across all connections. See section
17356 &<<SECTratelimiting>>& for details of the newer facility.
17357
17358 When a host matches &%smtp_ratelimit_hosts%&, the values of
17359 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17360 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17361 respectively. Each option, if set, must contain a set of four comma-separated
17362 values:
17363
17364 .ilist
17365 A threshold, before which there is no rate limiting.
17366 .next
17367 An initial time delay. Unlike other times in Exim, numbers with decimal
17368 fractional parts are allowed here.
17369 .next
17370 A factor by which to increase the delay each time.
17371 .next
17372 A maximum value for the delay. This should normally be less than 5 minutes,
17373 because after that time, the client is liable to timeout the SMTP command.
17374 .endlist
17375
17376 For example, these settings have been used successfully at the site which
17377 first suggested this feature, for controlling mail from their customers:
17378 .code
17379 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17380 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17381 .endd
17382 The first setting specifies delays that are applied to MAIL commands after
17383 two have been received over a single connection. The initial delay is 0.5
17384 seconds, increasing by a factor of 1.05 each time. The second setting applies
17385 delays to RCPT commands when more than four occur in a single message.
17386
17387
17388 .option smtp_ratelimit_mail main string unset
17389 See &%smtp_ratelimit_hosts%& above.
17390
17391
17392 .option smtp_ratelimit_rcpt main string unset
17393 See &%smtp_ratelimit_hosts%& above.
17394
17395
17396 .option smtp_receive_timeout main time&!! 5m
17397 .cindex "timeout" "for SMTP input"
17398 .cindex "SMTP" "input timeout"
17399 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17400 input, including batch SMTP. If a line of input (either an SMTP command or a
17401 data line) is not received within this time, the SMTP connection is dropped and
17402 the message is abandoned.
17403 A line is written to the log containing one of the following messages:
17404 .code
17405 SMTP command timeout on connection from...
17406 SMTP data timeout on connection from...
17407 .endd
17408 The former means that Exim was expecting to read an SMTP command; the latter
17409 means that it was in the DATA phase, reading the contents of a message.
17410
17411 If the first character of the option is a &"$"& the option is
17412 expanded before use and may depend on
17413 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17414
17415
17416 .oindex "&%-os%&"
17417 The value set by this option can be overridden by the
17418 &%-os%& command-line option. A setting of zero time disables the timeout, but
17419 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17420 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17421 timeout is controlled by &%receive_timeout%& and &%-or%&.
17422
17423
17424 .option smtp_reserve_hosts main "host list&!!" unset
17425 This option defines hosts for which SMTP connections are reserved; see
17426 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17427
17428
17429 .option smtp_return_error_details main boolean false
17430 .cindex "SMTP" "details policy failures"
17431 .cindex "policy control" "rejection, returning details"
17432 In the default state, Exim uses bland messages such as
17433 &"Administrative prohibition"& when it rejects SMTP commands for policy
17434 reasons. Many sysadmins like this because it gives away little information
17435 to spammers. However, some other sysadmins who are applying strict checking
17436 policies want to give out much fuller information about failures. Setting
17437 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17438 example, instead of &"Administrative prohibition"&, it might give:
17439 .code
17440 550-Rejected after DATA: '>' missing at end of address:
17441 550 failing address in "From" header is: <user@dom.ain
17442 .endd
17443
17444
17445 .option smtputf8_advertise_hosts main "host list&!!" *
17446 .cindex "SMTPUTF8" "advertising"
17447 When Exim is built with support for internationalised mail names,
17448 the availability thereof is advertised in
17449 response to EHLO only to those client hosts that match this option. See
17450 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17451
17452
17453 .option spamd_address main string "127.0.0.1 783"
17454 This option is available when Exim is compiled with the content-scanning
17455 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17456 See section &<<SECTscanspamass>>& for more details.
17457
17458
17459
17460 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17461 This option is available when Exim is compiled with SPF support.
17462 See section &<<SECSPF>>& for more details.
17463
17464
17465
17466 .option split_spool_directory main boolean false
17467 .cindex "multiple spool directories"
17468 .cindex "spool directory" "split"
17469 .cindex "directories, multiple"
17470 If this option is set, it causes Exim to split its input directory into 62
17471 subdirectories, each with a single alphanumeric character as its name. The
17472 sixth character of the message id is used to allocate messages to
17473 subdirectories; this is the least significant base-62 digit of the time of
17474 arrival of the message.
17475
17476 Splitting up the spool in this way may provide better performance on systems
17477 where there are long mail queues, by reducing the number of files in any one
17478 directory. The msglog directory is also split up in a similar way to the input
17479 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17480 are still placed in the single directory &_msglog.OLD_&.
17481
17482 It is not necessary to take any special action for existing messages when
17483 changing &%split_spool_directory%&. Exim notices messages that are in the
17484 &"wrong"& place, and continues to process them. If the option is turned off
17485 after a period of being on, the subdirectories will eventually empty and be
17486 automatically deleted.
17487
17488 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17489 changes. Instead of creating a list of all messages in the queue, and then
17490 trying to deliver each one, in turn, it constructs a list of those in one
17491 sub-directory and tries to deliver them, before moving on to the next
17492 sub-directory. The sub-directories are processed in a random order. This
17493 spreads out the scanning of the input directories, and uses less memory. It is
17494 particularly beneficial when there are lots of messages in the queue. However,
17495 if &%queue_run_in_order%& is set, none of this new processing happens. The
17496 entire queue has to be scanned and sorted before any deliveries can start.
17497
17498
17499 .option spool_directory main string&!! "set at compile time"
17500 .cindex "spool directory" "path to"
17501 This defines the directory in which Exim keeps its spool, that is, the messages
17502 it is waiting to deliver. The default value is taken from the compile-time
17503 configuration setting, if there is one. If not, this option must be set. The
17504 string is expanded, so it can contain, for example, a reference to
17505 &$primary_hostname$&.
17506
17507 If the spool directory name is fixed on your installation, it is recommended
17508 that you set it at build time rather than from this option, particularly if the
17509 log files are being written to the spool directory (see &%log_file_path%&).
17510 Otherwise log files cannot be used for errors that are detected early on, such
17511 as failures in the configuration file.
17512
17513 By using this option to override the compiled-in path, it is possible to run
17514 tests of Exim without using the standard spool.
17515
17516 .option spool_wireformat main boolean false
17517 .cindex "spool directory" "file formats"
17518 If this option is set, Exim may for some messages use an alternative format
17519 for data-files in the spool which matches the wire format.
17520 Doing this permits more efficient message reception and transmission.
17521 Currently it is only done for messages received using the ESMTP CHUNKING
17522 option.
17523
17524 The following variables will not have useful values:
17525 .code
17526 $max_received_linelength
17527 $body_linecount
17528 $body_zerocount
17529 .endd
17530
17531 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17532 and any external programs which are passed a reference to a message data file
17533 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17534 will need to be aware of the different formats potentially available.
17535
17536 Using any of the ACL conditions noted will negate the reception benefit
17537 (as a Unix-mbox-format file is constructed for them).
17538 The transmission benefit is maintained.
17539
17540 .option sqlite_lock_timeout main time 5s
17541 .cindex "sqlite lookup type" "lock timeout"
17542 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17543 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17544
17545 .option strict_acl_vars main boolean false
17546 .cindex "&ACL;" "variables, handling unset"
17547 This option controls what happens if a syntactically valid but undefined ACL
17548 variable is referenced. If it is false (the default), an empty string
17549 is substituted; if it is true, an error is generated. See section
17550 &<<SECTaclvariables>>& for details of ACL variables.
17551
17552 .option strip_excess_angle_brackets main boolean false
17553 .cindex "angle brackets, excess"
17554 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17555 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17556 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17557 passed on to another MTA, the excess angle brackets are not passed on. If this
17558 option is not set, multiple pairs of angle brackets cause a syntax error.
17559
17560
17561 .option strip_trailing_dot main boolean false
17562 .cindex "trailing dot on domain"
17563 .cindex "dot" "trailing on domain"
17564 If this option is set, a trailing dot at the end of a domain in an address is
17565 ignored. If this is in the envelope and the message is passed on to another
17566 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17567 domain causes a syntax error.
17568 However, addresses in header lines are checked only when an ACL requests header
17569 syntax checking.
17570
17571
17572 .option syslog_duplication main boolean true
17573 .cindex "syslog" "duplicate log lines; suppressing"
17574 When Exim is logging to syslog, it writes the log lines for its three
17575 separate logs at different syslog priorities so that they can in principle
17576 be separated on the logging hosts. Some installations do not require this
17577 separation, and in those cases, the duplication of certain log lines is a
17578 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17579 particular log line is written to syslog. For lines that normally go to
17580 both the main log and the reject log, the reject log version (possibly
17581 containing message header lines) is written, at LOG_NOTICE priority.
17582 Lines that normally go to both the main and the panic log are written at
17583 the LOG_ALERT priority.
17584
17585
17586 .option syslog_facility main string unset
17587 .cindex "syslog" "facility; setting"
17588 This option sets the syslog &"facility"& name, used when Exim is logging to
17589 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17590 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17591 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17592 details of Exim's logging.
17593
17594
17595 .option syslog_pid main boolean true
17596 .cindex "syslog" "pid"
17597 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17598 omitted when these lines are sent to syslog. (Syslog normally prefixes
17599 the log lines with the PID of the logging process automatically.) You need
17600 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17601 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17602
17603
17604
17605 .option syslog_processname main string &`exim`&
17606 .cindex "syslog" "process name; setting"
17607 This option sets the syslog &"ident"& name, used when Exim is logging to
17608 syslog. The value must be no longer than 32 characters. See chapter
17609 &<<CHAPlog>>& for details of Exim's logging.
17610
17611
17612
17613 .option syslog_timestamp main boolean true
17614 .cindex "syslog" "timestamps"
17615 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17616 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17617 details of Exim's logging.
17618
17619
17620 .option system_filter main string&!! unset
17621 .cindex "filter" "system filter"
17622 .cindex "system filter" "specifying"
17623 .cindex "Sieve filter" "not available for system filter"
17624 This option specifies an Exim filter file that is applied to all messages at
17625 the start of each delivery attempt, before any routing is done. System filters
17626 must be Exim filters; they cannot be Sieve filters. If the system filter
17627 generates any deliveries to files or pipes, or any new mail messages, the
17628 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17629 which transports are to be used. Details of this facility are given in chapter
17630 &<<CHAPsystemfilter>>&.
17631 A forced expansion failure results in no filter operation.
17632
17633
17634 .option system_filter_directory_transport main string&!! unset
17635 .vindex "&$address_file$&"
17636 This sets the name of the transport driver that is to be used when the
17637 &%save%& command in a system message filter specifies a path ending in &"/"&,
17638 implying delivery of each message into a separate file in some directory.
17639 During the delivery, the variable &$address_file$& contains the path name.
17640
17641
17642 .option system_filter_file_transport main string&!! unset
17643 .cindex "file" "transport for system filter"
17644 This sets the name of the transport driver that is to be used when the &%save%&
17645 command in a system message filter specifies a path not ending in &"/"&. During
17646 the delivery, the variable &$address_file$& contains the path name.
17647
17648 .option system_filter_group main string unset
17649 .cindex "gid (group id)" "system filter"
17650 This option is used only when &%system_filter_user%& is also set. It sets the
17651 gid under which the system filter is run, overriding any gid that is associated
17652 with the user. The value may be numerical or symbolic.
17653
17654 .option system_filter_pipe_transport main string&!! unset
17655 .cindex "&(pipe)& transport" "for system filter"
17656 .vindex "&$address_pipe$&"
17657 This specifies the transport driver that is to be used when a &%pipe%& command
17658 is used in a system filter. During the delivery, the variable &$address_pipe$&
17659 contains the pipe command.
17660
17661
17662 .option system_filter_reply_transport main string&!! unset
17663 .cindex "&(autoreply)& transport" "for system filter"
17664 This specifies the transport driver that is to be used when a &%mail%& command
17665 is used in a system filter.
17666
17667
17668 .option system_filter_user main string unset
17669 .cindex "uid (user id)" "system filter"
17670 If this option is set to root, the system filter is run in the main Exim
17671 delivery process, as root.  Otherwise, the system filter runs in a separate
17672 process, as the given user, defaulting to the Exim run-time user.
17673 Unless the string consists entirely of digits, it
17674 is looked up in the password data. Failure to find the named user causes a
17675 configuration error. The gid is either taken from the password data, or
17676 specified by &%system_filter_group%&. When the uid is specified numerically,
17677 &%system_filter_group%& is required to be set.
17678
17679 If the system filter generates any pipe, file, or reply deliveries, the uid
17680 under which the filter is run is used when transporting them, unless a
17681 transport option overrides.
17682
17683
17684 .option tcp_nodelay main boolean true
17685 .cindex "daemon" "TCP_NODELAY on sockets"
17686 .cindex "Nagle algorithm"
17687 .cindex "TCP_NODELAY on listening sockets"
17688 If this option is set false, it stops the Exim daemon setting the
17689 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17690 turns off the &"Nagle algorithm"&, which is a way of improving network
17691 performance in interactive (character-by-character) situations. Turning it off
17692 should improve Exim's performance a bit, so that is what happens by default.
17693 However, it appears that some broken clients cannot cope, and time out. Hence
17694 this option. It affects only those sockets that are set up for listening by the
17695 daemon. Sockets created by the smtp transport for delivering mail always set
17696 TCP_NODELAY.
17697
17698
17699 .option timeout_frozen_after main time 0s
17700 .cindex "frozen messages" "timing out"
17701 .cindex "timeout" "frozen messages"
17702 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17703 message of any kind that has been in the queue for longer than the given time
17704 is automatically cancelled at the next queue run. If the frozen message is a
17705 bounce message, it is just discarded; otherwise, a bounce is sent to the
17706 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17707 If you want to timeout frozen bounce messages earlier than other kinds of
17708 frozen message, see &%ignore_bounce_errors_after%&.
17709
17710 &*Note:*& the default value of zero means no timeouts; with this setting,
17711 frozen messages remain in the queue forever (except for any frozen bounce
17712 messages that are released by &%ignore_bounce_errors_after%&).
17713
17714
17715 .option timezone main string unset
17716 .cindex "timezone, setting"
17717 .cindex "environment" "values from"
17718 The value of &%timezone%& is used to set the environment variable TZ while
17719 running Exim (if it is different on entry). This ensures that all timestamps
17720 created by Exim are in the required timezone. If you want all your timestamps
17721 to be in UTC (aka GMT) you should set
17722 .code
17723 timezone = UTC
17724 .endd
17725 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17726 or, if that is not set, from the value of the TZ environment variable when Exim
17727 is built. If &%timezone%& is set to the empty string, either at build or run
17728 time, any existing TZ variable is removed from the environment when Exim
17729 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17730 unfortunately not all, operating systems.
17731
17732
17733 .option tls_advertise_hosts main "host list&!!" *
17734 .cindex "TLS" "advertising"
17735 .cindex "encryption" "on SMTP connection"
17736 .cindex "SMTP" "encrypted connection"
17737 When Exim is built with support for TLS encrypted connections, the availability
17738 of the STARTTLS command to set up an encrypted session is advertised in
17739 response to EHLO only to those client hosts that match this option. See
17740 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17741 Note that the default value requires that a certificate be supplied
17742 using the &%tls_certificate%& option.  If TLS support for incoming connections
17743 is not required the &%tls_advertise_hosts%& option should be set empty.
17744
17745
17746 .option tls_certificate main string list&!! unset
17747 .cindex "TLS" "server certificate; location of"
17748 .cindex "certificate" "server, location of"
17749 The value of this option is expanded, and must then be a list of absolute paths to
17750 files which contain the server's certificates (in PEM format).
17751 Commonly only one file is needed.
17752 The server's private key is also
17753 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17754 &<<CHAPTLS>>& for further details.
17755
17756 &*Note*&: The certificates defined by this option are used only when Exim is
17757 receiving incoming messages as a server. If you want to supply certificates for
17758 use when sending messages as a client, you must set the &%tls_certificate%&
17759 option in the relevant &(smtp)& transport.
17760
17761 &*Note*&: If you use filenames based on IP addresses, change the list
17762 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17763
17764 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17765 when a list of more than one
17766 file is used, the &$tls_in_ourcert$& variable is unreliable.
17767 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17768
17769 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17770 if the OpenSSL build supports TLS extensions and the TLS client sends the
17771 Server Name Indication extension, then this option and others documented in
17772 &<<SECTtlssni>>& will be re-expanded.
17773
17774 If this option is unset or empty a fresh self-signed certificate will be
17775 generated for every connection.
17776
17777 .option tls_crl main string&!! unset
17778 .cindex "TLS" "server certificate revocation list"
17779 .cindex "certificate" "revocation list for server"
17780 This option specifies a certificate revocation list. The expanded value must
17781 be the name of a file that contains CRLs in PEM format.
17782
17783 Under OpenSSL the option can specify a directory with CRL files.
17784
17785 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17786 for each signing element of the certificate chain (i.e. all but the leaf).
17787 For the file variant this can be multiple PEM blocks in the one file.
17788
17789 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17790
17791
17792 .option tls_dh_max_bits main integer 2236
17793 .cindex "TLS" "D-H bit count"
17794 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17795 the chosen TLS library.  That value might prove to be too high for
17796 interoperability.  This option provides a maximum clamp on the value
17797 suggested, trading off security for interoperability.
17798
17799 The value must be at least 1024.
17800
17801 The value 2236 was chosen because, at time of adding the option, it was the
17802 hard-coded maximum value supported by the NSS cryptographic library, as used
17803 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17804
17805 If you prefer more security and are willing to break some clients, raise this
17806 number.
17807
17808 Note that the value passed to GnuTLS for *generating* a new prime may be a
17809 little less than this figure, because GnuTLS is inexact and may produce a
17810 larger prime than requested.
17811
17812
17813 .option tls_dhparam main string&!! unset
17814 .cindex "TLS" "D-H parameters for server"
17815 The value of this option is expanded and indicates the source of DH parameters
17816 to be used by Exim.
17817
17818 This option is ignored for GnuTLS version 3.6.0 and later.
17819 The library manages parameter negotiation internally.
17820
17821 &*Note: The Exim Maintainers strongly recommend,
17822 for other TLS library versions,
17823 using a filename with site-generated
17824 local DH parameters*&, which has been supported across all versions of Exim.  The
17825 other specific constants available are a fallback so that even when
17826 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17827
17828 If &%tls_dhparam%& is a filename starting with a &`/`&,
17829 then it names a file from which DH
17830 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17831 PKCS#3 representation of the DH prime.  If the file does not exist, for
17832 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17833 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17834 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17835 and treated as though the &%tls_dhparam%& were set to "none".
17836
17837 If this option expands to the string "none", then no DH parameters will be
17838 loaded by Exim.
17839
17840 If this option expands to the string "historic" and Exim is using GnuTLS, then
17841 Exim will attempt to load a file from inside the spool directory.  If the file
17842 does not exist, Exim will attempt to create it.
17843 See section &<<SECTgnutlsparam>>& for further details.
17844
17845 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17846 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17847
17848 In older versions of Exim the default was the 2048 bit prime described in section
17849 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17850 in IKE is assigned number 23.
17851
17852 Otherwise, the option must expand to the name used by Exim for any of a number
17853 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17854 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17855 the number used by IKE, or "default" which corresponds to
17856 &`exim.dev.20160529.3`&.
17857
17858 The available standard primes are:
17859 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17860 &`ike1`&, &`ike2`&, &`ike5`&,
17861 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17862 &`ike22`&, &`ike23`& and &`ike24`&.
17863
17864 The available additional primes are:
17865 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17866
17867 Some of these will be too small to be accepted by clients.
17868 Some may be too large to be accepted by clients.
17869 The open cryptographic community has suspicions about the integrity of some
17870 of the later IKE values, which led into RFC7919 providing new fixed constants
17871 (the "ffdhe" identifiers).
17872
17873 At this point, all of the "ike" values should be considered obsolete;
17874 they're still in Exim to avoid breaking unusual configurations, but are
17875 candidates for removal the next time we have backwards-incompatible changes.
17876
17877 The TLS protocol does not negotiate an acceptable size for this; clients tend
17878 to hard-drop connections if what is offered by the server is unacceptable,
17879 whether too large or too small, and there's no provision for the client to
17880 tell the server what these constraints are.  Thus, as a server operator, you
17881 need to make an educated guess as to what is most likely to work for your
17882 userbase.
17883
17884 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17885 is most likely to maximise interoperability.  The upper bound comes from
17886 applications using the Mozilla Network Security Services (NSS) library, which
17887 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17888 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17889 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17890 acceptable bound from 1024 to 2048.
17891
17892
17893 .option tls_eccurve main string&!! &`auto`&
17894 .cindex TLS "EC cryptography"
17895 This option selects a EC curve for use by Exim when used with OpenSSL.
17896 It has no effect when Exim is used with GnuTLS.
17897
17898 After expansion it must contain a valid EC curve parameter, such as
17899 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17900 for valid selections.
17901
17902 For OpenSSL versions before (and not including) 1.0.2, the string
17903 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17904 &`auto`& tells the library to choose.
17905
17906 If the option expands to an empty string, no EC curves will be enabled.
17907
17908
17909 .option tls_ocsp_file main string&!! unset
17910 .cindex TLS "certificate status"
17911 .cindex TLS "OCSP proof file"
17912 This option
17913 must if set expand to the absolute path to a file which contains a current
17914 status proof for the server's certificate, as obtained from the
17915 Certificate Authority.
17916
17917 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17918 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17919
17920 For OpenSSL 1.1.0 or later, and
17921 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17922 of files, to match a list given for the &%tls_certificate%& option.
17923 The ordering of the two lists must match.
17924 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17925
17926 The file(s) should be in DER format,
17927 except for GnuTLS 3.6.3 or later
17928 or for OpenSSL,
17929 when an optional filetype prefix can be used.
17930 The prefix must be one of "DER" or "PEM", followed by
17931 a single space.  If one is used it sets the format for subsequent
17932 files in the list; the initial format is DER.
17933 If multiple proofs are wanted, for multiple chain elements
17934 (this only works under TLS1.3)
17935 they must be coded as a combined OCSP response.
17936
17937 Although GnuTLS will accept PEM files with multiple separate
17938 PEM blobs (ie. separate OCSP responses), it sends them in the
17939 TLS Certificate record interleaved with the certificates of the chain;
17940 although a GnuTLS client is happy with that, an OpenSSL client is not.
17941
17942 .option tls_on_connect_ports main "string list" unset
17943 .cindex SSMTP
17944 .cindex SMTPS
17945 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17946 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17947 set up without waiting for the client to issue a STARTTLS command. For
17948 further details, see section &<<SECTsupobssmt>>&.
17949
17950
17951
17952 .option tls_privatekey main string list&!! unset
17953 .cindex "TLS" "server private key; location of"
17954 The value of this option is expanded, and must then be a list of absolute paths to
17955 files which contains the server's private keys.
17956 If this option is unset, or if
17957 the expansion is forced to fail, or the result is an empty string, the private
17958 key is assumed to be in the same file as the server's certificates. See chapter
17959 &<<CHAPTLS>>& for further details.
17960
17961 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17962
17963
17964 .option tls_remember_esmtp main boolean false
17965 .cindex "TLS" "esmtp state; remembering"
17966 .cindex "TLS" "broken clients"
17967 If this option is set true, Exim violates the RFCs by remembering that it is in
17968 &"esmtp"& state after successfully negotiating a TLS session. This provides
17969 support for broken clients that fail to send a new EHLO after starting a
17970 TLS session.
17971
17972
17973 .option tls_require_ciphers main string&!! unset
17974 .cindex "TLS" "requiring specific ciphers"
17975 .cindex "cipher" "requiring specific"
17976 This option controls which ciphers can be used for incoming TLS connections.
17977 The &(smtp)& transport has an option of the same name for controlling outgoing
17978 connections. This option is expanded for each connection, so can be varied for
17979 different clients if required. The value of this option must be a list of
17980 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17981 in somewhat different ways. If GnuTLS is being used, the client controls the
17982 preference order of the available ciphers. Details are given in sections
17983 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17984
17985
17986 .option tls_try_verify_hosts main "host list&!!" unset
17987 .cindex "TLS" "client certificate verification"
17988 .cindex "certificate" "verification of client"
17989 See &%tls_verify_hosts%& below.
17990
17991
17992 .option tls_verify_certificates main string&!! system
17993 .cindex "TLS" "client certificate verification"
17994 .cindex "certificate" "verification of client"
17995 The value of this option is expanded, and must then be either the
17996 word "system"
17997 or the absolute path to
17998 a file or directory containing permitted certificates for clients that
17999 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18000
18001 The "system" value for the option will use a
18002 system default location compiled into the SSL library.
18003 This is not available for GnuTLS versions preceding 3.0.20,
18004 and will be taken as empty; an explicit location
18005 must be specified.
18006
18007 The use of a directory for the option value is not available for GnuTLS versions
18008 preceding 3.3.6 and a single file must be used.
18009
18010 With OpenSSL the certificates specified
18011 explicitly
18012 either by file or directory
18013 are added to those given by the system default location.
18014
18015 These certificates should be for the certificate authorities trusted, rather
18016 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18017 the value is a file then the certificates are sent by Exim as a server to
18018 connecting clients, defining the list of accepted certificate authorities.
18019 Thus the values defined should be considered public data.  To avoid this,
18020 use the explicit directory version.
18021
18022 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18023
18024 A forced expansion failure or setting to an empty string is equivalent to
18025 being unset.
18026
18027
18028 .option tls_verify_hosts main "host list&!!" unset
18029 .cindex "TLS" "client certificate verification"
18030 .cindex "certificate" "verification of client"
18031 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18032 certificates from clients. The expected certificates are defined by
18033 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18034 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18035 &%tls_verify_certificates%& is not set.
18036
18037 Any client that matches &%tls_verify_hosts%& is constrained by
18038 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18039 present one of the listed certificates. If it does not, the connection is
18040 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18041 the host to use TLS. It can still send SMTP commands through unencrypted
18042 connections. Forcing a client to use TLS has to be done separately using an
18043 ACL to reject inappropriate commands when the connection is not encrypted.
18044
18045 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18046 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18047 certificate and checks it against &%tls_verify_certificates%&, but does not
18048 abort the connection if there is no certificate or if it does not match. This
18049 state can be detected in an ACL, which makes it possible to implement policies
18050 such as &"accept for relay only if a verified certificate has been received,
18051 but accept for local delivery if encrypted, even without a verified
18052 certificate"&.
18053
18054 Client hosts that match neither of these lists are not asked to present
18055 certificates.
18056
18057
18058 .option trusted_groups main "string list&!!" unset
18059 .cindex "trusted groups"
18060 .cindex "groups" "trusted"
18061 This option is expanded just once, at the start of Exim's processing. If this
18062 option is set, any process that is running in one of the listed groups, or
18063 which has one of them as a supplementary group, is trusted. The groups can be
18064 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18065 details of what trusted callers are permitted to do. If neither
18066 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18067 are trusted.
18068
18069 .option trusted_users main "string list&!!" unset
18070 .cindex "trusted users"
18071 .cindex "user" "trusted"
18072 This option is expanded just once, at the start of Exim's processing. If this
18073 option is set, any process that is running as one of the listed users is
18074 trusted. The users can be specified numerically or by name. See section
18075 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18076 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18077 Exim user are trusted.
18078
18079 .option unknown_login main string&!! unset
18080 .cindex "uid (user id)" "unknown caller"
18081 .vindex "&$caller_uid$&"
18082 This is a specialized feature for use in unusual configurations. By default, if
18083 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18084 gives up. The &%unknown_login%& option can be used to set a login name to be
18085 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18086 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18087 is used for the user's real name (gecos field), unless this has been set by the
18088 &%-F%& option.
18089
18090 .option unknown_username main string unset
18091 See &%unknown_login%&.
18092
18093 .option untrusted_set_sender main "address list&!!" unset
18094 .cindex "trusted users"
18095 .cindex "sender" "setting by untrusted user"
18096 .cindex "untrusted user setting sender"
18097 .cindex "user" "untrusted setting sender"
18098 .cindex "envelope from"
18099 .cindex "envelope sender"
18100 When an untrusted user submits a message to Exim using the standard input, Exim
18101 normally creates an envelope sender address from the user's login and the
18102 default qualification domain. Data from the &%-f%& option (for setting envelope
18103 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18104 is used) is ignored.
18105
18106 However, untrusted users are permitted to set an empty envelope sender address,
18107 to declare that a message should never generate any bounces. For example:
18108 .code
18109 exim -f '<>' user@domain.example
18110 .endd
18111 .vindex "&$sender_ident$&"
18112 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18113 other envelope sender addresses in a controlled way. When it is set, untrusted
18114 users are allowed to set envelope sender addresses that match any of the
18115 patterns in the list. Like all address lists, the string is expanded. The
18116 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18117 users to setting senders that start with their login ids
18118 followed by a hyphen
18119 by a setting like this:
18120 .code
18121 untrusted_set_sender = ^$sender_ident-
18122 .endd
18123 If you want to allow untrusted users to set envelope sender addresses without
18124 restriction, you can use
18125 .code
18126 untrusted_set_sender = *
18127 .endd
18128 The &%untrusted_set_sender%& option applies to all forms of local input, but
18129 only to the setting of the envelope sender. It does not permit untrusted users
18130 to use the other options which trusted user can use to override message
18131 parameters. Furthermore, it does not stop Exim from removing an existing
18132 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18133 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18134 overriding these actions. The handling of the &'Sender:'& header is also
18135 described in section &<<SECTthesenhea>>&.
18136
18137 The log line for a message's arrival shows the envelope sender following
18138 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18139 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18140 envelope sender address, the user's login is shown in parentheses after the
18141 sender address.
18142
18143
18144 .option uucp_from_pattern main string "see below"
18145 .cindex "&""From""& line"
18146 .cindex "UUCP" "&""From""& line"
18147 Some applications that pass messages to an MTA via a command line interface use
18148 an initial line starting with &"From&~"& to pass the envelope sender. In
18149 particular, this is used by UUCP software. Exim recognizes such a line by means
18150 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18151 matches, the sender address is constructed by expanding the contents of
18152 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18153 default pattern recognizes lines in the following two forms:
18154 .code
18155 From ph10 Fri Jan  5 12:35 GMT 1996
18156 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18157 .endd
18158 The pattern can be seen by running
18159 .code
18160 exim -bP uucp_from_pattern
18161 .endd
18162 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18163 year in the second case. The first word after &"From&~"& is matched in the
18164 regular expression by a parenthesized subpattern. The default value for
18165 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18166 (&"ph10"& in the example above) as the message's sender. See also
18167 &%ignore_fromline_hosts%&.
18168
18169
18170 .option uucp_from_sender main string&!! &`$1`&
18171 See &%uucp_from_pattern%& above.
18172
18173
18174 .option warn_message_file main string unset
18175 .cindex "warning of delay" "customizing the message"
18176 .cindex "customizing" "warning message"
18177 This option defines a template file containing paragraphs of text to be used
18178 for constructing the warning message which is sent by Exim when a message has
18179 been in the queue for a specified amount of time, as specified by
18180 &%delay_warning%&. Details of the file's contents are given in chapter
18181 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18182
18183
18184 .option write_rejectlog main boolean true
18185 .cindex "reject log" "disabling"
18186 If this option is set false, Exim no longer writes anything to the reject log.
18187 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18188 .ecindex IIDconfima
18189 .ecindex IIDmaiconf
18190
18191
18192
18193
18194 . ////////////////////////////////////////////////////////////////////////////
18195 . ////////////////////////////////////////////////////////////////////////////
18196
18197 .chapter "Generic options for routers" "CHAProutergeneric"
18198 .scindex IIDgenoprou1 "options" "generic; for routers"
18199 .scindex IIDgenoprou2 "generic options" "router"
18200 This chapter describes the generic options that apply to all routers.
18201 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18202
18203 For a general description of how a router operates, see sections
18204 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18205 which the preconditions are tested. The order of expansion of the options that
18206 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18207 &%headers_remove%&, &%transport%&.
18208
18209
18210
18211 .option address_data routers string&!! unset
18212 .cindex "router" "data attached to address"
18213 The string is expanded just before the router is run, that is, after all the
18214 precondition tests have succeeded. If the expansion is forced to fail, the
18215 router declines, the value of &%address_data%& remains unchanged, and the
18216 &%more%& option controls what happens next. Other expansion failures cause
18217 delivery of the address to be deferred.
18218
18219 .vindex "&$address_data$&"
18220 When the expansion succeeds, the value is retained with the address, and can be
18221 accessed using the variable &$address_data$& in the current router, subsequent
18222 routers, and the eventual transport.
18223
18224 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18225 that runs a user's filter file, the contents of &$address_data$& are accessible
18226 in the filter. This is not normally a problem, because such data is usually
18227 either not confidential or it &"belongs"& to the current user, but if you do
18228 put confidential data into &$address_data$& you need to remember this point.
18229
18230 Even if the router declines or passes, the value of &$address_data$& remains
18231 with the address, though it can be changed by another &%address_data%& setting
18232 on a subsequent router. If a router generates child addresses, the value of
18233 &$address_data$& propagates to them. This also applies to the special kind of
18234 &"child"& that is generated by a router with the &%unseen%& option.
18235
18236 The idea of &%address_data%& is that you can use it to look up a lot of data
18237 for the address once, and then pick out parts of the data later. For example,
18238 you could use a single LDAP lookup to return a string of the form
18239 .code
18240 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18241 .endd
18242 In the transport you could pick out the mailbox by a setting such as
18243 .code
18244 file = ${extract{mailbox}{$address_data}}
18245 .endd
18246 This makes the configuration file less messy, and also reduces the number of
18247 lookups (though Exim does cache lookups).
18248
18249 See also the &%set%& option below.
18250
18251 .vindex "&$sender_address_data$&"
18252 .vindex "&$address_data$&"
18253 The &%address_data%& facility is also useful as a means of passing information
18254 from one router to another, and from a router to a transport. In addition, if
18255 &$address_data$& is set by a router when verifying a recipient address from an
18256 ACL, it remains available for use in the rest of the ACL statement. After
18257 verifying a sender, the value is transferred to &$sender_address_data$&.
18258
18259
18260
18261 .option address_test routers&!? boolean true
18262 .oindex "&%-bt%&"
18263 .cindex "router" "skipping when address testing"
18264 If this option is set false, the router is skipped when routing is being tested
18265 by means of the &%-bt%& command line option. This can be a convenience when
18266 your first router sends messages to an external scanner, because it saves you
18267 having to set the &"already scanned"& indicator when testing real address
18268 routing.
18269
18270
18271
18272 .option cannot_route_message routers string&!! unset
18273 .cindex "router" "customizing &""cannot route""& message"
18274 .cindex "customizing" "&""cannot route""& message"
18275 This option specifies a text message that is used when an address cannot be
18276 routed because Exim has run out of routers. The default message is
18277 &"Unrouteable address"&. This option is useful only on routers that have
18278 &%more%& set false, or on the very last router in a configuration, because the
18279 value that is used is taken from the last router that is considered. This
18280 includes a router that is skipped because its preconditions are not met, as
18281 well as a router that declines. For example, using the default configuration,
18282 you could put:
18283 .code
18284 cannot_route_message = Remote domain not found in DNS
18285 .endd
18286 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18287 and
18288 .code
18289 cannot_route_message = Unknown local user
18290 .endd
18291 on the final router that checks for local users. If string expansion fails for
18292 this option, the default message is used. Unless the expansion failure was
18293 explicitly forced, a message about the failure is written to the main and panic
18294 logs, in addition to the normal message about the routing failure.
18295
18296
18297 .option caseful_local_part routers boolean false
18298 .cindex "case of local parts"
18299 .cindex "router" "case of local parts"
18300 By default, routers handle the local parts of addresses in a case-insensitive
18301 manner, though the actual case is preserved for transmission with the message.
18302 If you want the case of letters to be significant in a router, you must set
18303 this option true. For individual router options that contain address or local
18304 part lists (for example, &%local_parts%&), case-sensitive matching can be
18305 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18306 more details.
18307
18308 .vindex "&$local_part$&"
18309 .vindex "&$original_local_part$&"
18310 .vindex "&$parent_local_part$&"
18311 The value of the &$local_part$& variable is forced to lower case while a
18312 router is running unless &%caseful_local_part%& is set. When a router assigns
18313 an address to a transport, the value of &$local_part$& when the transport runs
18314 is the same as it was in the router. Similarly, when a router generates child
18315 addresses by aliasing or forwarding, the values of &$original_local_part$&
18316 and &$parent_local_part$& are those that were used by the redirecting router.
18317
18318 This option applies to the processing of an address by a router. When a
18319 recipient address is being processed in an ACL, there is a separate &%control%&
18320 modifier that can be used to specify case-sensitive processing within the ACL
18321 (see section &<<SECTcontrols>>&).
18322
18323
18324
18325 .option check_local_user routers&!? boolean false
18326 .cindex "local user, checking in router"
18327 .cindex "router" "checking for local user"
18328 .cindex "&_/etc/passwd_&"
18329 .vindex "&$home$&"
18330 When this option is true, Exim checks that the local part of the recipient
18331 address (with affixes removed if relevant) is the name of an account on the
18332 local system. The check is done by calling the &[getpwnam()]& function rather
18333 than trying to read &_/etc/passwd_& directly. This means that other methods of
18334 holding password data (such as NIS) are supported. If the local part is a local
18335 user, &$home$& is set from the password data, and can be tested in other
18336 preconditions that are evaluated after this one (the order of evaluation is
18337 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18338 overridden by &%router_home_directory%&. If the local part is not a local user,
18339 the router is skipped.
18340
18341 If you want to check that the local part is either the name of a local user
18342 or matches something else, you cannot combine &%check_local_user%& with a
18343 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18344 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18345 setting to achieve this. For example:
18346 .code
18347 local_parts = passwd;$local_part : lsearch;/etc/other/users
18348 .endd
18349 Note, however, that the side effects of &%check_local_user%& (such as setting
18350 up a home directory) do not occur when a &(passwd)& lookup is used in a
18351 &%local_parts%& (or any other) precondition.
18352
18353
18354
18355 .option condition routers&!? string&!! unset
18356 .cindex "router" "customized precondition"
18357 This option specifies a general precondition test that has to succeed for the
18358 router to be called. The &%condition%& option is the last precondition to be
18359 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18360 result is a forced failure, or an empty string, or one of the strings &"0"& or
18361 &"no"& or &"false"& (checked without regard to the case of the letters), the
18362 router is skipped, and the address is offered to the next one.
18363
18364 If the result is any other value, the router is run (as this is the last
18365 precondition to be evaluated, all the other preconditions must be true).
18366
18367 This option is unusual in that multiple &%condition%& options may be present.
18368 All &%condition%& options must succeed.
18369
18370 The &%condition%& option provides a means of applying custom conditions to the
18371 running of routers. Note that in the case of a simple conditional expansion,
18372 the default expansion values are exactly what is wanted. For example:
18373 .code
18374 condition = ${if >{$message_age}{600}}
18375 .endd
18376 Because of the default behaviour of the string expansion, this is equivalent to
18377 .code
18378 condition = ${if >{$message_age}{600}{true}{}}
18379 .endd
18380
18381 A multiple condition example, which succeeds:
18382 .code
18383 condition = ${if >{$message_age}{600}}
18384 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18385 condition = foobar
18386 .endd
18387
18388 If the expansion fails (other than forced failure) delivery is deferred. Some
18389 of the other precondition options are common special cases that could in fact
18390 be specified using &%condition%&.
18391
18392 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18393 are far older, and use one set of semantics.  ACLs are newer and when
18394 they were created, the ACL &%condition%& process was given far stricter
18395 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18396 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18397 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18398 Router rules processing behavior.
18399
18400 This is best illustrated in an example:
18401 .code
18402 # If used in an ACL condition will fail with a syntax error, but
18403 # in a router condition any extra characters are treated as a string
18404
18405 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18406 true {yes} {no}}
18407
18408 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18409  {yes} {no}}
18410 .endd
18411 In each example above, the &%if%& statement actually ends after
18412 &"{google.com}}"&.  Since no true or false braces were defined, the
18413 default &%if%& behavior is to return a boolean true or a null answer
18414 (which evaluates to false). The rest of the line is then treated as a
18415 string. So the first example resulted in the boolean answer &"true"&
18416 with the string &" {yes} {no}}"& appended to it. The second example
18417 resulted in the null output (indicating false) with the string
18418 &" {yes} {no}}"& appended to it.
18419
18420 In fact you can put excess forward braces in too.  In the router
18421 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18422 mean something, like after a &"$"& or when required as part of a
18423 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18424 string characters.
18425
18426 Thus, in a Router, the above expansion strings will both always evaluate
18427 true, as the result of expansion is a non-empty string which doesn't
18428 match an explicit false value.  This can be tricky to debug.  By
18429 contrast, in an ACL either of those strings will always result in an
18430 expansion error because the result doesn't look sufficiently boolean.
18431
18432
18433 .option debug_print routers string&!! unset
18434 .cindex "testing" "variables in drivers"
18435 If this option is set and debugging is enabled (see the &%-d%& command line
18436 option) or in address-testing mode (see the &%-bt%& command line option),
18437 the string is expanded and included in the debugging output.
18438 If expansion of the string fails, the error message is written to the debugging
18439 output, and Exim carries on processing.
18440 This option is provided to help with checking out the values of variables and
18441 so on when debugging router configurations. For example, if a &%condition%&
18442 option appears not to be working, &%debug_print%& can be used to output the
18443 variables it references. The output happens after checks for &%domains%&,
18444 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18445 are tested. A newline is added to the text if it does not end with one.
18446 The variable &$router_name$& contains the name of the router.
18447
18448
18449
18450 .option disable_logging routers boolean false
18451 If this option is set true, nothing is logged for any routing errors
18452 or for any deliveries caused by this router. You should not set this option
18453 unless you really, really know what you are doing. See also the generic
18454 transport option of the same name.
18455
18456 .option dnssec_request_domains routers "domain list&!!" *
18457 .cindex "MX record" "security"
18458 .cindex "DNSSEC" "MX lookup"
18459 .cindex "security" "MX lookup"
18460 .cindex "DNS" "DNSSEC"
18461 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18462 the dnssec request bit set.
18463 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18464
18465 .option dnssec_require_domains routers "domain list&!!" unset
18466 .cindex "MX record" "security"
18467 .cindex "DNSSEC" "MX lookup"
18468 .cindex "security" "MX lookup"
18469 .cindex "DNS" "DNSSEC"
18470 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18471 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18472 (AD bit) set will be ignored and logged as a host-lookup failure.
18473 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18474
18475
18476 .option domains routers&!? "domain list&!!" unset
18477 .cindex "router" "restricting to specific domains"
18478 .vindex "&$domain_data$&"
18479 If this option is set, the router is skipped unless the current domain matches
18480 the list. If the match is achieved by means of a file lookup, the data that the
18481 lookup returned for the domain is placed in &$domain_data$& for use in string
18482 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18483 a list of the order in which preconditions are evaluated.
18484
18485
18486
18487 .option driver routers string unset
18488 This option must always be set. It specifies which of the available routers is
18489 to be used.
18490
18491
18492 .option dsn_lasthop routers boolean false
18493 .cindex "DSN" "success"
18494 .cindex "Delivery Status Notification" "success"
18495 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18496 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18497 instead send a success DSN as if the next hop does not support DSN.
18498 Not effective on redirect routers.
18499
18500
18501
18502 .option errors_to routers string&!! unset
18503 .cindex "envelope from"
18504 .cindex "envelope sender"
18505 .cindex "router" "changing address for errors"
18506 If a router successfully handles an address, it may assign the address to a
18507 transport for delivery or it may generate child addresses. In both cases, if
18508 there is a delivery problem during later processing, the resulting bounce
18509 message is sent to the address that results from expanding this string,
18510 provided that the address verifies successfully. The &%errors_to%& option is
18511 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18512
18513 The &%errors_to%& setting associated with an address can be overridden if it
18514 subsequently passes through other routers that have their own &%errors_to%&
18515 settings, or if the message is delivered by a transport with a &%return_path%&
18516 setting.
18517
18518 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18519 the expansion fails to verify, the errors address associated with the incoming
18520 address is used. At top level, this is the envelope sender. A non-forced
18521 expansion failure causes delivery to be deferred.
18522
18523 If an address for which &%errors_to%& has been set ends up being delivered over
18524 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18525 any bounces that are generated by other MTAs on the delivery route are also
18526 sent there. You can set &%errors_to%& to the empty string by either of these
18527 settings:
18528 .code
18529 errors_to =
18530 errors_to = ""
18531 .endd
18532 An expansion item that yields an empty string has the same effect. If you do
18533 this, a locally detected delivery error for addresses processed by this router
18534 no longer gives rise to a bounce message; the error is discarded. If the
18535 address is delivered to a remote host, the return path is set to &`<>`&, unless
18536 overridden by the &%return_path%& option on the transport.
18537
18538 .vindex "&$address_data$&"
18539 If for some reason you want to discard local errors, but use a non-empty
18540 MAIL command for remote delivery, you can preserve the original return
18541 path in &$address_data$& in the router, and reinstate it in the transport by
18542 setting &%return_path%&.
18543
18544 The most common use of &%errors_to%& is to direct mailing list bounces to the
18545 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18546 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18547
18548
18549
18550 .option expn routers&!? boolean true
18551 .cindex "address" "testing"
18552 .cindex "testing" "addresses"
18553 .cindex "EXPN" "router skipping"
18554 .cindex "router" "skipping for EXPN"
18555 If this option is turned off, the router is skipped when testing an address
18556 as a result of processing an SMTP EXPN command. You might, for example,
18557 want to turn it off on a router for users' &_.forward_& files, while leaving it
18558 on for the system alias file.
18559 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18560 are evaluated.
18561
18562 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18563 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18564 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18565
18566
18567
18568 .option fail_verify routers boolean false
18569 .cindex "router" "forcing verification failure"
18570 Setting this option has the effect of setting both &%fail_verify_sender%& and
18571 &%fail_verify_recipient%& to the same value.
18572
18573
18574
18575 .option fail_verify_recipient routers boolean false
18576 If this option is true and an address is accepted by this router when
18577 verifying a recipient, verification fails.
18578
18579
18580
18581 .option fail_verify_sender routers boolean false
18582 If this option is true and an address is accepted by this router when
18583 verifying a sender, verification fails.
18584
18585
18586
18587 .option fallback_hosts routers "string list" unset
18588 .cindex "router" "fallback hosts"
18589 .cindex "fallback" "hosts specified on router"
18590 String expansion is not applied to this option. The argument must be a
18591 colon-separated list of host names or IP addresses. The list separator can be
18592 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18593 each name or address. In fact, the format of each item is exactly the same as
18594 defined for the list of hosts in a &(manualroute)& router (see section
18595 &<<SECTformatonehostitem>>&).
18596
18597 If a router queues an address for a remote transport, this host list is
18598 associated with the address, and used instead of the transport's fallback host
18599 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18600 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18601 transport for further details.
18602
18603
18604 .option group routers string&!! "see below"
18605 .cindex "gid (group id)" "local delivery"
18606 .cindex "local transports" "uid and gid"
18607 .cindex "transport" "local"
18608 .cindex "router" "setting group"
18609 When a router queues an address for a transport, and the transport does not
18610 specify a group, the group given here is used when running the delivery
18611 process.
18612 The group may be specified numerically or by name. If expansion fails, the
18613 error is logged and delivery is deferred.
18614 The default is unset, unless &%check_local_user%& is set, when the default
18615 is taken from the password information. See also &%initgroups%& and &%user%&
18616 and the discussion in chapter &<<CHAPenvironment>>&.
18617
18618
18619
18620 .option headers_add routers list&!! unset
18621 .cindex "header lines" "adding"
18622 .cindex "router" "adding header lines"
18623 This option specifies a list of text headers,
18624 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18625 that is associated with any addresses that are accepted by the router.
18626 Each item is separately expanded, at routing time.  However, this
18627 option has no effect when an address is just being verified. The way in which
18628 the text is used to add header lines at transport time is described in section
18629 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18630 message is in the process of being transported. This means that references to
18631 header lines in string expansions in the transport's configuration do not
18632 &"see"& the added header lines.
18633
18634 The &%headers_add%& option is expanded after &%errors_to%&, but before
18635 &%headers_remove%& and &%transport%&. If an item is empty, or if
18636 an item expansion is forced to fail, the item has no effect. Other expansion
18637 failures are treated as configuration errors.
18638
18639 Unlike most options, &%headers_add%& can be specified multiple times
18640 for a router; all listed headers are added.
18641
18642 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18643 router that has the &%one_time%& option set.
18644
18645 .cindex "duplicate addresses"
18646 .oindex "&%unseen%&"
18647 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18648 additions are deleted when the address is passed on to subsequent routers.
18649 For a &%redirect%& router, if a generated address is the same as the incoming
18650 address, this can lead to duplicate addresses with different header
18651 modifications. Exim does not do duplicate deliveries (except, in certain
18652 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18653 which of the duplicates is discarded, so this ambiguous situation should be
18654 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18655
18656
18657
18658 .option headers_remove routers list&!! unset
18659 .cindex "header lines" "removing"
18660 .cindex "router" "removing header lines"
18661 This option specifies a list of text headers,
18662 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18663 that is associated with any addresses that are accepted by the router.
18664 However, the option has no effect when an address is just being verified.
18665 Each list item is separately expanded, at transport time.
18666 .new
18667 If an item ends in *, it will match any header with the given prefix.
18668 .wen
18669 The way in which
18670 the text is used to remove header lines at transport time is described in
18671 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18672 the message is in the process of being transported. This means that references
18673 to header lines in string expansions in the transport's configuration still
18674 &"see"& the original header lines.
18675
18676 The &%headers_remove%& option is handled after &%errors_to%& and
18677 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18678 the item has no effect. Other expansion failures are treated as configuration
18679 errors.
18680
18681 Unlike most options, &%headers_remove%& can be specified multiple times
18682 for a router; all listed headers are removed.
18683
18684 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18685 router that has the &%one_time%& option set.
18686
18687 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18688 removal requests are deleted when the address is passed on to subsequent
18689 routers, and this can lead to problems with duplicates -- see the similar
18690 warning for &%headers_add%& above.
18691
18692 &*Warning 3*&: Because of the separate expansion of the list items,
18693 items that contain a list separator must have it doubled.
18694 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18695
18696
18697
18698 .option ignore_target_hosts routers "host list&!!" unset
18699 .cindex "IP address" "discarding"
18700 .cindex "router" "discarding IP addresses"
18701 Although this option is a host list, it should normally contain IP address
18702 entries rather than names. If any host that is looked up by the router has an
18703 IP address that matches an item in this list, Exim behaves as if that IP
18704 address did not exist. This option allows you to cope with rogue DNS entries
18705 like
18706 .code
18707 remote.domain.example.  A  127.0.0.1
18708 .endd
18709 by setting
18710 .code
18711 ignore_target_hosts = 127.0.0.1
18712 .endd
18713 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18714 discarded in this way, the router declines. In a conventional configuration, an
18715 attempt to mail to such a domain would normally provoke the &"unrouteable
18716 domain"& error, and an attempt to verify an address in the domain would fail.
18717 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18718 router declines if presented with one of the listed addresses.
18719
18720 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18721 means of the first or the second of the following settings, respectively:
18722 .code
18723 ignore_target_hosts = 0.0.0.0/0
18724 ignore_target_hosts = <; 0::0/0
18725 .endd
18726 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18727 in the second line matches all IPv6 addresses.
18728
18729 This option may also be useful for ignoring link-local and site-local IPv6
18730 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18731 is expanded before use as a list, it is possible to make it dependent on the
18732 domain that is being routed.
18733
18734 .vindex "&$host_address$&"
18735 During its expansion, &$host_address$& is set to the IP address that is being
18736 checked.
18737
18738 .option initgroups routers boolean false
18739 .cindex "additional groups"
18740 .cindex "groups" "additional"
18741 .cindex "local transports" "uid and gid"
18742 .cindex "transport" "local"
18743 If the router queues an address for a transport, and this option is true, and
18744 the uid supplied by the router is not overridden by the transport, the
18745 &[initgroups()]& function is called when running the transport to ensure that
18746 any additional groups associated with the uid are set up. See also &%group%&
18747 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18748
18749
18750
18751 .option local_part_prefix routers&!? "string list" unset
18752 .cindex affix "router precondition"
18753 .cindex "router" "prefix for local part"
18754 .cindex "prefix" "for local part, used in router"
18755 If this option is set, the router is skipped unless the local part starts with
18756 one of the given strings, or &%local_part_prefix_optional%& is true. See
18757 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18758 evaluated.
18759
18760 The list is scanned from left to right, and the first prefix that matches is
18761 used. A limited form of wildcard is available; if the prefix begins with an
18762 asterisk, it matches the longest possible sequence of arbitrary characters at
18763 the start of the local part. An asterisk should therefore always be followed by
18764 some character that does not occur in normal local parts.
18765 .cindex "multiple mailboxes"
18766 .cindex "mailbox" "multiple"
18767 Wildcarding can be used to set up multiple user mailboxes, as described in
18768 section &<<SECTmulbox>>&.
18769
18770 .vindex "&$local_part$&"
18771 .vindex "&$local_part_prefix$&"
18772 During the testing of the &%local_parts%& option, and while the router is
18773 running, the prefix is removed from the local part, and is available in the
18774 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18775 the router accepts the address, this remains true during subsequent delivery by
18776 a transport. In particular, the local part that is transmitted in the RCPT
18777 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18778 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18779 the relevant transport.
18780
18781 When an address is being verified, &%local_part_prefix%& affects only the
18782 behaviour of the router. If the callout feature of verification is in use, this
18783 means that the full address, including the prefix, will be used during the
18784 callout.
18785
18786 The prefix facility is commonly used to handle local parts of the form
18787 &%owner-something%&. Another common use is to support local parts of the form
18788 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18789 to tell a user their forwarding is broken &-- by placing a router like this one
18790 immediately before the router that handles &_.forward_& files:
18791 .code
18792 real_localuser:
18793   driver = accept
18794   local_part_prefix = real-
18795   check_local_user
18796   transport = local_delivery
18797 .endd
18798 For security, it would probably be a good idea to restrict the use of this
18799 router to locally-generated messages, using a condition such as this:
18800 .code
18801   condition = ${if match {$sender_host_address}\
18802                          {\N^(|127\.0\.0\.1)$\N}}
18803 .endd
18804
18805 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18806 both conditions must be met if not optional. Care must be taken if wildcards
18807 are used in both a prefix and a suffix on the same router. Different
18808 separator characters must be used to avoid ambiguity.
18809
18810
18811 .option local_part_prefix_optional routers boolean false
18812 See &%local_part_prefix%& above.
18813
18814
18815
18816 .option local_part_suffix routers&!? "string list" unset
18817 .cindex "router" "suffix for local part"
18818 .cindex "suffix for local part" "used in router"
18819 This option operates in the same way as &%local_part_prefix%&, except that the
18820 local part must end (rather than start) with the given string, the
18821 &%local_part_suffix_optional%& option determines whether the suffix is
18822 mandatory, and the wildcard * character, if present, must be the last
18823 character of the suffix. This option facility is commonly used to handle local
18824 parts of the form &%something-request%& and multiple user mailboxes of the form
18825 &%username-foo%&.
18826
18827
18828 .option local_part_suffix_optional routers boolean false
18829 See &%local_part_suffix%& above.
18830
18831
18832
18833 .option local_parts routers&!? "local part list&!!" unset
18834 .cindex "router" "restricting to specific local parts"
18835 .cindex "local part" "checking in router"
18836 The router is run only if the local part of the address matches the list.
18837 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18838 are evaluated, and
18839 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18840 string is expanded, it is possible to make it depend on the domain, for
18841 example:
18842 .code
18843 local_parts = dbm;/usr/local/specials/$domain
18844 .endd
18845 .vindex "&$local_part_data$&"
18846 If the match is achieved by a lookup, the data that the lookup returned
18847 for the local part is placed in the variable &$local_part_data$& for use in
18848 expansions of the router's private options. You might use this option, for
18849 example, if you have a large number of local virtual domains, and you want to
18850 send all postmaster mail to the same place without having to set up an alias in
18851 each virtual domain:
18852 .code
18853 postmaster:
18854   driver = redirect
18855   local_parts = postmaster
18856   data = postmaster@real.domain.example
18857 .endd
18858
18859
18860 .option log_as_local routers boolean "see below"
18861 .cindex "log" "delivery line"
18862 .cindex "delivery" "log line format"
18863 Exim has two logging styles for delivery, the idea being to make local
18864 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18865 recipient address is given just as the local part, without a domain. The use of
18866 this style is controlled by this option. It defaults to true for the &(accept)&
18867 router, and false for all the others. This option applies only when a
18868 router assigns an address to a transport. It has no effect on routers that
18869 redirect addresses.
18870
18871
18872
18873 .option more routers boolean&!! true
18874 The result of string expansion for this option must be a valid boolean value,
18875 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18876 result causes an error, and delivery is deferred. If the expansion is forced to
18877 fail, the default value for the option (true) is used. Other failures cause
18878 delivery to be deferred.
18879
18880 If this option is set false, and the router declines to handle the address, no
18881 further routers are tried, routing fails, and the address is bounced.
18882 .oindex "&%self%&"
18883 However, if the router explicitly passes an address to the following router by
18884 means of the setting
18885 .code
18886 self = pass
18887 .endd
18888 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18889 does not affect the behaviour if one of the precondition tests fails. In that
18890 case, the address is always passed to the next router.
18891
18892 Note that &%address_data%& is not considered to be a precondition. If its
18893 expansion is forced to fail, the router declines, and the value of &%more%&
18894 controls what happens next.
18895
18896
18897 .option pass_on_timeout routers boolean false
18898 .cindex "timeout" "of router"
18899 .cindex "router" "timeout"
18900 If a router times out during a host lookup, it normally causes deferral of the
18901 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18902 router, overriding &%no_more%&. This may be helpful for systems that are
18903 intermittently connected to the Internet, or those that want to pass to a smart
18904 host any messages that cannot immediately be delivered.
18905
18906 There are occasional other temporary errors that can occur while doing DNS
18907 lookups. They are treated in the same way as a timeout, and this option
18908 applies to all of them.
18909
18910
18911
18912 .option pass_router routers string unset
18913 .cindex "router" "go to after &""pass""&"
18914 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18915 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18916 routing to continue, and overriding a false setting of &%more%&. When one of
18917 these routers returns &"pass"&, the address is normally handed on to the next
18918 router in sequence. This can be changed by setting &%pass_router%& to the name
18919 of another router. However (unlike &%redirect_router%&) the named router must
18920 be below the current router, to avoid loops. Note that this option applies only
18921 to the special case of &"pass"&. It does not apply when a router returns
18922 &"decline"& because it cannot handle an address.
18923
18924
18925
18926 .option redirect_router routers string unset
18927 .cindex "router" "start at after redirection"
18928 Sometimes an administrator knows that it is pointless to reprocess addresses
18929 generated from alias or forward files with the same router again. For
18930 example, if an alias file translates real names into login ids there is no
18931 point searching the alias file a second time, especially if it is a large file.
18932
18933 The &%redirect_router%& option can be set to the name of any router instance.
18934 It causes the routing of any generated addresses to start at the named router
18935 instead of at the first router. This option has no effect if the router in
18936 which it is set does not generate new addresses.
18937
18938
18939
18940 .option require_files routers&!? "string list&!!" unset
18941 .cindex "file" "requiring for router"
18942 .cindex "router" "requiring file existence"
18943 This option provides a general mechanism for predicating the running of a
18944 router on the existence or non-existence of certain files or directories.
18945 Before running a router, as one of its precondition tests, Exim works its way
18946 through the &%require_files%& list, expanding each item separately.
18947
18948 Because the list is split before expansion, any colons in expansion items must
18949 be doubled, or the facility for using a different list separator must be used
18950 (&<<SECTlistsepchange>>&).
18951 If any expansion is forced to fail, the item is ignored. Other expansion
18952 failures cause routing of the address to be deferred.
18953
18954 If any expanded string is empty, it is ignored. Otherwise, except as described
18955 below, each string must be a fully qualified file path, optionally preceded by
18956 &"!"&. The paths are passed to the &[stat()]& function to test for the
18957 existence of the files or directories. The router is skipped if any paths not
18958 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18959
18960 .cindex "NFS"
18961 If &[stat()]& cannot determine whether a file exists or not, delivery of
18962 the message is deferred. This can happen when NFS-mounted filesystems are
18963 unavailable.
18964
18965 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18966 options, so you cannot use it to check for the existence of a file in which to
18967 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18968 full list of the order in which preconditions are evaluated.) However, as
18969 these options are all expanded, you can use the &%exists%& expansion condition
18970 to make such tests. The &%require_files%& option is intended for checking files
18971 that the router may be going to use internally, or which are needed by a
18972 transport (e.g., &_.procmailrc_&).
18973
18974 During delivery, the &[stat()]& function is run as root, but there is a
18975 facility for some checking of the accessibility of a file by another user.
18976 This is not a proper permissions check, but just a &"rough"& check that
18977 operates as follows:
18978
18979 If an item in a &%require_files%& list does not contain any forward slash
18980 characters, it is taken to be the user (and optional group, separated by a
18981 comma) to be checked for subsequent files in the list. If no group is specified
18982 but the user is specified symbolically, the gid associated with the uid is
18983 used. For example:
18984 .code
18985 require_files = mail:/some/file
18986 require_files = $local_part:$home/.procmailrc
18987 .endd
18988 If a user or group name in a &%require_files%& list does not exist, the
18989 &%require_files%& condition fails.
18990
18991 Exim performs the check by scanning along the components of the file path, and
18992 checking the access for the given uid and gid. It checks for &"x"& access on
18993 directories, and &"r"& access on the final file. Note that this means that file
18994 access control lists, if the operating system has them, are ignored.
18995
18996 &*Warning 1*&: When the router is being run to verify addresses for an
18997 incoming SMTP message, Exim is not running as root, but under its own uid. This
18998 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18999 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19000 user is not permitted to read one of the directories on the file's path.
19001
19002 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19003 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19004 without root access. In this case, if a check for access by a particular user
19005 is requested, Exim creates a subprocess that runs as that user, and tries the
19006 check again in that process.
19007
19008 The default action for handling an unresolved EACCES is to consider it to
19009 be caused by a configuration error, and routing is deferred because the
19010 existence or non-existence of the file cannot be determined. However, in some
19011 circumstances it may be desirable to treat this condition as if the file did
19012 not exist. If the filename (or the exclamation mark that precedes the filename
19013 for non-existence) is preceded by a plus sign, the EACCES error is treated
19014 as if the file did not exist. For example:
19015 .code
19016 require_files = +/some/file
19017 .endd
19018 If the router is not an essential part of verification (for example, it
19019 handles users' &_.forward_& files), another solution is to set the &%verify%&
19020 option false so that the router is skipped when verifying.
19021
19022
19023
19024 .option retry_use_local_part routers boolean "see below"
19025 .cindex "hints database" "retry keys"
19026 .cindex "local part" "in retry keys"
19027 When a delivery suffers a temporary routing failure, a retry record is created
19028 in Exim's hints database. For addresses whose routing depends only on the
19029 domain, the key for the retry record should not involve the local part, but for
19030 other addresses, both the domain and the local part should be included.
19031 Usually, remote routing is of the former kind, and local routing is of the
19032 latter kind.
19033
19034 This option controls whether the local part is used to form the key for retry
19035 hints for addresses that suffer temporary errors while being handled by this
19036 router. The default value is true for any router that has any of
19037 &%check_local_user%&,
19038 &%local_parts%&,
19039 &%condition%&,
19040 &%local_part_prefix%&,
19041 &%local_part_suffix%&,
19042 &%senders%& or
19043 &%require_files%&
19044 set, and false otherwise. Note that this option does not apply to hints keys
19045 for transport delays; they are controlled by a generic transport option of the
19046 same name.
19047
19048 Failing to set this option when it is needed
19049 (because a remote router handles only some of the local-parts for a domain)
19050 can result in incorrect error messages being generated.
19051
19052 The setting of &%retry_use_local_part%& applies only to the router on which it
19053 appears. If the router generates child addresses, they are routed
19054 independently; this setting does not become attached to them.
19055
19056
19057
19058 .option router_home_directory routers string&!! unset
19059 .cindex "router" "home directory for"
19060 .cindex "home directory" "for router"
19061 .vindex "&$home$&"
19062 This option sets a home directory for use while the router is running. (Compare
19063 &%transport_home_directory%&, which sets a home directory for later
19064 transporting.) In particular, if used on a &(redirect)& router, this option
19065 sets a value for &$home$& while a filter is running. The value is expanded;
19066 forced expansion failure causes the option to be ignored &-- other failures
19067 cause the router to defer.
19068
19069 Expansion of &%router_home_directory%& happens immediately after the
19070 &%check_local_user%& test (if configured), before any further expansions take
19071 place.
19072 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19073 are evaluated.)
19074 While the router is running, &%router_home_directory%& overrides the value of
19075 &$home$& that came from &%check_local_user%&.
19076
19077 When a router accepts an address and assigns it to a local transport (including
19078 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19079 delivery), the home directory setting for the transport is taken from the first
19080 of these values that is set:
19081
19082 .ilist
19083 The &%home_directory%& option on the transport;
19084 .next
19085 The &%transport_home_directory%& option on the router;
19086 .next
19087 The password data if &%check_local_user%& is set on the router;
19088 .next
19089 The &%router_home_directory%& option on the router.
19090 .endlist
19091
19092 In other words, &%router_home_directory%& overrides the password data for the
19093 router, but not for the transport.
19094
19095
19096
19097 .option self routers string freeze
19098 .cindex "MX record" "pointing to local host"
19099 .cindex "local host" "MX pointing to"
19100 This option applies to those routers that use a recipient address to find a
19101 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19102 and &(manualroute)& routers.
19103 Certain configurations of the &(queryprogram)& router can also specify a list
19104 of remote hosts.
19105 Usually such routers are configured to send the message to a remote host via an
19106 &(smtp)& transport. The &%self%& option specifies what happens when the first
19107 host on the list turns out to be the local host.
19108 The way in which Exim checks for the local host is described in section
19109 &<<SECTreclocipadd>>&.
19110
19111 Normally this situation indicates either an error in Exim's configuration (for
19112 example, the router should be configured not to process this domain), or an
19113 error in the DNS (for example, the MX should not point to this host). For this
19114 reason, the default action is to log the incident, defer the address, and
19115 freeze the message. The following alternatives are provided for use in special
19116 cases:
19117
19118 .vlist
19119 .vitem &%defer%&
19120 Delivery of the message is tried again later, but the message is not frozen.
19121
19122 .vitem "&%reroute%&: <&'domain'&>"
19123 The domain is changed to the given domain, and the address is passed back to
19124 be reprocessed by the routers. No rewriting of headers takes place. This
19125 behaviour is essentially a redirection.
19126
19127 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19128 The domain is changed to the given domain, and the address is passed back to be
19129 reprocessed by the routers. Any headers that contain the original domain are
19130 rewritten.
19131
19132 .vitem &%pass%&
19133 .oindex "&%more%&"
19134 .vindex "&$self_hostname$&"
19135 The router passes the address to the next router, or to the router named in the
19136 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19137 subsequent routing and delivery, the variable &$self_hostname$& contains the
19138 name of the local host that the router encountered. This can be used to
19139 distinguish between different cases for hosts with multiple names. The
19140 combination
19141 .code
19142 self = pass
19143 no_more
19144 .endd
19145 ensures that only those addresses that routed to the local host are passed on.
19146 Without &%no_more%&, addresses that were declined for other reasons would also
19147 be passed to the next router.
19148
19149 .vitem &%fail%&
19150 Delivery fails and an error report is generated.
19151
19152 .vitem &%send%&
19153 .cindex "local host" "sending to"
19154 The anomaly is ignored and the address is queued for the transport. This
19155 setting should be used with extreme caution. For an &(smtp)& transport, it
19156 makes sense only in cases where the program that is listening on the SMTP port
19157 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19158 different configuration file that handles the domain in another way.
19159 .endlist
19160
19161
19162
19163 .option senders routers&!? "address list&!!" unset
19164 .cindex "router" "checking senders"
19165 If this option is set, the router is skipped unless the message's sender
19166 address matches something on the list.
19167 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19168 are evaluated.
19169
19170 There are issues concerning verification when the running of routers is
19171 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19172 setting, it sets the sender to the null string. When using the &%-bt%& option
19173 to check a configuration file, it is necessary also to use the &%-f%& option to
19174 set an appropriate sender. For incoming mail, the sender is unset when
19175 verifying the sender, but is available when verifying any recipients. If the
19176 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19177 matters.
19178
19179
19180 .option set routers "string list" unset
19181 .cindex router variables
19182 This option may be used multiple times on a router;
19183 because of this the list aspect is mostly irrelevant.
19184 The list separator is a semicolon but can be changed in the
19185 usual way.
19186
19187 Each list-element given must be of the form &"name = value"&
19188 and the names used must start with the string &"r_"&.
19189 Values containing a list-separator should have them doubled.
19190 When a router runs, the strings are evaluated in order,
19191 to create variables which are added to the set associated with
19192 the address.
19193 The variable is set with the expansion of the value.
19194 The variables can be used by the router options
19195 (not including any preconditions)
19196 and by the transport.
19197 Later definitions of a given named variable will override former ones.
19198 Variable use is via the usual &$r_...$& syntax.
19199
19200 This is similar to the &%address_data%& option, except that
19201 many independent variables can be used, with choice of naming.
19202
19203
19204 .option translate_ip_address routers string&!! unset
19205 .cindex "IP address" "translating"
19206 .cindex "packet radio"
19207 .cindex "router" "IP address translation"
19208 There exist some rare networking situations (for example, packet radio) where
19209 it is helpful to be able to translate IP addresses generated by normal routing
19210 mechanisms into other IP addresses, thus performing a kind of manual IP
19211 routing. This should be done only if the normal IP routing of the TCP/IP stack
19212 is inadequate or broken. Because this is an extremely uncommon requirement, the
19213 code to support this option is not included in the Exim binary unless
19214 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19215
19216 .vindex "&$host_address$&"
19217 The &%translate_ip_address%& string is expanded for every IP address generated
19218 by the router, with the generated address set in &$host_address$&. If the
19219 expansion is forced to fail, no action is taken.
19220 For any other expansion error, delivery of the message is deferred.
19221 If the result of the expansion is an IP address, that replaces the original
19222 address; otherwise the result is assumed to be a host name &-- this is looked
19223 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19224 produce one or more replacement IP addresses. For example, to subvert all IP
19225 addresses in some specific networks, this could be added to a router:
19226 .code
19227 translate_ip_address = \
19228   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19229     {$value}fail}}
19230 .endd
19231 The file would contain lines like
19232 .code
19233 10.2.3.128/26    some.host
19234 10.8.4.34/26     10.44.8.15
19235 .endd
19236 You should not make use of this facility unless you really understand what you
19237 are doing.
19238
19239
19240
19241 .option transport routers string&!! unset
19242 This option specifies the transport to be used when a router accepts an address
19243 and sets it up for delivery. A transport is never needed if a router is used
19244 only for verification. The value of the option is expanded at routing time,
19245 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19246 and result must be the name of one of the configured transports. If it is not,
19247 delivery is deferred.
19248
19249 The &%transport%& option is not used by the &(redirect)& router, but it does
19250 have some private options that set up transports for pipe and file deliveries
19251 (see chapter &<<CHAPredirect>>&).
19252
19253
19254
19255 .option transport_current_directory routers string&!! unset
19256 .cindex "current directory for local transport"
19257 This option associates a current directory with any address that is routed
19258 to a local transport. This can happen either because a transport is
19259 explicitly configured for the router, or because it generates a delivery to a
19260 file or a pipe. During the delivery process (that is, at transport time), this
19261 option string is expanded and is set as the current directory, unless
19262 overridden by a setting on the transport.
19263 If the expansion fails for any reason, including forced failure, an error is
19264 logged, and delivery is deferred.
19265 See chapter &<<CHAPenvironment>>& for details of the local delivery
19266 environment.
19267
19268
19269
19270
19271 .option transport_home_directory routers string&!! "see below"
19272 .cindex "home directory" "for local transport"
19273 This option associates a home directory with any address that is routed to a
19274 local transport. This can happen either because a transport is explicitly
19275 configured for the router, or because it generates a delivery to a file or a
19276 pipe. During the delivery process (that is, at transport time), the option
19277 string is expanded and is set as the home directory, unless overridden by a
19278 setting of &%home_directory%& on the transport.
19279 If the expansion fails for any reason, including forced failure, an error is
19280 logged, and delivery is deferred.
19281
19282 If the transport does not specify a home directory, and
19283 &%transport_home_directory%& is not set for the router, the home directory for
19284 the transport is taken from the password data if &%check_local_user%& is set for
19285 the router. Otherwise it is taken from &%router_home_directory%& if that option
19286 is set; if not, no home directory is set for the transport.
19287
19288 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19289 environment.
19290
19291
19292
19293
19294 .option unseen routers boolean&!! false
19295 .cindex "router" "carrying on after success"
19296 The result of string expansion for this option must be a valid boolean value,
19297 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19298 result causes an error, and delivery is deferred. If the expansion is forced to
19299 fail, the default value for the option (false) is used. Other failures cause
19300 delivery to be deferred.
19301
19302 When this option is set true, routing does not cease if the router accepts the
19303 address. Instead, a copy of the incoming address is passed to the next router,
19304 overriding a false setting of &%more%&. There is little point in setting
19305 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19306 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19307 sometimes true and sometimes false).
19308
19309 .cindex "copy of message (&%unseen%& option)"
19310 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19311 qualifier in filter files. It can be used to cause copies of messages to be
19312 delivered to some other destination, while also carrying out a normal delivery.
19313 In effect, the current address is made into a &"parent"& that has two children
19314 &-- one that is delivered as specified by this router, and a clone that goes on
19315 to be routed further. For this reason, &%unseen%& may not be combined with the
19316 &%one_time%& option in a &(redirect)& router.
19317
19318 &*Warning*&: Header lines added to the address (or specified for removal) by
19319 this router or by previous routers affect the &"unseen"& copy of the message
19320 only. The clone that continues to be processed by further routers starts with
19321 no added headers and none specified for removal. For a &%redirect%& router, if
19322 a generated address is the same as the incoming address, this can lead to
19323 duplicate addresses with different header modifications. Exim does not do
19324 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19325 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19326 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19327 &%redirect%& router may be of help.
19328
19329 Unlike the handling of header modifications, any data that was set by the
19330 &%address_data%& option in the current or previous routers &'is'& passed on to
19331 subsequent routers.
19332
19333
19334 .option user routers string&!! "see below"
19335 .cindex "uid (user id)" "local delivery"
19336 .cindex "local transports" "uid and gid"
19337 .cindex "transport" "local"
19338 .cindex "router" "user for filter processing"
19339 .cindex "filter" "user for processing"
19340 When a router queues an address for a transport, and the transport does not
19341 specify a user, the user given here is used when running the delivery process.
19342 The user may be specified numerically or by name. If expansion fails, the
19343 error is logged and delivery is deferred.
19344 This user is also used by the &(redirect)& router when running a filter file.
19345 The default is unset, except when &%check_local_user%& is set. In this case,
19346 the default is taken from the password information. If the user is specified as
19347 a name, and &%group%& is not set, the group associated with the user is used.
19348 See also &%initgroups%& and &%group%& and the discussion in chapter
19349 &<<CHAPenvironment>>&.
19350
19351
19352
19353 .option verify routers&!? boolean true
19354 Setting this option has the effect of setting &%verify_sender%& and
19355 &%verify_recipient%& to the same value.
19356
19357
19358 .option verify_only routers&!? boolean false
19359 .cindex "EXPN" "with &%verify_only%&"
19360 .oindex "&%-bv%&"
19361 .cindex "router" "used only when verifying"
19362 If this option is set, the router is used only when verifying an address,
19363 delivering in cutthrough mode or
19364 testing with the &%-bv%& option, not when actually doing a delivery, testing
19365 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19366 restricted to verifying only senders or recipients by means of
19367 &%verify_sender%& and &%verify_recipient%&.
19368
19369 &*Warning*&: When the router is being run to verify addresses for an incoming
19370 SMTP message, Exim is not running as root, but under its own uid. If the router
19371 accesses any files, you need to make sure that they are accessible to the Exim
19372 user or group.
19373
19374
19375 .option verify_recipient routers&!? boolean true
19376 If this option is false, the router is skipped when verifying recipient
19377 addresses,
19378 delivering in cutthrough mode
19379 or testing recipient verification using &%-bv%&.
19380 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19381 are evaluated.
19382 See also the &$verify_mode$& variable.
19383
19384
19385 .option verify_sender routers&!? boolean true
19386 If this option is false, the router is skipped when verifying sender addresses
19387 or testing sender verification using &%-bvs%&.
19388 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19389 are evaluated.
19390 See also the &$verify_mode$& variable.
19391 .ecindex IIDgenoprou1
19392 .ecindex IIDgenoprou2
19393
19394
19395
19396
19397
19398
19399 . ////////////////////////////////////////////////////////////////////////////
19400 . ////////////////////////////////////////////////////////////////////////////
19401
19402 .chapter "The accept router" "CHID4"
19403 .cindex "&(accept)& router"
19404 .cindex "routers" "&(accept)&"
19405 The &(accept)& router has no private options of its own. Unless it is being
19406 used purely for verification (see &%verify_only%&) a transport is required to
19407 be defined by the generic &%transport%& option. If the preconditions that are
19408 specified by generic options are met, the router accepts the address and queues
19409 it for the given transport. The most common use of this router is for setting
19410 up deliveries to local mailboxes. For example:
19411 .code
19412 localusers:
19413   driver = accept
19414   domains = mydomain.example
19415   check_local_user
19416   transport = local_delivery
19417 .endd
19418 The &%domains%& condition in this example checks the domain of the address, and
19419 &%check_local_user%& checks that the local part is the login of a local user.
19420 When both preconditions are met, the &(accept)& router runs, and queues the
19421 address for the &(local_delivery)& transport.
19422
19423
19424
19425
19426
19427
19428 . ////////////////////////////////////////////////////////////////////////////
19429 . ////////////////////////////////////////////////////////////////////////////
19430
19431 .chapter "The dnslookup router" "CHAPdnslookup"
19432 .scindex IIDdnsrou1 "&(dnslookup)& router"
19433 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19434 The &(dnslookup)& router looks up the hosts that handle mail for the
19435 recipient's domain in the DNS. A transport must always be set for this router,
19436 unless &%verify_only%& is set.
19437
19438 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19439 SRV records. If none are found, or if SRV support is not configured,
19440 MX records are looked up. If no MX records exist, address records are sought.
19441 However, &%mx_domains%& can be set to disable the direct use of address
19442 records.
19443
19444 MX records of equal priority are sorted by Exim into a random order. Exim then
19445 looks for address records for the host names obtained from MX or SRV records.
19446 When a host has more than one IP address, they are sorted into a random order,
19447 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19448 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19449 generic option, the router declines.
19450
19451 Unless they have the highest priority (lowest MX value), MX records that point
19452 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19453 are discarded, together with any other MX records of equal or lower priority.
19454
19455 .cindex "MX record" "pointing to local host"
19456 .cindex "local host" "MX pointing to"
19457 .oindex "&%self%&" "in &(dnslookup)& router"
19458 If the host pointed to by the highest priority MX record, or looked up as an
19459 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19460 happens is controlled by the generic &%self%& option.
19461
19462
19463 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19464 There have been problems with DNS servers when SRV records are looked up.
19465 Some misbehaving servers return a DNS error or timeout when a non-existent
19466 SRV record is sought. Similar problems have in the past been reported for
19467 MX records. The global &%dns_again_means_nonexist%& option can help with this
19468 problem, but it is heavy-handed because it is a global option.
19469
19470 For this reason, there are two options, &%srv_fail_domains%& and
19471 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19472 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19473 an attempt to look up an SRV or MX record causes one of these results, and the
19474 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19475 such record"&. In the case of an SRV lookup, this means that the router
19476 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19477 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19478 case routing fails.
19479
19480
19481 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19482 .cindex "&(dnslookup)& router" "declines"
19483 There are a few cases where a &(dnslookup)& router will decline to accept
19484 an address; if such a router is expected to handle "all remaining non-local
19485 domains", then it is important to set &%no_more%&.
19486
19487 The router will defer rather than decline if the domain
19488 is found in the &%fail_defer_domains%& router option.
19489
19490 Reasons for a &(dnslookup)& router to decline currently include:
19491 .ilist
19492 The domain does not exist in DNS
19493 .next
19494 The domain exists but the MX record's host part is just "."; this is a common
19495 convention (borrowed from SRV) used to indicate that there is no such service
19496 for this domain and to not fall back to trying A/AAAA records.
19497 .next
19498 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19499 .next
19500 MX record points to a non-existent host.
19501 .next
19502 MX record points to an IP address and the main section option
19503 &%allow_mx_to_ip%& is not set.
19504 .next
19505 MX records exist and point to valid hosts, but all hosts resolve only to
19506 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19507 .next
19508 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19509 &%dns_check_names_pattern%& for handling one variant of this)
19510 .next
19511 &%check_secondary_mx%& is set on this router but the local host can
19512 not be found in the MX records (see below)
19513 .endlist
19514
19515
19516
19517
19518 .section "Private options for dnslookup" "SECID118"
19519 .cindex "options" "&(dnslookup)& router"
19520 The private options for the &(dnslookup)& router are as follows:
19521
19522 .option check_secondary_mx dnslookup boolean false
19523 .cindex "MX record" "checking for secondary"
19524 If this option is set, the router declines unless the local host is found in
19525 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19526 process domains for which the local host is a secondary mail exchanger
19527 differently to other domains. The way in which Exim decides whether a host is
19528 the local host is described in section &<<SECTreclocipadd>>&.
19529
19530
19531 .option check_srv dnslookup string&!! unset
19532 .cindex "SRV record" "enabling use of"
19533 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19534 addition to MX and address records. The support is disabled by default. To
19535 enable SRV support, set the &%check_srv%& option to the name of the service
19536 required. For example,
19537 .code
19538 check_srv = smtp
19539 .endd
19540 looks for SRV records that refer to the normal smtp service. The option is
19541 expanded, so the service name can vary from message to message or address
19542 to address. This might be helpful if SRV records are being used for a
19543 submission service. If the expansion is forced to fail, the &%check_srv%&
19544 option is ignored, and the router proceeds to look for MX records in the
19545 normal way.
19546
19547 When the expansion succeeds, the router searches first for SRV records for
19548 the given service (it assumes TCP protocol). A single SRV record with a
19549 host name that consists of just a single dot indicates &"no such service for
19550 this domain"&; if this is encountered, the router declines. If other kinds of
19551 SRV record are found, they are used to construct a host list for delivery
19552 according to the rules of RFC 2782. MX records are not sought in this case.
19553
19554 When no SRV records are found, MX records (and address records) are sought in
19555 the traditional way. In other words, SRV records take precedence over MX
19556 records, just as MX records take precedence over address records. Note that
19557 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19558 defined it. It is apparently believed that MX records are sufficient for email
19559 and that SRV records should not be used for this purpose. However, SRV records
19560 have an additional &"weight"& feature which some people might find useful when
19561 trying to split an SMTP load between hosts of different power.
19562
19563 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19564 when there is a DNS lookup error.
19565
19566
19567
19568
19569 .option fail_defer_domains dnslookup "domain list&!!" unset
19570 .cindex "MX record" "not found"
19571 DNS lookups for domains matching &%fail_defer_domains%&
19572 which find no matching record will cause the router to defer
19573 rather than the default behaviour of decline.
19574 This maybe be useful for queueing messages for a newly created
19575 domain while the DNS configuration is not ready.
19576 However, it will result in any message with mistyped domains
19577 also being queued.
19578
19579
19580 .option ipv4_only "string&!!" unset
19581 .cindex IPv6 disabling
19582 .cindex DNS "IPv6 disabling"
19583 The string is expanded, and if the result is anything but a forced failure,
19584 or an empty string, or one of the strings “0” or “no” or “false”
19585 (checked without regard to the case of the letters),
19586 only A records are used.
19587
19588 .option ipv4_prefer "string&!!" unset
19589 .cindex IPv4 preference
19590 .cindex DNS "IPv4 preference"
19591 The string is expanded, and if the result is anything but a forced failure,
19592 or an empty string, or one of the strings “0” or “no” or “false”
19593 (checked without regard to the case of the letters),
19594 A records are sorted before AAAA records (inverting the default).
19595
19596 .option mx_domains dnslookup "domain list&!!" unset
19597 .cindex "MX record" "required to exist"
19598 .cindex "SRV record" "required to exist"
19599 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19600 record in order to be recognized. (The name of this option could be improved.)
19601 For example, if all the mail hosts in &'fict.example'& are known to have MX
19602 records, except for those in &'discworld.fict.example'&, you could use this
19603 setting:
19604 .code
19605 mx_domains = ! *.discworld.fict.example : *.fict.example
19606 .endd
19607 This specifies that messages addressed to a domain that matches the list but
19608 has no MX record should be bounced immediately instead of being routed using
19609 the address record.
19610
19611
19612 .option mx_fail_domains dnslookup "domain list&!!" unset
19613 If the DNS lookup for MX records for one of the domains in this list causes a
19614 DNS lookup error, Exim behaves as if no MX records were found. See section
19615 &<<SECTprowitdnsloo>>& for more discussion.
19616
19617
19618
19619
19620 .option qualify_single dnslookup boolean true
19621 .cindex "DNS" "resolver options"
19622 .cindex "DNS" "qualifying single-component names"
19623 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19624 lookups. Typically, but not standardly, this causes the resolver to qualify
19625 single-component names with the default domain. For example, on a machine
19626 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19627 &'thesaurus.ref.example'& inside the resolver. For details of what your
19628 resolver actually does, consult your man pages for &'resolver'& and
19629 &'resolv.conf'&.
19630
19631
19632
19633 .option rewrite_headers dnslookup boolean true
19634 .cindex "rewriting" "header lines"
19635 .cindex "header lines" "rewriting"
19636 If the domain name in the address that is being processed is not fully
19637 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19638 an address is specified as &'dormouse@teaparty'&, the domain might be
19639 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19640 occur as a result of setting the &%widen_domains%& option. If
19641 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19642 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19643 header lines of the message are rewritten with the full domain name.
19644
19645 This option should be turned off only when it is known that no message is
19646 ever going to be sent outside an environment where the abbreviation makes
19647 sense.
19648
19649 When an MX record is looked up in the DNS and matches a wildcard record, name
19650 servers normally return a record containing the name that has been looked up,
19651 making it impossible to detect whether a wildcard was present or not. However,
19652 some name servers have recently been seen to return the wildcard entry. If the
19653 name returned by a DNS lookup begins with an asterisk, it is not used for
19654 header rewriting.
19655
19656
19657 .option same_domain_copy_routing dnslookup boolean false
19658 .cindex "address" "copying routing"
19659 Addresses with the same domain are normally routed by the &(dnslookup)& router
19660 to the same list of hosts. However, this cannot be presumed, because the router
19661 options and preconditions may refer to the local part of the address. By
19662 default, therefore, Exim routes each address in a message independently. DNS
19663 servers run caches, so repeated DNS lookups are not normally expensive, and in
19664 any case, personal messages rarely have more than a few recipients.
19665
19666 If you are running mailing lists with large numbers of subscribers at the same
19667 domain, and you are using a &(dnslookup)& router which is independent of the
19668 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19669 lookups for identical domains in one message. In this case, when &(dnslookup)&
19670 routes an address to a remote transport, any other unrouted addresses in the
19671 message that have the same domain are automatically given the same routing
19672 without processing them independently,
19673 provided the following conditions are met:
19674
19675 .ilist
19676 No router that processed the address specified &%headers_add%& or
19677 &%headers_remove%&.
19678 .next
19679 The router did not change the address in any way, for example, by &"widening"&
19680 the domain.
19681 .endlist
19682
19683
19684
19685
19686 .option search_parents dnslookup boolean false
19687 .cindex "DNS" "resolver options"
19688 When this option is true, the resolver option RES_DNSRCH is set for DNS
19689 lookups. This is different from the &%qualify_single%& option in that it
19690 applies to domains containing dots. Typically, but not standardly, it causes
19691 the resolver to search for the name in the current domain and in parent
19692 domains. For example, on a machine in the &'fict.example'& domain, if looking
19693 up &'teaparty.wonderland'& failed, the resolver would try
19694 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19695 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19696
19697 Setting this option true can cause problems in domains that have a wildcard MX
19698 record, because any domain that does not have its own MX record matches the
19699 local wildcard.
19700
19701
19702
19703 .option srv_fail_domains dnslookup "domain list&!!" unset
19704 If the DNS lookup for SRV records for one of the domains in this list causes a
19705 DNS lookup error, Exim behaves as if no SRV records were found. See section
19706 &<<SECTprowitdnsloo>>& for more discussion.
19707
19708
19709
19710
19711 .option widen_domains dnslookup "string list" unset
19712 .cindex "domain" "partial; widening"
19713 If a DNS lookup fails and this option is set, each of its strings in turn is
19714 added onto the end of the domain, and the lookup is tried again. For example,
19715 if
19716 .code
19717 widen_domains = fict.example:ref.example
19718 .endd
19719 is set and a lookup of &'klingon.dictionary'& fails,
19720 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19721 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19722 and &%search_parents%& options can cause some widening to be undertaken inside
19723 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19724 when verifying, unless &%rewrite_headers%& is false (not the default).
19725
19726
19727 .section "Effect of qualify_single and search_parents" "SECID119"
19728 When a domain from an envelope recipient is changed by the resolver as a result
19729 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19730 corresponding address in the message's header lines unless &%rewrite_headers%&
19731 is set false. Exim then re-routes the address, using the full domain.
19732
19733 These two options affect only the DNS lookup that takes place inside the router
19734 for the domain of the address that is being routed. They do not affect lookups
19735 such as that implied by
19736 .code
19737 domains = @mx_any
19738 .endd
19739 that may happen while processing a router precondition before the router is
19740 entered. No widening ever takes place for these lookups.
19741 .ecindex IIDdnsrou1
19742 .ecindex IIDdnsrou2
19743
19744
19745
19746
19747
19748
19749
19750
19751
19752 . ////////////////////////////////////////////////////////////////////////////
19753 . ////////////////////////////////////////////////////////////////////////////
19754
19755 .chapter "The ipliteral router" "CHID5"
19756 .cindex "&(ipliteral)& router"
19757 .cindex "domain literal" "routing"
19758 .cindex "routers" "&(ipliteral)&"
19759 This router has no private options. Unless it is being used purely for
19760 verification (see &%verify_only%&) a transport is required to be defined by the
19761 generic &%transport%& option. The router accepts the address if its domain part
19762 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19763 router handles the address
19764 .code
19765 root@[192.168.1.1]
19766 .endd
19767 by setting up delivery to the host with that IP address. IPv4 domain literals
19768 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19769 are similar, but the address is preceded by &`ipv6:`&. For example:
19770 .code
19771 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19772 .endd
19773 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19774 grounds that sooner or later somebody will try it.
19775
19776 .oindex "&%self%&" "in &(ipliteral)& router"
19777 If the IP address matches something in &%ignore_target_hosts%&, the router
19778 declines. If an IP literal turns out to refer to the local host, the generic
19779 &%self%& option determines what happens.
19780
19781 The RFCs require support for domain literals; however, their use is
19782 controversial in today's Internet. If you want to use this router, you must
19783 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19784 Exim will not recognize the domain literal syntax in addresses.
19785
19786
19787
19788 . ////////////////////////////////////////////////////////////////////////////
19789 . ////////////////////////////////////////////////////////////////////////////
19790
19791 .chapter "The iplookup router" "CHID6"
19792 .cindex "&(iplookup)& router"
19793 .cindex "routers" "&(iplookup)&"
19794 The &(iplookup)& router was written to fulfil a specific requirement in
19795 Cambridge University (which in fact no longer exists). For this reason, it is
19796 not included in the binary of Exim by default. If you want to include it, you
19797 must set
19798 .code
19799 ROUTER_IPLOOKUP=yes
19800 .endd
19801 in your &_Local/Makefile_& configuration file.
19802
19803 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19804 connection to one or more specific hosts. The host can then return the same or
19805 a different address &-- in effect rewriting the recipient address in the
19806 message's envelope. The new address is then passed on to subsequent routers. If
19807 this process fails, the address can be passed on to other routers, or delivery
19808 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19809 must not be specified for it.
19810
19811 .cindex "options" "&(iplookup)& router"
19812 .option hosts iplookup string unset
19813 This option must be supplied. Its value is a colon-separated list of host
19814 names. The hosts are looked up using &[gethostbyname()]&
19815 (or &[getipnodebyname()]& when available)
19816 and are tried in order until one responds to the query. If none respond, what
19817 happens is controlled by &%optional%&.
19818
19819
19820 .option optional iplookup boolean false
19821 If &%optional%& is true, if no response is obtained from any host, the address
19822 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19823 delivery to the address is deferred.
19824
19825
19826 .option port iplookup integer 0
19827 .cindex "port" "&(iplookup)& router"
19828 This option must be supplied. It specifies the port number for the TCP or UDP
19829 call.
19830
19831
19832 .option protocol iplookup string udp
19833 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19834 protocols is to be used.
19835
19836
19837 .option query iplookup string&!! "see below"
19838 This defines the content of the query that is sent to the remote hosts. The
19839 default value is:
19840 .code
19841 $local_part@$domain $local_part@$domain
19842 .endd
19843 The repetition serves as a way of checking that a response is to the correct
19844 query in the default case (see &%response_pattern%& below).
19845
19846
19847 .option reroute iplookup string&!! unset
19848 If this option is not set, the rerouted address is precisely the byte string
19849 returned by the remote host, up to the first white space, if any. If set, the
19850 string is expanded to form the rerouted address. It can include parts matched
19851 in the response by &%response_pattern%& by means of numeric variables such as
19852 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19853 whether or not a pattern is in use. In all cases, the rerouted address must end
19854 up in the form &'local_part@domain'&.
19855
19856
19857 .option response_pattern iplookup string unset
19858 This option can be set to a regular expression that is applied to the string
19859 returned from the remote host. If the pattern does not match the response, the
19860 router declines. If &%response_pattern%& is not set, no checking of the
19861 response is done, unless the query was defaulted, in which case there is a
19862 check that the text returned after the first white space is the original
19863 address. This checks that the answer that has been received is in response to
19864 the correct question. For example, if the response is just a new domain, the
19865 following could be used:
19866 .code
19867 response_pattern = ^([^@]+)$
19868 reroute = $local_part@$1
19869 .endd
19870
19871 .option timeout iplookup time 5s
19872 This specifies the amount of time to wait for a response from the remote
19873 machine. The same timeout is used for the &[connect()]& function for a TCP
19874 call. It does not apply to UDP.
19875
19876
19877
19878
19879 . ////////////////////////////////////////////////////////////////////////////
19880 . ////////////////////////////////////////////////////////////////////////////
19881
19882 .chapter "The manualroute router" "CHID7"
19883 .scindex IIDmanrou1 "&(manualroute)& router"
19884 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19885 .cindex "domain" "manually routing"
19886 The &(manualroute)& router is so-called because it provides a way of manually
19887 routing an address according to its domain. It is mainly used when you want to
19888 route addresses to remote hosts according to your own rules, bypassing the
19889 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19890 route to local transports, a facility that may be useful if you want to save
19891 messages for dial-in hosts in local files.
19892
19893 The &(manualroute)& router compares a list of domain patterns with the domain
19894 it is trying to route. If there is no match, the router declines. Each pattern
19895 has associated with it a list of hosts and some other optional data, which may
19896 include a transport. The combination of a pattern and its data is called a
19897 &"routing rule"&. For patterns that do not have an associated transport, the
19898 generic &%transport%& option must specify a transport, unless the router is
19899 being used purely for verification (see &%verify_only%&).
19900
19901 .vindex "&$host$&"
19902 In the case of verification, matching the domain pattern is sufficient for the
19903 router to accept the address. When actually routing an address for delivery,
19904 an address that matches a domain pattern is queued for the associated
19905 transport. If the transport is not a local one, a host list must be associated
19906 with the pattern; IP addresses are looked up for the hosts, and these are
19907 passed to the transport along with the mail address. For local transports, a
19908 host list is optional. If it is present, it is passed in &$host$& as a single
19909 text string.
19910
19911 The list of routing rules can be provided as an inline string in
19912 &%route_list%&, or the data can be obtained by looking up the domain in a file
19913 or database by setting &%route_data%&. Only one of these settings may appear in
19914 any one instance of &(manualroute)&. The format of routing rules is described
19915 below, following the list of private options.
19916
19917
19918 .section "Private options for manualroute" "SECTprioptman"
19919
19920 .cindex "options" "&(manualroute)& router"
19921 The private options for the &(manualroute)& router are as follows:
19922
19923 .option host_all_ignored manualroute string defer
19924 See &%host_find_failed%&.
19925
19926 .option host_find_failed manualroute string freeze
19927 This option controls what happens when &(manualroute)& tries to find an IP
19928 address for a host, and the host does not exist. The option can be set to one
19929 of the following values:
19930 .code
19931 decline
19932 defer
19933 fail
19934 freeze
19935 ignore
19936 pass
19937 .endd
19938 The default (&"freeze"&) assumes that this state is a serious configuration
19939 error. The difference between &"pass"& and &"decline"& is that the former
19940 forces the address to be passed to the next router (or the router defined by
19941 &%pass_router%&),
19942 .oindex "&%more%&"
19943 overriding &%no_more%&, whereas the latter passes the address to the next
19944 router only if &%more%& is true.
19945
19946 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19947 cannot be found. If all the hosts in the list are ignored, the behaviour is
19948 controlled by the &%host_all_ignored%& option. This takes the same values
19949 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19950
19951 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19952 state; if a host lookup gets a temporary error, delivery is deferred unless the
19953 generic &%pass_on_timeout%& option is set.
19954
19955
19956 .option hosts_randomize manualroute boolean false
19957 .cindex "randomized host list"
19958 .cindex "host" "list of; randomized"
19959 If this option is set, the order of the items in a host list in a routing rule
19960 is randomized each time the list is used, unless an option in the routing rule
19961 overrides (see below). Randomizing the order of a host list can be used to do
19962 crude load sharing. However, if more than one mail address is routed by the
19963 same router to the same host list, the host lists are considered to be the same
19964 (even though they may be randomized into different orders) for the purpose of
19965 deciding whether to batch the deliveries into a single SMTP transaction.
19966
19967 When &%hosts_randomize%& is true, a host list may be split
19968 into groups whose order is separately randomized. This makes it possible to
19969 set up MX-like behaviour. The boundaries between groups are indicated by an
19970 item that is just &`+`& in the host list. For example:
19971 .code
19972 route_list = * host1:host2:host3:+:host4:host5
19973 .endd
19974 The order of the first three hosts and the order of the last two hosts is
19975 randomized for each use, but the first three always end up before the last two.
19976 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19977 randomized host list is passed to an &(smtp)& transport that also has
19978 &%hosts_randomize set%&, the list is not re-randomized.
19979
19980
19981 .option route_data manualroute string&!! unset
19982 If this option is set, it must expand to yield the data part of a routing rule.
19983 Typically, the expansion string includes a lookup based on the domain. For
19984 example:
19985 .code
19986 route_data = ${lookup{$domain}dbm{/etc/routes}}
19987 .endd
19988 If the expansion is forced to fail, or the result is an empty string, the
19989 router declines. Other kinds of expansion failure cause delivery to be
19990 deferred.
19991
19992
19993 .option route_list manualroute "string list" unset
19994 This string is a list of routing rules, in the form defined below. Note that,
19995 unlike most string lists, the items are separated by semicolons. This is so
19996 that they may contain colon-separated host lists.
19997
19998
19999 .option same_domain_copy_routing manualroute boolean false
20000 .cindex "address" "copying routing"
20001 Addresses with the same domain are normally routed by the &(manualroute)&
20002 router to the same list of hosts. However, this cannot be presumed, because the
20003 router options and preconditions may refer to the local part of the address. By
20004 default, therefore, Exim routes each address in a message independently. DNS
20005 servers run caches, so repeated DNS lookups are not normally expensive, and in
20006 any case, personal messages rarely have more than a few recipients.
20007
20008 If you are running mailing lists with large numbers of subscribers at the same
20009 domain, and you are using a &(manualroute)& router which is independent of the
20010 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20011 lookups for identical domains in one message. In this case, when
20012 &(manualroute)& routes an address to a remote transport, any other unrouted
20013 addresses in the message that have the same domain are automatically given the
20014 same routing without processing them independently. However, this is only done
20015 if &%headers_add%& and &%headers_remove%& are unset.
20016
20017
20018
20019
20020 .section "Routing rules in route_list" "SECID120"
20021 The value of &%route_list%& is a string consisting of a sequence of routing
20022 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20023 entered as two semicolons. Alternatively, the list separator can be changed as
20024 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20025 Empty rules are ignored. The format of each rule is
20026 .display
20027 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20028 .endd
20029 The following example contains two rules, each with a simple domain pattern and
20030 no options:
20031 .code
20032 route_list = \
20033   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20034   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20035 .endd
20036 The three parts of a rule are separated by white space. The pattern and the
20037 list of hosts can be enclosed in quotes if necessary, and if they are, the
20038 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20039 single domain pattern, which is the only mandatory item in the rule. The
20040 pattern is in the same format as one item in a domain list (see section
20041 &<<SECTdomainlist>>&),
20042 except that it may not be the name of an interpolated file.
20043 That is, it may be wildcarded, or a regular expression, or a file or database
20044 lookup (with semicolons doubled, because of the use of semicolon as a separator
20045 in a &%route_list%&).
20046
20047 The rules in &%route_list%& are searched in order until one of the patterns
20048 matches the domain that is being routed. The list of hosts and then options are
20049 then used as described below. If there is no match, the router declines. When
20050 &%route_list%& is set, &%route_data%& must not be set.
20051
20052
20053
20054 .section "Routing rules in route_data" "SECID121"
20055 The use of &%route_list%& is convenient when there are only a small number of
20056 routing rules. For larger numbers, it is easier to use a file or database to
20057 hold the routing information, and use the &%route_data%& option instead.
20058 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20059 Most commonly, &%route_data%& is set as a string that contains an
20060 expansion lookup. For example, suppose we place two routing rules in a file
20061 like this:
20062 .code
20063 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20064 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20065 .endd
20066 This data can be accessed by setting
20067 .code
20068 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20069 .endd
20070 Failure of the lookup results in an empty string, causing the router to
20071 decline. However, you do not have to use a lookup in &%route_data%&. The only
20072 requirement is that the result of expanding the string is a list of hosts,
20073 possibly followed by options, separated by white space. The list of hosts must
20074 be enclosed in quotes if it contains white space.
20075
20076
20077
20078
20079 .section "Format of the list of hosts" "SECID122"
20080 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20081 always separately expanded before use. If the expansion fails, the router
20082 declines. The result of the expansion must be a colon-separated list of names
20083 and/or IP addresses, optionally also including ports.
20084 If the list is written with spaces, it must be protected with quotes.
20085 The format of each item
20086 in the list is described in the next section. The list separator can be changed
20087 as described in section &<<SECTlistsepchange>>&.
20088
20089 If the list of hosts was obtained from a &%route_list%& item, the following
20090 variables are set during its expansion:
20091
20092 .ilist
20093 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20094 If the domain was matched against a regular expression, the numeric variables
20095 &$1$&, &$2$&, etc. may be set. For example:
20096 .code
20097 route_list = ^domain(\d+)   host-$1.text.example
20098 .endd
20099 .next
20100 &$0$& is always set to the entire domain.
20101 .next
20102 &$1$& is also set when partial matching is done in a file lookup.
20103
20104 .next
20105 .vindex "&$value$&"
20106 If the pattern that matched the domain was a lookup item, the data that was
20107 looked up is available in the expansion variable &$value$&. For example:
20108 .code
20109 route_list = lsearch;;/some/file.routes  $value
20110 .endd
20111 .endlist
20112
20113 Note the doubling of the semicolon in the pattern that is necessary because
20114 semicolon is the default route list separator.
20115
20116
20117
20118 .section "Format of one host item" "SECTformatonehostitem"
20119 Each item in the list of hosts is either a host name or an IP address,
20120 optionally with an attached port number. When no port is given, an IP address
20121 is not enclosed in brackets. When a port is specified, it overrides the port
20122 specification on the transport. The port is separated from the name or address
20123 by a colon. This leads to some complications:
20124
20125 .ilist
20126 Because colon is the default separator for the list of hosts, either
20127 the colon that specifies a port must be doubled, or the list separator must
20128 be changed. The following two examples have the same effect:
20129 .code
20130 route_list = * "host1.tld::1225 : host2.tld::1226"
20131 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20132 .endd
20133 .next
20134 When IPv6 addresses are involved, it gets worse, because they contain
20135 colons of their own. To make this case easier, it is permitted to
20136 enclose an IP address (either v4 or v6) in square brackets if a port
20137 number follows. For example:
20138 .code
20139 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20140 .endd
20141 .endlist
20142
20143 .section "How the list of hosts is used" "SECThostshowused"
20144 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20145 the hosts is tried, in the order specified, when carrying out the SMTP
20146 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20147 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20148 transport.
20149
20150 Hosts may be listed by name or by IP address. An unadorned name in the list of
20151 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20152 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20153 records in the DNS. For example:
20154 .code
20155 route_list = *  x.y.z:p.q.r/MX:e.f.g
20156 .endd
20157 If this feature is used with a port specifier, the port must come last. For
20158 example:
20159 .code
20160 route_list = *  dom1.tld/mx::1225
20161 .endd
20162 If the &%hosts_randomize%& option is set, the order of the items in the list is
20163 randomized before any lookups are done. Exim then scans the list; for any name
20164 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20165 be an interface on the local host and the item is not the first in the list,
20166 Exim discards it and any subsequent items. If it is the first item, what
20167 happens is controlled by the
20168 .oindex "&%self%&" "in &(manualroute)& router"
20169 &%self%& option of the router.
20170
20171 A name on the list that is followed by &`/MX`& is replaced with the list of
20172 hosts obtained by looking up MX records for the name. This is always a DNS
20173 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20174 below) are not relevant here. The order of these hosts is determined by the
20175 preference values in the MX records, according to the usual rules. Because
20176 randomizing happens before the MX lookup, it does not affect the order that is
20177 defined by MX preferences.
20178
20179 If the local host is present in the sublist obtained from MX records, but is
20180 not the most preferred host in that list, it and any equally or less
20181 preferred hosts are removed before the sublist is inserted into the main list.
20182
20183 If the local host is the most preferred host in the MX list, what happens
20184 depends on where in the original list of hosts the &`/MX`& item appears. If it
20185 is not the first item (that is, there are previous hosts in the main list),
20186 Exim discards this name and any subsequent items in the main list.
20187
20188 If the MX item is first in the list of hosts, and the local host is the
20189 most preferred host, what happens is controlled by the &%self%& option of the
20190 router.
20191
20192 DNS failures when lookup up the MX records are treated in the same way as DNS
20193 failures when looking up IP addresses: &%pass_on_timeout%& and
20194 &%host_find_failed%& are used when relevant.
20195
20196 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20197 whether obtained from an MX lookup or not.
20198
20199
20200
20201 .section "How the options are used" "SECThowoptused"
20202 The options are a sequence of words, space-separated.
20203 One of the words can be the name of a transport; this overrides the
20204 &%transport%& option on the router for this particular routing rule only. The
20205 other words (if present) control randomization of the list of hosts on a
20206 per-rule basis, and how the IP addresses of the hosts are to be found when
20207 routing to a remote transport. These options are as follows:
20208
20209 .ilist
20210 &%randomize%&: randomize the order of the hosts in this list, overriding the
20211 setting of &%hosts_randomize%& for this routing rule only.
20212 .next
20213 &%no_randomize%&: do not randomize the order of the hosts in this list,
20214 overriding the setting of &%hosts_randomize%& for this routing rule only.
20215 .next
20216 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20217 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20218 also look in &_/etc/hosts_& or other sources of information.
20219 .next
20220 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20221 no address records are found. If there is a temporary DNS error (such as a
20222 timeout), delivery is deferred.
20223 .next
20224 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20225 .next
20226 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20227 .endlist
20228
20229 For example:
20230 .code
20231 route_list = domain1  host1:host2:host3  randomize bydns;\
20232              domain2  host4:host5
20233 .endd
20234 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20235 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20236 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20237 or &[gethostbyname()]&, and the result of the lookup is the result of that
20238 call.
20239
20240 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20241 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20242 instead of TRY_AGAIN. That is why the default action is to try a DNS
20243 lookup first. Only if that gives a definite &"no such host"& is the local
20244 function called.
20245
20246 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20247 inadvertent constraint that a transport name as an option had to be the last
20248 option specified.
20249
20250
20251
20252 If no IP address for a host can be found, what happens is controlled by the
20253 &%host_find_failed%& option.
20254
20255 .vindex "&$host$&"
20256 When an address is routed to a local transport, IP addresses are not looked up.
20257 The host list is passed to the transport in the &$host$& variable.
20258
20259
20260
20261 .section "Manualroute examples" "SECID123"
20262 In some of the examples that follow, the presence of the &%remote_smtp%&
20263 transport, as defined in the default configuration file, is assumed:
20264
20265 .ilist
20266 .cindex "smart host" "example router"
20267 The &(manualroute)& router can be used to forward all external mail to a
20268 &'smart host'&. If you have set up, in the main part of the configuration, a
20269 named domain list that contains your local domains, for example:
20270 .code
20271 domainlist local_domains = my.domain.example
20272 .endd
20273 You can arrange for all other domains to be routed to a smart host by making
20274 your first router something like this:
20275 .code
20276 smart_route:
20277   driver = manualroute
20278   domains = !+local_domains
20279   transport = remote_smtp
20280   route_list = * smarthost.ref.example
20281 .endd
20282 This causes all non-local addresses to be sent to the single host
20283 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20284 they are tried in order
20285 (but you can use &%hosts_randomize%& to vary the order each time).
20286 Another way of configuring the same thing is this:
20287 .code
20288 smart_route:
20289   driver = manualroute
20290   transport = remote_smtp
20291   route_list = !+local_domains  smarthost.ref.example
20292 .endd
20293 There is no difference in behaviour between these two routers as they stand.
20294 However, they behave differently if &%no_more%& is added to them. In the first
20295 example, the router is skipped if the domain does not match the &%domains%&
20296 precondition; the following router is always tried. If the router runs, it
20297 always matches the domain and so can never decline. Therefore, &%no_more%&
20298 would have no effect. In the second case, the router is never skipped; it
20299 always runs. However, if it doesn't match the domain, it declines. In this case
20300 &%no_more%& would prevent subsequent routers from running.
20301
20302 .next
20303 .cindex "mail hub example"
20304 A &'mail hub'& is a host which receives mail for a number of domains via MX
20305 records in the DNS and delivers it via its own private routing mechanism. Often
20306 the final destinations are behind a firewall, with the mail hub being the one
20307 machine that can connect to machines both inside and outside the firewall. The
20308 &(manualroute)& router is usually used on a mail hub to route incoming messages
20309 to the correct hosts. For a small number of domains, the routing can be inline,
20310 using the &%route_list%& option, but for a larger number a file or database
20311 lookup is easier to manage.
20312
20313 If the domain names are in fact the names of the machines to which the mail is
20314 to be sent by the mail hub, the configuration can be quite simple. For
20315 example:
20316 .code
20317 hub_route:
20318   driver = manualroute
20319   transport = remote_smtp
20320   route_list = *.rhodes.tvs.example  $domain
20321 .endd
20322 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20323 whose names are the same as the mail domains. A similar approach can be taken
20324 if the host name can be obtained from the domain name by a string manipulation
20325 that the expansion facilities can handle. Otherwise, a lookup based on the
20326 domain can be used to find the host:
20327 .code
20328 through_firewall:
20329   driver = manualroute
20330   transport = remote_smtp
20331   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20332 .endd
20333 The result of the lookup must be the name or IP address of the host (or
20334 hosts) to which the address is to be routed. If the lookup fails, the route
20335 data is empty, causing the router to decline. The address then passes to the
20336 next router.
20337
20338 .next
20339 .cindex "batched SMTP output example"
20340 .cindex "SMTP" "batched outgoing; example"
20341 You can use &(manualroute)& to deliver messages to pipes or files in batched
20342 SMTP format for onward transportation by some other means. This is one way of
20343 storing mail for a dial-up host when it is not connected. The route list entry
20344 can be as simple as a single domain name in a configuration like this:
20345 .code
20346 save_in_file:
20347   driver = manualroute
20348   transport = batchsmtp_appendfile
20349   route_list = saved.domain.example
20350 .endd
20351 though often a pattern is used to pick up more than one domain. If there are
20352 several domains or groups of domains with different transport requirements,
20353 different transports can be listed in the routing information:
20354 .code
20355 save_in_file:
20356   driver = manualroute
20357   route_list = \
20358     *.saved.domain1.example  $domain  batch_appendfile; \
20359     *.saved.domain2.example  \
20360       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20361       batch_pipe
20362 .endd
20363 .vindex "&$domain$&"
20364 .vindex "&$host$&"
20365 The first of these just passes the domain in the &$host$& variable, which
20366 doesn't achieve much (since it is also in &$domain$&), but the second does a
20367 file lookup to find a value to pass, causing the router to decline to handle
20368 the address if the lookup fails.
20369
20370 .next
20371 .cindex "UUCP" "example of router for"
20372 Routing mail directly to UUCP software is a specific case of the use of
20373 &(manualroute)& in a gateway to another mail environment. This is an example of
20374 one way it can be done:
20375 .code
20376 # Transport
20377 uucp:
20378   driver = pipe
20379   user = nobody
20380   command = /usr/local/bin/uux -r - \
20381     ${substr_-5:$host}!rmail ${local_part}
20382   return_fail_output = true
20383
20384 # Router
20385 uucphost:
20386   transport = uucp
20387   driver = manualroute
20388   route_data = \
20389     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20390 .endd
20391 The file &_/usr/local/exim/uucphosts_& contains entries like
20392 .code
20393 darksite.ethereal.example:           darksite.UUCP
20394 .endd
20395 It can be set up more simply without adding and removing &".UUCP"& but this way
20396 makes clear the distinction between the domain name
20397 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20398 .endlist
20399 .ecindex IIDmanrou1
20400 .ecindex IIDmanrou2
20401
20402
20403
20404
20405
20406
20407
20408
20409 . ////////////////////////////////////////////////////////////////////////////
20410 . ////////////////////////////////////////////////////////////////////////////
20411
20412 .chapter "The queryprogram router" "CHAPdriverlast"
20413 .scindex IIDquerou1 "&(queryprogram)& router"
20414 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20415 .cindex "routing" "by external program"
20416 The &(queryprogram)& router routes an address by running an external command
20417 and acting on its output. This is an expensive way to route, and is intended
20418 mainly for use in lightly-loaded systems, or for performing experiments.
20419 However, if it is possible to use the precondition options (&%domains%&,
20420 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20421 be used in special cases, even on a busy host. There are the following private
20422 options:
20423 .cindex "options" "&(queryprogram)& router"
20424
20425 .option command queryprogram string&!! unset
20426 This option must be set. It specifies the command that is to be run. The
20427 command is split up into a command name and arguments, and then each is
20428 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20429 &<<CHAPpipetransport>>&).
20430
20431
20432 .option command_group queryprogram string unset
20433 .cindex "gid (group id)" "in &(queryprogram)& router"
20434 This option specifies a gid to be set when running the command while routing an
20435 address for deliver. It must be set if &%command_user%& specifies a numerical
20436 uid. If it begins with a digit, it is interpreted as the numerical value of the
20437 gid. Otherwise it is looked up using &[getgrnam()]&.
20438
20439
20440 .option command_user queryprogram string unset
20441 .cindex "uid (user id)" "for &(queryprogram)&"
20442 This option must be set. It specifies the uid which is set when running the
20443 command while routing an address for delivery. If the value begins with a digit,
20444 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20445 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20446 not set, a value for the gid also.
20447
20448 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20449 root, which it does during a normal delivery in a conventional configuration.
20450 However, when an address is being verified during message reception, Exim is
20451 usually running as the Exim user, not as root. If the &(queryprogram)& router
20452 is called from a non-root process, Exim cannot change uid or gid before running
20453 the command. In this circumstance the command runs under the current uid and
20454 gid.
20455
20456
20457 .option current_directory queryprogram string /
20458 This option specifies an absolute path which is made the current directory
20459 before running the command.
20460
20461
20462 .option timeout queryprogram time 1h
20463 If the command does not complete within the timeout period, its process group
20464 is killed and the message is frozen. A value of zero time specifies no
20465 timeout.
20466
20467
20468 The standard output of the command is connected to a pipe, which is read when
20469 the command terminates. It should consist of a single line of output,
20470 containing up to five fields, separated by white space. The maximum length of
20471 the line is 1023 characters. Longer lines are silently truncated. The first
20472 field is one of the following words (case-insensitive):
20473
20474 .ilist
20475 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20476 below).
20477 .next
20478 &'Decline'&: the router declines; pass the address to the next router, unless
20479 &%no_more%& is set.
20480 .next
20481 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20482 subsequent text on the line is an error message. If the router is run as part
20483 of address verification during an incoming SMTP message, the message is
20484 included in the SMTP response.
20485 .next
20486 &'Defer'&: routing could not be completed at this time; try again later. Any
20487 subsequent text on the line is an error message which is logged. It is not
20488 included in any SMTP response.
20489 .next
20490 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20491 .next
20492 &'Pass'&: pass the address to the next router (or the router specified by
20493 &%pass_router%&), overriding &%no_more%&.
20494 .next
20495 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20496 new addresses, which are routed independently, starting with the first router,
20497 or the router specified by &%redirect_router%&, if set.
20498 .endlist
20499
20500 When the first word is &'accept'&, the remainder of the line consists of a
20501 number of keyed data values, as follows (split into two lines here, to fit on
20502 the page):
20503 .code
20504 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20505 LOOKUP=byname|bydns DATA=<text>
20506 .endd
20507 The data items can be given in any order, and all are optional. If no transport
20508 is included, the transport specified by the generic &%transport%& option is
20509 used. The list of hosts and the lookup type are needed only if the transport is
20510 an &(smtp)& transport that does not itself supply a list of hosts.
20511
20512 The format of the list of hosts is the same as for the &(manualroute)& router.
20513 As well as host names and IP addresses with optional port numbers, as described
20514 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20515 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20516 (see section &<<SECThostshowused>>&).
20517
20518 If the lookup type is not specified, Exim behaves as follows when trying to
20519 find an IP address for each host: First, a DNS lookup is done. If this yields
20520 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20521 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20522 result of the lookup is the result of that call.
20523
20524 .vindex "&$address_data$&"
20525 If the DATA field is set, its value is placed in the &$address_data$&
20526 variable. For example, this return line
20527 .code
20528 accept hosts=x1.y.example:x2.y.example data="rule1"
20529 .endd
20530 routes the address to the default transport, passing a list of two hosts. When
20531 the transport runs, the string &"rule1"& is in &$address_data$&.
20532 .ecindex IIDquerou1
20533 .ecindex IIDquerou2
20534
20535
20536
20537
20538 . ////////////////////////////////////////////////////////////////////////////
20539 . ////////////////////////////////////////////////////////////////////////////
20540
20541 .chapter "The redirect router" "CHAPredirect"
20542 .scindex IIDredrou1 "&(redirect)& router"
20543 .scindex IIDredrou2 "routers" "&(redirect)&"
20544 .cindex "alias file" "in a &(redirect)& router"
20545 .cindex "address redirection" "&(redirect)& router"
20546 The &(redirect)& router handles several kinds of address redirection. Its most
20547 common uses are for resolving local part aliases from a central alias file
20548 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20549 files, but it has many other potential uses. The incoming address can be
20550 redirected in several different ways:
20551
20552 .ilist
20553 It can be replaced by one or more new addresses which are themselves routed
20554 independently.
20555 .next
20556 It can be routed to be delivered to a given file or directory.
20557 .next
20558 It can be routed to be delivered to a specified pipe command.
20559 .next
20560 It can cause an automatic reply to be generated.
20561 .next
20562 It can be forced to fail, optionally with a custom error message.
20563 .next
20564 It can be temporarily deferred, optionally with a custom message.
20565 .next
20566 It can be discarded.
20567 .endlist
20568
20569 The generic &%transport%& option must not be set for &(redirect)& routers.
20570 However, there are some private options which define transports for delivery to
20571 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20572 &%pipe_transport%& and &%reply_transport%& descriptions below.
20573
20574 If success DSNs have been requested
20575 .cindex "DSN" "success"
20576 .cindex "Delivery Status Notification" "success"
20577 redirection triggers one and the DSN options are not passed any further.
20578
20579
20580
20581 .section "Redirection data" "SECID124"
20582 The router operates by interpreting a text string which it obtains either by
20583 expanding the contents of the &%data%& option, or by reading the entire
20584 contents of a file whose name is given in the &%file%& option. These two
20585 options are mutually exclusive. The first is commonly used for handling system
20586 aliases, in a configuration like this:
20587 .code
20588 system_aliases:
20589   driver = redirect
20590   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20591 .endd
20592 If the lookup fails, the expanded string in this example is empty. When the
20593 expansion of &%data%& results in an empty string, the router declines. A forced
20594 expansion failure also causes the router to decline; other expansion failures
20595 cause delivery to be deferred.
20596
20597 A configuration using &%file%& is commonly used for handling users'
20598 &_.forward_& files, like this:
20599 .code
20600 userforward:
20601   driver = redirect
20602   check_local_user
20603   file = $home/.forward
20604   no_verify
20605 .endd
20606 If the file does not exist, or causes no action to be taken (for example, it is
20607 empty or consists only of comments), the router declines. &*Warning*&: This
20608 is not the case when the file contains syntactically valid items that happen to
20609 yield empty addresses, for example, items containing only RFC 2822 address
20610 comments.
20611
20612 .new
20613 .cindex "tainted data" "in filenames"
20614 .cindex redirect "tainted data"
20615 Tainted data may not be used for a filename.
20616
20617 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20618 directly for redirection,
20619 as they are provided by a potential attacker.
20620 In the examples above, &$local_part$& is used for looking up data held locally
20621 on the system, and not used directly (the second example derives &$home$& via
20622 the passsword file or database, using &$local_part$&).
20623 .wen
20624
20625
20626
20627 .section "Forward files and address verification" "SECID125"
20628 .cindex "address redirection" "while verifying"
20629 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20630 &_.forward_& files, as in the example above. There are two reasons for this:
20631
20632 .ilist
20633 When Exim is receiving an incoming SMTP message from a remote host, it is
20634 running under the Exim uid, not as root. Exim is unable to change uid to read
20635 the file as the user, and it may not be able to read it as the Exim user. So in
20636 practice the router may not be able to operate.
20637 .next
20638 However, even when the router can operate, the existence of a &_.forward_& file
20639 is unimportant when verifying an address. What should be checked is whether the
20640 local part is a valid user name or not. Cutting out the redirection processing
20641 saves some resources.
20642 .endlist
20643
20644
20645
20646
20647
20648
20649 .section "Interpreting redirection data" "SECID126"
20650 .cindex "Sieve filter" "specifying in redirection data"
20651 .cindex "filter" "specifying in redirection data"
20652 The contents of the data string, whether obtained from &%data%& or &%file%&,
20653 can be interpreted in two different ways:
20654
20655 .ilist
20656 If the &%allow_filter%& option is set true, and the data begins with the text
20657 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20658 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20659 respectively. Details of the syntax and semantics of filter files are described
20660 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20661 document is intended for use by end users.
20662 .next
20663 Otherwise, the data must be a comma-separated list of redirection items, as
20664 described in the next section.
20665 .endlist
20666
20667 When a message is redirected to a file (a &"mail folder"&), the filename given
20668 in a non-filter redirection list must always be an absolute path. A filter may
20669 generate a relative path &-- how this is handled depends on the transport's
20670 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20671 for the &(appendfile)& transport.
20672
20673
20674
20675 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20676 .cindex "address redirection" "non-filter list items"
20677 When the redirection data is not an Exim or Sieve filter, for example, if it
20678 comes from a conventional alias or forward file, it consists of a list of
20679 addresses, filenames, pipe commands, or certain special items (see section
20680 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20681 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20682 depending on their default values. The items in the list are separated by
20683 commas or newlines.
20684 If a comma is required in an item, the entire item must be enclosed in double
20685 quotes.
20686
20687 Lines starting with a # character are comments, and are ignored, and # may
20688 also appear following a comma, in which case everything between the # and the
20689 next newline character is ignored.
20690
20691 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20692 double quotes are retained because some forms of mail address require their use
20693 (but never to enclose the entire address). In the following description,
20694 &"item"& refers to what remains after any surrounding double quotes have been
20695 removed.
20696
20697 .vindex "&$local_part$&"
20698 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20699 and the expansion contains a reference to &$local_part$&, you should make use
20700 of the &%quote_local_part%& expansion operator, in case the local part contains
20701 special characters. For example, to redirect all mail for the domain
20702 &'obsolete.example'&, retaining the existing local part, you could use this
20703 setting:
20704 .code
20705 data = ${quote_local_part:$local_part}@newdomain.example
20706 .endd
20707
20708
20709 .section "Redirecting to a local mailbox" "SECTredlocmai"
20710 .cindex "routing" "loops in"
20711 .cindex "loop" "while routing, avoidance of"
20712 .cindex "address redirection" "to local mailbox"
20713 A redirection item may safely be the same as the address currently under
20714 consideration. This does not cause a routing loop, because a router is
20715 automatically skipped if any ancestor of the address that is being processed
20716 is the same as the current address and was processed by the current router.
20717 Such an address is therefore passed to the following routers, so it is handled
20718 as if there were no redirection. When making this loop-avoidance test, the
20719 complete local part, including any prefix or suffix, is used.
20720
20721 .cindex "address redirection" "local part without domain"
20722 Specifying the same local part without a domain is a common usage in personal
20723 filter files when the user wants to have messages delivered to the local
20724 mailbox and also forwarded elsewhere. For example, the user whose login is
20725 &'cleo'& might have a &_.forward_& file containing this:
20726 .code
20727 cleo, cleopatra@egypt.example
20728 .endd
20729 .cindex "backslash in alias file"
20730 .cindex "alias file" "backslash in"
20731 For compatibility with other MTAs, such unqualified local parts may be
20732 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20733 it does make a difference if more than one domain is being handled
20734 synonymously.
20735
20736 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20737 2822 address that does not include a domain, the item is qualified using the
20738 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20739 addresses are qualified using the value in &%qualify_recipient%&, but you can
20740 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20741
20742 Care must be taken if there are alias names for local users.
20743 Consider an MTA handling a single local domain where the system alias file
20744 contains:
20745 .code
20746 Sam.Reman: spqr
20747 .endd
20748 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20749 messages in the local mailbox, and also forward copies elsewhere. He creates
20750 this forward file:
20751 .code
20752 Sam.Reman, spqr@reme.elsewhere.example
20753 .endd
20754 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20755 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20756 second time round, because it has previously routed it,
20757 and the following routers presumably cannot handle the alias. The forward file
20758 should really contain
20759 .code
20760 spqr, spqr@reme.elsewhere.example
20761 .endd
20762 but because this is such a common error, the &%check_ancestor%& option (see
20763 below) exists to provide a way to get round it. This is normally set on a
20764 &(redirect)& router that is handling users' &_.forward_& files.
20765
20766
20767
20768 .section "Special items in redirection lists" "SECTspecitredli"
20769 In addition to addresses, the following types of item may appear in redirection
20770 lists (that is, in non-filter redirection data):
20771
20772 .ilist
20773 .cindex "pipe" "in redirection list"
20774 .cindex "address redirection" "to pipe"
20775 An item is treated as a pipe command if it begins with &"|"& and does not parse
20776 as a valid RFC 2822 address that includes a domain. A transport for running the
20777 command must be specified by the &%pipe_transport%& option.
20778 Normally, either the router or the transport specifies a user and a group under
20779 which to run the delivery. The default is to use the Exim user and group.
20780
20781 Single or double quotes can be used for enclosing the individual arguments of
20782 the pipe command; no interpretation of escapes is done for single quotes. If
20783 the command contains a comma character, it is necessary to put the whole item
20784 in double quotes, for example:
20785 .code
20786 "|/some/command ready,steady,go"
20787 .endd
20788 since items in redirection lists are terminated by commas. Do not, however,
20789 quote just the command. An item such as
20790 .code
20791 |"/some/command ready,steady,go"
20792 .endd
20793 is interpreted as a pipe with a rather strange command name, and no arguments.
20794
20795 Note that the above example assumes that the text comes from a lookup source
20796 of some sort, so that the quotes are part of the data.  If composing a
20797 redirect router with a &%data%& option directly specifying this command, the
20798 quotes will be used by the configuration parser to define the extent of one
20799 string, but will not be passed down into the redirect router itself.  There
20800 are two main approaches to get around this: escape quotes to be part of the
20801 data itself, or avoid using this mechanism and instead create a custom
20802 transport with the &%command%& option set and reference that transport from
20803 an &%accept%& router.
20804
20805 .next
20806 .cindex "file" "in redirection list"
20807 .cindex "address redirection" "to file"
20808 An item is interpreted as a path name if it begins with &"/"& and does not
20809 parse as a valid RFC 2822 address that includes a domain. For example,
20810 .code
20811 /home/world/minbari
20812 .endd
20813 is treated as a filename, but
20814 .code
20815 /s=molari/o=babylon/@x400gate.way
20816 .endd
20817 is treated as an address. For a filename, a transport must be specified using
20818 the &%file_transport%& option. However, if the generated path name ends with a
20819 forward slash character, it is interpreted as a directory name rather than a
20820 filename, and &%directory_transport%& is used instead.
20821
20822 Normally, either the router or the transport specifies a user and a group under
20823 which to run the delivery. The default is to use the Exim user and group.
20824
20825 .cindex "&_/dev/null_&"
20826 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20827 bypassed at a high level, and the log entry shows &"**bypassed**"&
20828 instead of a transport name. In this case the user and group are not used.
20829
20830 .next
20831 .cindex "included address list"
20832 .cindex "address redirection" "included external list"
20833 If an item is of the form
20834 .code
20835 :include:<path name>
20836 .endd
20837 a list of further items is taken from the given file and included at that
20838 point. &*Note*&: Such a file can not be a filter file; it is just an
20839 out-of-line addition to the list. The items in the included list are separated
20840 by commas or newlines and are not subject to expansion. If this is the first
20841 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20842 the alias name. This example is incorrect:
20843 .code
20844 list1    :include:/opt/lists/list1
20845 .endd
20846 It must be given as
20847 .code
20848 list1:   :include:/opt/lists/list1
20849 .endd
20850 .new
20851 .cindex "tainted data" "in filenames"
20852 .cindex redirect "tainted data"
20853 Tainted data may not be used for a filename.
20854 .wen
20855 .next
20856 .cindex "address redirection" "to black hole"
20857 .cindex "delivery" "discard"
20858 .cindex "delivery" "blackhole"
20859 .cindex "black hole"
20860 .cindex "abandoning mail"
20861 Sometimes you want to throw away mail to a particular local part.  Making the
20862 &%data%& option expand to an empty string does not work, because that causes
20863 the router to decline. Instead, the alias item
20864 .code
20865 :blackhole:
20866 .endd
20867 can be used. It does what its name implies. No delivery is
20868 done, and no error message is generated. This has the same effect as specifying
20869 &_/dev/null_& as a destination, but it can be independently disabled.
20870
20871 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20872 delivery is done for the original local part, even if other redirection items
20873 are present. If you are generating a multi-item list (for example, by reading a
20874 database) and need the ability to provide a no-op item, you must use
20875 &_/dev/null_&.
20876
20877 .next
20878 .cindex "delivery" "forcing failure"
20879 .cindex "delivery" "forcing deferral"
20880 .cindex "failing delivery" "forcing"
20881 .cindex "deferred delivery, forcing"
20882 .cindex "customizing" "failure message"
20883 An attempt to deliver a particular address can be deferred or forced to fail by
20884 redirection items of the form
20885 .code
20886 :defer:
20887 :fail:
20888 .endd
20889 respectively. When a redirection list contains such an item, it applies
20890 to the entire redirection; any other items in the list are ignored. Any
20891 text following &':fail:'& or &':defer:'& is placed in the error text
20892 associated with the failure. For example, an alias file might contain:
20893 .code
20894 X.Employee:  :fail: Gone away, no forwarding address
20895 .endd
20896 In the case of an address that is being verified from an ACL or as the subject
20897 of a
20898 .cindex "VRFY" "error text, display of"
20899 VRFY command, the text is included in the SMTP error response by
20900 default.
20901 .cindex "EXPN" "error text, display of"
20902 The text is not included in the response to an EXPN command. In non-SMTP cases
20903 the text is included in the error message that Exim generates.
20904
20905 .cindex "SMTP" "error codes"
20906 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20907 &':fail:'&. However, if the message starts with three digits followed by a
20908 space, optionally followed by an extended code of the form &'n.n.n'&, also
20909 followed by a space, and the very first digit is the same as the default error
20910 code, the code from the message is used instead. If the very first digit is
20911 incorrect, a panic error is logged, and the default code is used. You can
20912 suppress the use of the supplied code in a redirect router by setting the
20913 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20914 ignored.
20915
20916 .vindex "&$acl_verify_message$&"
20917 In an ACL, an explicitly provided message overrides the default, but the
20918 default message is available in the variable &$acl_verify_message$& and can
20919 therefore be included in a custom message if this is desired.
20920
20921 Normally the error text is the rest of the redirection list &-- a comma does
20922 not terminate it &-- but a newline does act as a terminator. Newlines are not
20923 normally present in alias expansions. In &(lsearch)& lookups they are removed
20924 as part of the continuation process, but they may exist in other kinds of
20925 lookup and in &':include:'& files.
20926
20927 During routing for message delivery (as opposed to verification), a redirection
20928 containing &':fail:'& causes an immediate failure of the incoming address,
20929 whereas &':defer:'& causes the message to remain in the queue so that a
20930 subsequent delivery attempt can happen at a later time. If an address is
20931 deferred for too long, it will ultimately fail, because the normal retry
20932 rules still apply.
20933
20934 .next
20935 .cindex "alias file" "exception to default"
20936 Sometimes it is useful to use a single-key search type with a default (see
20937 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20938 for exceptions to the default. These can be handled by aliasing them to
20939 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20940 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20941 results in an empty redirection list has the same effect.
20942 .endlist
20943
20944
20945 .section "Duplicate addresses" "SECTdupaddr"
20946 .cindex "duplicate addresses"
20947 .cindex "address duplicate, discarding"
20948 .cindex "pipe" "duplicated"
20949 Exim removes duplicate addresses from the list to which it is delivering, so as
20950 to deliver just one copy to each address. This does not apply to deliveries
20951 routed to pipes by different immediate parent addresses, but an indirect
20952 aliasing scheme of the type
20953 .code
20954 pipe:       |/some/command $local_part
20955 localpart1: pipe
20956 localpart2: pipe
20957 .endd
20958 does not work with a message that is addressed to both local parts, because
20959 when the second is aliased to the intermediate local part &"pipe"& it gets
20960 discarded as being the same as a previously handled address. However, a scheme
20961 such as
20962 .code
20963 localpart1: |/some/command $local_part
20964 localpart2: |/some/command $local_part
20965 .endd
20966 does result in two different pipe deliveries, because the immediate parents of
20967 the pipes are distinct.
20968
20969
20970
20971 .section "Repeated redirection expansion" "SECID128"
20972 .cindex "repeated redirection expansion"
20973 .cindex "address redirection" "repeated for each delivery attempt"
20974 When a message cannot be delivered to all of its recipients immediately,
20975 leading to two or more delivery attempts, redirection expansion is carried out
20976 afresh each time for those addresses whose children were not all previously
20977 delivered. If redirection is being used as a mailing list, this can lead to new
20978 members of the list receiving copies of old messages. The &%one_time%& option
20979 can be used to avoid this.
20980
20981
20982 .section "Errors in redirection lists" "SECID129"
20983 .cindex "address redirection" "errors"
20984 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20985 error is skipped, and an entry is written to the main log. This may be useful
20986 for mailing lists that are automatically managed. Otherwise, if an error is
20987 detected while generating the list of new addresses, the original address is
20988 deferred. See also &%syntax_errors_to%&.
20989
20990
20991
20992 .section "Private options for the redirect router" "SECID130"
20993
20994 .cindex "options" "&(redirect)& router"
20995 The private options for the &(redirect)& router are as follows:
20996
20997
20998 .option allow_defer redirect boolean false
20999 Setting this option allows the use of &':defer:'& in non-filter redirection
21000 data, or the &%defer%& command in an Exim filter file.
21001
21002
21003 .option allow_fail redirect boolean false
21004 .cindex "failing delivery" "from filter"
21005 If this option is true, the &':fail:'& item can be used in a redirection list,
21006 and the &%fail%& command may be used in an Exim filter file.
21007
21008
21009 .option allow_filter redirect boolean false
21010 .cindex "filter" "enabling use of"
21011 .cindex "Sieve filter" "enabling use of"
21012 Setting this option allows Exim to interpret redirection data that starts with
21013 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21014 are some features of Exim filter files that some administrators may wish to
21015 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21016
21017 It is also possible to lock out Exim filters or Sieve filters while allowing
21018 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21019
21020
21021 The filter is run using the uid and gid set by the generic &%user%& and
21022 &%group%& options. These take their defaults from the password data if
21023 &%check_local_user%& is set, so in the normal case of users' personal filter
21024 files, the filter is run as the relevant user. When &%allow_filter%& is set
21025 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21026
21027
21028
21029 .option allow_freeze redirect boolean false
21030 .cindex "freezing messages" "allowing in filter"
21031 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21032 This command is more normally encountered in system filters, and is disabled by
21033 default for redirection filters because it isn't something you usually want to
21034 let ordinary users do.
21035
21036
21037
21038 .option check_ancestor redirect boolean false
21039 This option is concerned with handling generated addresses that are the same
21040 as some address in the list of redirection ancestors of the current address.
21041 Although it is turned off by default in the code, it is set in the default
21042 configuration file for handling users' &_.forward_& files. It is recommended
21043 for this use of the &(redirect)& router.
21044
21045 When &%check_ancestor%& is set, if a generated address (including the domain)
21046 is the same as any ancestor of the current address, it is replaced by a copy of
21047 the current address. This helps in the case where local part A is aliased to B,
21048 and B has a &_.forward_& file pointing back to A. For example, within a single
21049 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21050 &_&~jb/.forward_& contains:
21051 .code
21052 \Joe.Bloggs, <other item(s)>
21053 .endd
21054 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21055 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21056 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21057 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21058 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21059 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21060 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21061 original address. See also the &%repeat_use%& option below.
21062
21063
21064 .option check_group redirect boolean "see below"
21065 When the &%file%& option is used, the group owner of the file is checked only
21066 when this option is set. The permitted groups are those listed in the
21067 &%owngroups%& option, together with the user's default group if
21068 &%check_local_user%& is set. If the file has the wrong group, routing is
21069 deferred. The default setting for this option is true if &%check_local_user%&
21070 is set and the &%modemask%& option permits the group write bit, or if the
21071 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21072
21073
21074
21075 .option check_owner redirect boolean "see below"
21076 When the &%file%& option is used, the owner of the file is checked only when
21077 this option is set. If &%check_local_user%& is set, the local user is
21078 permitted; otherwise the owner must be one of those listed in the &%owners%&
21079 option. The default value for this option is true if &%check_local_user%& or
21080 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21081
21082
21083 .option data redirect string&!! unset
21084 This option is mutually exclusive with &%file%&. One or other of them must be
21085 set, but not both. The contents of &%data%& are expanded, and then used as the
21086 list of forwarding items, or as a set of filtering instructions. If the
21087 expansion is forced to fail, or the result is an empty string or a string that
21088 has no effect (consists entirely of comments), the router declines.
21089
21090 When filtering instructions are used, the string must begin with &"#Exim
21091 filter"&, and all comments in the string, including this initial one, must be
21092 terminated with newline characters. For example:
21093 .code
21094 data = #Exim filter\n\
21095        if $h_to: contains Exim then save $home/mail/exim endif
21096 .endd
21097 If you are reading the data from a database where newlines cannot be included,
21098 you can use the &${sg}$& expansion item to turn the escape string of your
21099 choice into a newline.
21100
21101
21102 .option directory_transport redirect string&!! unset
21103 A &(redirect)& router sets up a direct delivery to a directory when a path name
21104 ending with a slash is specified as a new &"address"&. The transport used is
21105 specified by this option, which, after expansion, must be the name of a
21106 configured transport. This should normally be an &(appendfile)& transport.
21107
21108
21109 .option file redirect string&!! unset
21110 This option specifies the name of a file that contains the redirection data. It
21111 is mutually exclusive with the &%data%& option. The string is expanded before
21112 use; if the expansion is forced to fail, the router declines. Other expansion
21113 failures cause delivery to be deferred. The result of a successful expansion
21114 must be an absolute path. The entire file is read and used as the redirection
21115 data. If the data is an empty string or a string that has no effect (consists
21116 entirely of comments), the router declines.
21117
21118 .cindex "NFS" "checking for file existence"
21119 If the attempt to open the file fails with a &"does not exist"& error, Exim
21120 runs a check on the containing directory,
21121 unless &%ignore_enotdir%& is true (see below).
21122 If the directory does not appear to exist, delivery is deferred. This can
21123 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21124 is a mount problem. If the containing directory does exist, but the file does
21125 not, the router declines.
21126
21127
21128 .option file_transport redirect string&!! unset
21129 .vindex "&$address_file$&"
21130 A &(redirect)& router sets up a direct delivery to a file when a path name not
21131 ending in a slash is specified as a new &"address"&. The transport used is
21132 specified by this option, which, after expansion, must be the name of a
21133 configured transport. This should normally be an &(appendfile)& transport. When
21134 it is running, the filename is in &$address_file$&.
21135
21136
21137 .option filter_prepend_home redirect boolean true
21138 When this option is true, if a &(save)& command in an Exim filter specifies a
21139 relative path, and &$home$& is defined, it is automatically prepended to the
21140 relative path. If this option is set false, this action does not happen. The
21141 relative path is then passed to the transport unmodified.
21142
21143
21144 .option forbid_blackhole redirect boolean false
21145 .cindex "restricting access to features"
21146 .cindex "filter" "locking out certain features"
21147 If this option is true, the &':blackhole:'& item may not appear in a
21148 redirection list.
21149
21150
21151 .option forbid_exim_filter redirect boolean false
21152 .cindex "restricting access to features"
21153 .cindex "filter" "locking out certain features"
21154 If this option is set true, only Sieve filters are permitted when
21155 &%allow_filter%& is true.
21156
21157
21158
21159
21160 .option forbid_file redirect boolean false
21161 .cindex "restricting access to features"
21162 .cindex "delivery" "to file; forbidding"
21163 .cindex "filter" "locking out certain features"
21164 .cindex "Sieve filter" "forbidding delivery to a file"
21165 .cindex "Sieve filter" "&""keep""& facility; disabling"
21166 If this option is true, this router may not generate a new address that
21167 specifies delivery to a local file or directory, either from a filter or from a
21168 conventional forward file. This option is forced to be true if &%one_time%& is
21169 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21170 locks out the Sieve's &"keep"& facility.
21171
21172
21173 .option forbid_filter_dlfunc redirect boolean false
21174 .cindex "restricting access to features"
21175 .cindex "filter" "locking out certain features"
21176 If this option is true, string expansions in Exim filters are not allowed to
21177 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21178 functions.
21179
21180 .option forbid_filter_existstest redirect boolean false
21181 .cindex "restricting access to features"
21182 .cindex "filter" "locking out certain features"
21183 .cindex "expansion" "statting a file"
21184 If this option is true, string expansions in Exim filters are not allowed to
21185 make use of the &%exists%& condition or the &%stat%& expansion item.
21186
21187 .option forbid_filter_logwrite redirect boolean false
21188 .cindex "restricting access to features"
21189 .cindex "filter" "locking out certain features"
21190 If this option is true, use of the logging facility in Exim filters is not
21191 permitted. Logging is in any case available only if the filter is being run
21192 under some unprivileged uid (which is normally the case for ordinary users'
21193 &_.forward_& files).
21194
21195
21196 .option forbid_filter_lookup redirect boolean false
21197 .cindex "restricting access to features"
21198 .cindex "filter" "locking out certain features"
21199 If this option is true, string expansions in Exim filter files are not allowed
21200 to make use of &%lookup%& items.
21201
21202
21203 .option forbid_filter_perl redirect boolean false
21204 .cindex "restricting access to features"
21205 .cindex "filter" "locking out certain features"
21206 This option has an effect only if Exim is built with embedded Perl support. If
21207 it is true, string expansions in Exim filter files are not allowed to make use
21208 of the embedded Perl support.
21209
21210
21211 .option forbid_filter_readfile redirect boolean false
21212 .cindex "restricting access to features"
21213 .cindex "filter" "locking out certain features"
21214 If this option is true, string expansions in Exim filter files are not allowed
21215 to make use of &%readfile%& items.
21216
21217
21218 .option forbid_filter_readsocket redirect boolean false
21219 .cindex "restricting access to features"
21220 .cindex "filter" "locking out certain features"
21221 If this option is true, string expansions in Exim filter files are not allowed
21222 to make use of &%readsocket%& items.
21223
21224
21225 .option forbid_filter_reply redirect boolean false
21226 .cindex "restricting access to features"
21227 .cindex "filter" "locking out certain features"
21228 If this option is true, this router may not generate an automatic reply
21229 message. Automatic replies can be generated only from Exim or Sieve filter
21230 files, not from traditional forward files. This option is forced to be true if
21231 &%one_time%& is set.
21232
21233
21234 .option forbid_filter_run redirect boolean false
21235 .cindex "restricting access to features"
21236 .cindex "filter" "locking out certain features"
21237 If this option is true, string expansions in Exim filter files are not allowed
21238 to make use of &%run%& items.
21239
21240
21241 .option forbid_include redirect boolean false
21242 .cindex "restricting access to features"
21243 .cindex "filter" "locking out certain features"
21244 If this option is true, items of the form
21245 .code
21246 :include:<path name>
21247 .endd
21248 are not permitted in non-filter redirection lists.
21249
21250
21251 .option forbid_pipe redirect boolean false
21252 .cindex "restricting access to features"
21253 .cindex "filter" "locking out certain features"
21254 .cindex "delivery" "to pipe; forbidding"
21255 If this option is true, this router may not generate a new address which
21256 specifies delivery to a pipe, either from an Exim filter or from a conventional
21257 forward file. This option is forced to be true if &%one_time%& is set.
21258
21259
21260 .option forbid_sieve_filter redirect boolean false
21261 .cindex "restricting access to features"
21262 .cindex "filter" "locking out certain features"
21263 If this option is set true, only Exim filters are permitted when
21264 &%allow_filter%& is true.
21265
21266
21267 .cindex "SMTP" "error codes"
21268 .option forbid_smtp_code redirect boolean false
21269 If this option is set true, any SMTP error codes that are present at the start
21270 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21271 the default codes (451 and 550, respectively) are always used.
21272
21273
21274
21275
21276 .option hide_child_in_errmsg redirect boolean false
21277 .cindex "bounce message" "redirection details; suppressing"
21278 If this option is true, it prevents Exim from quoting a child address if it
21279 generates a bounce or delay message for it. Instead it says &"an address
21280 generated from <&'the top level address'&>"&. Of course, this applies only to
21281 bounces generated locally. If a message is forwarded to another host, &'its'&
21282 bounce may well quote the generated address.
21283
21284
21285 .option ignore_eacces redirect boolean false
21286 .cindex "EACCES"
21287 If this option is set and an attempt to open a redirection file yields the
21288 EACCES error (permission denied), the &(redirect)& router behaves as if the
21289 file did not exist.
21290
21291
21292 .option ignore_enotdir redirect boolean false
21293 .cindex "ENOTDIR"
21294 If this option is set and an attempt to open a redirection file yields the
21295 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21296 router behaves as if the file did not exist.
21297
21298 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21299 router that has the &%file%& option set discovers that the file does not exist
21300 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21301 against unmounted NFS directories. If the parent can not be statted, delivery
21302 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21303 is set, because that option tells Exim to ignore &"something on the path is not
21304 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21305 that some operating systems give ENOENT where others give ENOTDIR.
21306
21307
21308
21309 .option include_directory redirect string unset
21310 If this option is set, the path names of any &':include:'& items in a
21311 redirection list must start with this directory.
21312
21313
21314 .option modemask redirect "octal integer" 022
21315 This specifies mode bits which must not be set for a file specified by the
21316 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21317
21318
21319 .option one_time redirect boolean false
21320 .cindex "one-time aliasing/forwarding expansion"
21321 .cindex "alias file" "one-time expansion"
21322 .cindex "forward file" "one-time expansion"
21323 .cindex "mailing lists" "one-time expansion"
21324 .cindex "address redirection" "one-time expansion"
21325 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21326 files each time it tries to deliver a message causes a problem when one or more
21327 of the generated addresses fails be delivered at the first attempt. The problem
21328 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21329 but of what happens when the redirection list changes during the time that the
21330 message is on Exim's queue. This is particularly true in the case of mailing
21331 lists, where new subscribers might receive copies of messages that were posted
21332 before they subscribed.
21333
21334 If &%one_time%& is set and any addresses generated by the router fail to
21335 deliver at the first attempt, the failing addresses are added to the message as
21336 &"top level"& addresses, and the parent address that generated them is marked
21337 &"delivered"&. Thus, redirection does not happen again at the next delivery
21338 attempt.
21339
21340 &*Warning 1*&: Any header line addition or removal that is specified by this
21341 router would be lost if delivery did not succeed at the first attempt. For this
21342 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21343 permitted when &%one_time%& is set.
21344
21345 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21346 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21347 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21348
21349 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21350 &%one_time%&.
21351
21352 The original top-level address is remembered with each of the generated
21353 addresses, and is output in any log messages. However, any intermediate parent
21354 addresses are not recorded. This makes a difference to the log only if
21355 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21356 typically be used for mailing lists, where there is normally just one level of
21357 expansion.
21358
21359
21360 .option owners redirect "string list" unset
21361 .cindex "ownership" "alias file"
21362 .cindex "ownership" "forward file"
21363 .cindex "alias file" "ownership"
21364 .cindex "forward file" "ownership"
21365 This specifies a list of permitted owners for the file specified by &%file%&.
21366 This list is in addition to the local user when &%check_local_user%& is set.
21367 See &%check_owner%& above.
21368
21369
21370 .option owngroups redirect "string list" unset
21371 This specifies a list of permitted groups for the file specified by &%file%&.
21372 The list is in addition to the local user's primary group when
21373 &%check_local_user%& is set. See &%check_group%& above.
21374
21375
21376 .option pipe_transport redirect string&!! unset
21377 .vindex "&$address_pipe$&"
21378 A &(redirect)& router sets up a direct delivery to a pipe when a string
21379 starting with a vertical bar character is specified as a new &"address"&. The
21380 transport used is specified by this option, which, after expansion, must be the
21381 name of a configured transport. This should normally be a &(pipe)& transport.
21382 When the transport is run, the pipe command is in &$address_pipe$&.
21383
21384
21385 .option qualify_domain redirect string&!! unset
21386 .vindex "&$qualify_recipient$&"
21387 If this option is set, and an unqualified address (one without a domain) is
21388 generated, and that address would normally be qualified by the global setting
21389 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21390 expanding this string. If the expansion fails, the router declines. If you want
21391 to revert to the default, you can have the expansion generate
21392 &$qualify_recipient$&.
21393
21394 This option applies to all unqualified addresses generated by Exim filters,
21395 but for traditional &_.forward_& files, it applies only to addresses that are
21396 not preceded by a backslash. Sieve filters cannot generate unqualified
21397 addresses.
21398
21399 .option qualify_preserve_domain redirect boolean false
21400 .cindex "domain" "in redirection; preserving"
21401 .cindex "preserving domain in redirection"
21402 .cindex "address redirection" "domain; preserving"
21403 If this option is set, the router's local &%qualify_domain%& option must not be
21404 set (a configuration error occurs if it is). If an unqualified address (one
21405 without a domain) is generated, it is qualified with the domain of the parent
21406 address (the immediately preceding ancestor) instead of the global
21407 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21408 this applies whether or not the address is preceded by a backslash.
21409
21410
21411 .option repeat_use redirect boolean true
21412 If this option is set false, the router is skipped for a child address that has
21413 any ancestor that was routed by this router. This test happens before any of
21414 the other preconditions are tested. Exim's default anti-looping rules skip
21415 only when the ancestor is the same as the current address. See also
21416 &%check_ancestor%& above and the generic &%redirect_router%& option.
21417
21418
21419 .option reply_transport redirect string&!! unset
21420 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21421 &%vacation%& command is used in a filter file. The transport used is specified
21422 by this option, which, after expansion, must be the name of a configured
21423 transport. This should normally be an &(autoreply)& transport. Other transports
21424 are unlikely to do anything sensible or useful.
21425
21426
21427 .option rewrite redirect boolean true
21428 .cindex "address redirection" "disabling rewriting"
21429 If this option is set false, addresses generated by the router are not
21430 subject to address rewriting. Otherwise, they are treated like new addresses
21431 and are rewritten according to the global rewriting rules.
21432
21433
21434 .option sieve_subaddress redirect string&!! unset
21435 The value of this option is passed to a Sieve filter to specify the
21436 :subaddress part of an address.
21437
21438 .option sieve_useraddress redirect string&!! unset
21439 The value of this option is passed to a Sieve filter to specify the :user part
21440 of an address. However, if it is unset, the entire original local part
21441 (including any prefix or suffix) is used for :user.
21442
21443
21444 .option sieve_vacation_directory redirect string&!! unset
21445 .cindex "Sieve filter" "vacation directory"
21446 To enable the &"vacation"& extension for Sieve filters, you must set
21447 &%sieve_vacation_directory%& to the directory where vacation databases are held
21448 (do not put anything else in that directory), and ensure that the
21449 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21450 needs their own directory; Exim will create it if necessary.
21451
21452
21453
21454 .option skip_syntax_errors redirect boolean false
21455 .cindex "forward file" "broken"
21456 .cindex "address redirection" "broken files"
21457 .cindex "alias file" "broken"
21458 .cindex "broken alias or forward files"
21459 .cindex "ignoring faulty addresses"
21460 .cindex "skipping faulty addresses"
21461 .cindex "error" "skipping bad syntax"
21462 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21463 non-filter redirection data are skipped, and each failing address is logged. If
21464 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21465 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21466 are expanded and placed at the head of the error message generated by
21467 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21468 be the same address as the generic &%errors_to%& option. The
21469 &%skip_syntax_errors%& option is often used when handling mailing lists.
21470
21471 If all the addresses in a redirection list are skipped because of syntax
21472 errors, the router declines to handle the original address, and it is passed to
21473 the following routers.
21474
21475 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21476 error in the filter causes filtering to be abandoned without any action being
21477 taken. The incident is logged, and the router declines to handle the address,
21478 so it is passed to the following routers.
21479
21480 .cindex "Sieve filter" "syntax errors in"
21481 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21482 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21483 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21484
21485 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21486 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21487 option, used with an address that does not get redirected, can be used to
21488 notify users of these errors, by means of a router like this:
21489 .code
21490 userforward:
21491   driver = redirect
21492   allow_filter
21493   check_local_user
21494   file = $home/.forward
21495   file_transport = address_file
21496   pipe_transport = address_pipe
21497   reply_transport = address_reply
21498   no_verify
21499   skip_syntax_errors
21500   syntax_errors_to = real-$local_part@$domain
21501   syntax_errors_text = \
21502    This is an automatically generated message. An error has\n\
21503    been found in your .forward file. Details of the error are\n\
21504    reported below. While this error persists, you will receive\n\
21505    a copy of this message for every message that is addressed\n\
21506    to you. If your .forward file is a filter file, or if it is\n\
21507    a non-filter file containing no valid forwarding addresses,\n\
21508    a copy of each incoming message will be put in your normal\n\
21509    mailbox. If a non-filter file contains at least one valid\n\
21510    forwarding address, forwarding to the valid addresses will\n\
21511    happen, and those will be the only deliveries that occur.
21512 .endd
21513 You also need a router to ensure that local addresses that are prefixed by
21514 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21515 put this immediately before the &(userforward)& router:
21516 .code
21517 real_localuser:
21518   driver = accept
21519   check_local_user
21520   local_part_prefix = real-
21521   transport = local_delivery
21522 .endd
21523 For security, it would probably be a good idea to restrict the use of this
21524 router to locally-generated messages, using a condition such as this:
21525 .code
21526   condition = ${if match {$sender_host_address}\
21527                          {\N^(|127\.0\.0\.1)$\N}}
21528 .endd
21529
21530
21531 .option syntax_errors_text redirect string&!! unset
21532 See &%skip_syntax_errors%& above.
21533
21534
21535 .option syntax_errors_to redirect string unset
21536 See &%skip_syntax_errors%& above.
21537 .ecindex IIDredrou1
21538 .ecindex IIDredrou2
21539
21540
21541
21542
21543
21544
21545 . ////////////////////////////////////////////////////////////////////////////
21546 . ////////////////////////////////////////////////////////////////////////////
21547
21548 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21549          "Environment for local transports"
21550 .scindex IIDenvlotra1 "local transports" "environment for"
21551 .scindex IIDenvlotra2 "environment" "local transports"
21552 .scindex IIDenvlotra3 "transport" "local; environment for"
21553 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21554 transport can be thought of as similar to a pipe.) Exim always runs transports
21555 in subprocesses, under specified uids and gids. Typical deliveries to local
21556 mailboxes run under the uid and gid of the local user.
21557
21558 Exim also sets a specific current directory while running the transport; for
21559 some transports a home directory setting is also relevant. The &(pipe)&
21560 transport is the only one that sets up environment variables; see section
21561 &<<SECTpipeenv>>& for details.
21562
21563 The values used for the uid, gid, and the directories may come from several
21564 different places. In many cases, the router that handles the address associates
21565 settings with that address as a result of its &%check_local_user%&, &%group%&,
21566 or &%user%& options. However, values may also be given in the transport's own
21567 configuration, and these override anything that comes from the router.
21568
21569
21570
21571 .section "Concurrent deliveries" "SECID131"
21572 .cindex "concurrent deliveries"
21573 .cindex "simultaneous deliveries"
21574 If two different messages for the same local recipient arrive more or less
21575 simultaneously, the two delivery processes are likely to run concurrently. When
21576 the &(appendfile)& transport is used to write to a file, Exim applies locking
21577 rules to stop concurrent processes from writing to the same file at the same
21578 time.
21579
21580 However, when you use a &(pipe)& transport, it is up to you to arrange any
21581 locking that is needed. Here is a silly example:
21582 .code
21583 my_transport:
21584   driver = pipe
21585   command = /bin/sh -c 'cat >>/some/file'
21586 .endd
21587 This is supposed to write the message at the end of the file. However, if two
21588 messages arrive at the same time, the file will be scrambled. You can use the
21589 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21590 file using the same algorithm that Exim itself uses.
21591
21592
21593
21594
21595 .section "Uids and gids" "SECTenvuidgid"
21596 .cindex "local transports" "uid and gid"
21597 .cindex "transport" "local; uid and gid"
21598 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21599 overrides any group that the router set in the address, even if &%user%& is not
21600 set for the transport. This makes it possible, for example, to run local mail
21601 delivery under the uid of the recipient (set by the router), but in a special
21602 group (set by the transport). For example:
21603 .code
21604 # Routers ...
21605 # User/group are set by check_local_user in this router
21606 local_users:
21607   driver = accept
21608   check_local_user
21609   transport = group_delivery
21610
21611 # Transports ...
21612 # This transport overrides the group
21613 group_delivery:
21614   driver = appendfile
21615   file = /var/spool/mail/$local_part
21616   group = mail
21617 .endd
21618 If &%user%& is set for a transport, its value overrides what is set in the
21619 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21620 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21621 set.
21622
21623 .oindex "&%initgroups%&"
21624 When the uid is taken from the transport's configuration, the &[initgroups()]&
21625 function is called for the groups associated with that uid if the
21626 &%initgroups%& option is set for the transport. When the uid is not specified
21627 by the transport, but is associated with the address by a router, the option
21628 for calling &[initgroups()]& is taken from the router configuration.
21629
21630 .cindex "&(pipe)& transport" "uid for"
21631 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21632 is set and &%user%& is not set, the uid of the process that called Exim to
21633 receive the message is used, and if &%group%& is not set, the corresponding
21634 original gid is also used.
21635
21636 This is the detailed preference order for obtaining a gid; the first of the
21637 following that is set is used:
21638
21639 .ilist
21640 A &%group%& setting of the transport;
21641 .next
21642 A &%group%& setting of the router;
21643 .next
21644 A gid associated with a user setting of the router, either as a result of
21645 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21646 .next
21647 The group associated with a non-numeric &%user%& setting of the transport;
21648 .next
21649 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21650 the uid is the creator's uid;
21651 .next
21652 The Exim gid if the Exim uid is being used as a default.
21653 .endlist
21654
21655 If, for example, the user is specified numerically on the router and there are
21656 no group settings, no gid is available. In this situation, an error occurs.
21657 This is different for the uid, for which there always is an ultimate default.
21658 The first of the following that is set is used:
21659
21660 .ilist
21661 A &%user%& setting of the transport;
21662 .next
21663 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21664 .next
21665 A &%user%& setting of the router;
21666 .next
21667 A &%check_local_user%& setting of the router;
21668 .next
21669 The Exim uid.
21670 .endlist
21671
21672 Of course, an error will still occur if the uid that is chosen is on the
21673 &%never_users%& list.
21674
21675
21676
21677
21678
21679 .section "Current and home directories" "SECID132"
21680 .cindex "current directory for local transport"
21681 .cindex "home directory" "for local transport"
21682 .cindex "transport" "local; home directory for"
21683 .cindex "transport" "local; current directory for"
21684 Routers may set current and home directories for local transports by means of
21685 the &%transport_current_directory%& and &%transport_home_directory%& options.
21686 However, if the transport's &%current_directory%& or &%home_directory%& options
21687 are set, they override the router's values. In detail, the home directory
21688 for a local transport is taken from the first of these values that is set:
21689
21690 .ilist
21691 The &%home_directory%& option on the transport;
21692 .next
21693 The &%transport_home_directory%& option on the router;
21694 .next
21695 The password data if &%check_local_user%& is set on the router;
21696 .next
21697 The &%router_home_directory%& option on the router.
21698 .endlist
21699
21700 The current directory is taken from the first of these values that is set:
21701
21702 .ilist
21703 The &%current_directory%& option on the transport;
21704 .next
21705 The &%transport_current_directory%& option on the router.
21706 .endlist
21707
21708
21709 If neither the router nor the transport sets a current directory, Exim uses the
21710 value of the home directory, if it is set. Otherwise it sets the current
21711 directory to &_/_& before running a local transport.
21712
21713
21714
21715 .section "Expansion variables derived from the address" "SECID133"
21716 .vindex "&$domain$&"
21717 .vindex "&$local_part$&"
21718 .vindex "&$original_domain$&"
21719 Normally a local delivery is handling a single address, and in that case the
21720 variables such as &$domain$& and &$local_part$& are set during local
21721 deliveries. However, in some circumstances more than one address may be handled
21722 at once (for example, while writing batch SMTP for onward transmission by some
21723 other means). In this case, the variables associated with the local part are
21724 never set, &$domain$& is set only if all the addresses have the same domain,
21725 and &$original_domain$& is never set.
21726 .ecindex IIDenvlotra1
21727 .ecindex IIDenvlotra2
21728 .ecindex IIDenvlotra3
21729
21730
21731
21732
21733
21734
21735
21736 . ////////////////////////////////////////////////////////////////////////////
21737 . ////////////////////////////////////////////////////////////////////////////
21738
21739 .chapter "Generic options for transports" "CHAPtransportgeneric"
21740 .scindex IIDgenoptra1 "generic options" "transport"
21741 .scindex IIDgenoptra2 "options" "generic; for transports"
21742 .scindex IIDgenoptra3 "transport" "generic options for"
21743 The following generic options apply to all transports:
21744
21745
21746 .option body_only transports boolean false
21747 .cindex "transport" "body only"
21748 .cindex "message" "transporting body only"
21749 .cindex "body of message" "transporting"
21750 If this option is set, the message's headers are not transported. It is
21751 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21752 or &(pipe)& transports, the settings of &%message_prefix%& and
21753 &%message_suffix%& should be checked, because this option does not
21754 automatically suppress them.
21755
21756
21757 .option current_directory transports string&!! unset
21758 .cindex "transport" "current directory for"
21759 This specifies the current directory that is to be set while running the
21760 transport, overriding any value that may have been set by the router.
21761 If the expansion fails for any reason, including forced failure, an error is
21762 logged, and delivery is deferred.
21763
21764
21765 .option disable_logging transports boolean false
21766 If this option is set true, nothing is logged for any
21767 deliveries by the transport or for any
21768 transport errors. You should not set this option unless you really, really know
21769 what you are doing.
21770
21771
21772 .option debug_print transports string&!! unset
21773 .cindex "testing" "variables in drivers"
21774 If this option is set and debugging is enabled (see the &%-d%& command line
21775 option), the string is expanded and included in the debugging output when the
21776 transport is run.
21777 If expansion of the string fails, the error message is written to the debugging
21778 output, and Exim carries on processing.
21779 This facility is provided to help with checking out the values of variables and
21780 so on when debugging driver configurations. For example, if a &%headers_add%&
21781 option is not working properly, &%debug_print%& could be used to output the
21782 variables it references. A newline is added to the text if it does not end with
21783 one.
21784 The variables &$transport_name$& and &$router_name$& contain the name of the
21785 transport and the router that called it.
21786
21787 .option delivery_date_add transports boolean false
21788 .cindex "&'Delivery-date:'& header line"
21789 If this option is true, a &'Delivery-date:'& header is added to the message.
21790 This gives the actual time the delivery was made. As this is not a standard
21791 header, Exim has a configuration option (&%delivery_date_remove%&) which
21792 requests its removal from incoming messages, so that delivered messages can
21793 safely be resent to other recipients.
21794
21795
21796 .option driver transports string unset
21797 This specifies which of the available transport drivers is to be used.
21798 There is no default, and this option must be set for every transport.
21799
21800
21801 .option envelope_to_add transports boolean false
21802 .cindex "&'Envelope-to:'& header line"
21803 If this option is true, an &'Envelope-to:'& header is added to the message.
21804 This gives the original address(es) in the incoming envelope that caused this
21805 delivery to happen. More than one address may be present if the transport is
21806 configured to handle several addresses at once, or if more than one original
21807 address was redirected to the same final address. As this is not a standard
21808 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21809 its removal from incoming messages, so that delivered messages can safely be
21810 resent to other recipients.
21811
21812
21813 .option event_action transports string&!! unset
21814 .cindex events
21815 This option declares a string to be expanded for Exim's events mechanism.
21816 For details see chapter &<<CHAPevents>>&.
21817
21818
21819 .option group transports string&!! "Exim group"
21820 .cindex "transport" "group; specifying"
21821 This option specifies a gid for running the transport process, overriding any
21822 value that the router supplies, and also overriding any value associated with
21823 &%user%& (see below).
21824
21825
21826 .option headers_add transports list&!! unset
21827 .cindex "header lines" "adding in transport"
21828 .cindex "transport" "header lines; adding"
21829 This option specifies a list of text headers,
21830 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21831 which are (separately) expanded and added to the header
21832 portion of a message as it is transported, as described in section
21833 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21834 routers. If the result of the expansion is an empty string, or if the expansion
21835 is forced to fail, no action is taken. Other expansion failures are treated as
21836 errors and cause the delivery to be deferred.
21837
21838 Unlike most options, &%headers_add%& can be specified multiple times
21839 for a transport; all listed headers are added.
21840
21841
21842 .option headers_only transports boolean false
21843 .cindex "transport" "header lines only"
21844 .cindex "message" "transporting headers only"
21845 .cindex "header lines" "transporting"
21846 If this option is set, the message's body is not transported. It is mutually
21847 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21848 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21849 checked, since this option does not automatically suppress them.
21850
21851
21852 .option headers_remove transports list&!! unset
21853 .cindex "header lines" "removing"
21854 .cindex "transport" "header lines; removing"
21855 This option specifies a list of text headers,
21856 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21857 to be removed from the message.
21858 However, the option has no effect when an address is just being verified.
21859 Each list item is separately expanded.
21860 If the result of the expansion is an empty string, or if the expansion
21861 is forced to fail, no action is taken. Other expansion failures are treated as
21862 errors and cause the delivery to be deferred.
21863 .new
21864 If an item ends in *, it will match any header with the given prefix.
21865 .wen
21866
21867 Matching headers are omitted from the message as it is transported, as described
21868 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21869 routers.
21870
21871 Unlike most options, &%headers_remove%& can be specified multiple times
21872 for a transport; all listed headers are removed.
21873
21874 &*Warning*&: Because of the separate expansion of the list items,
21875 items that contain a list separator must have it doubled.
21876 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21877
21878
21879
21880 .option headers_rewrite transports string unset
21881 .cindex "transport" "header lines; rewriting"
21882 .cindex "rewriting" "at transport time"
21883 This option allows addresses in header lines to be rewritten at transport time,
21884 that is, as the message is being copied to its destination. The contents of the
21885 option are a colon-separated list of rewriting rules. Each rule is in exactly
21886 the same form as one of the general rewriting rules that are applied when a
21887 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21888 example,
21889 .code
21890 headers_rewrite = a@b c@d f : \
21891                   x@y w@z
21892 .endd
21893 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21894 &'w@z'& in all address-bearing header lines. The rules are applied to the
21895 header lines just before they are written out at transport time, so they affect
21896 only those copies of the message that pass through the transport. However, only
21897 the message's original header lines, and any that were added by a system
21898 filter, are rewritten. If a router or transport adds header lines, they are not
21899 affected by this option. These rewriting rules are &'not'& applied to the
21900 envelope. You can change the return path using &%return_path%&, but you cannot
21901 change envelope recipients at this time.
21902
21903
21904 .option home_directory transports string&!! unset
21905 .cindex "transport" "home directory for"
21906 .vindex "&$home$&"
21907 This option specifies a home directory setting for a local transport,
21908 overriding any value that may be set by the router. The home directory is
21909 placed in &$home$& while expanding the transport's private options. It is also
21910 used as the current directory if no current directory is set by the
21911 &%current_directory%& option on the transport or the
21912 &%transport_current_directory%& option on the router. If the expansion fails
21913 for any reason, including forced failure, an error is logged, and delivery is
21914 deferred.
21915
21916
21917 .option initgroups transports boolean false
21918 .cindex "additional groups"
21919 .cindex "groups" "additional"
21920 .cindex "transport" "group; additional"
21921 If this option is true and the uid for the delivery process is provided by the
21922 transport, the &[initgroups()]& function is called when running the transport
21923 to ensure that any additional groups associated with the uid are set up.
21924
21925
21926 .option max_parallel transports integer&!! unset
21927 .cindex limit "transport parallelism"
21928 .cindex transport "parallel processes"
21929 .cindex transport "concurrency limit"
21930 .cindex "delivery" "parallelism for transport"
21931 If this option is set and expands to an integer greater than zero
21932 it limits the number of concurrent runs of the transport.
21933 The control does not apply to shadow transports.
21934
21935 .cindex "hints database" "transport concurrency control"
21936 Exim implements this control by means of a hints database in which a record is
21937 incremented whenever a transport process is being created. The record
21938 is decremented and possibly removed when the process terminates.
21939 Obviously there is scope for
21940 records to get left lying around if there is a system or program crash. To
21941 guard against this, Exim ignores any records that are more than six hours old.
21942
21943 If you use this option, you should also arrange to delete the
21944 relevant hints database whenever your system reboots. The names of the files
21945 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21946 may be one or two files, depending on the type of DBM in use. The same files
21947 are used for ETRN and smtp transport serialization.
21948
21949
21950 .option message_size_limit transports string&!! 0
21951 .cindex "limit" "message size per transport"
21952 .cindex "size" "of message, limit"
21953 .cindex "transport" "message size; limiting"
21954 This option controls the size of messages passed through the transport. It is
21955 expanded before use; the result of the expansion must be a sequence of decimal
21956 digits, optionally followed by K or M. If the expansion fails for any reason,
21957 including forced failure, or if the result is not of the required form,
21958 delivery is deferred. If the value is greater than zero and the size of a
21959 message exceeds this limit, the address is failed. If there is any chance that
21960 the resulting bounce message could be routed to the same transport, you should
21961 ensure that &%return_size_limit%& is less than the transport's
21962 &%message_size_limit%&, as otherwise the bounce message will fail to get
21963 delivered.
21964
21965
21966
21967 .option rcpt_include_affixes transports boolean false
21968 .cindex "prefix" "for local part, including in envelope"
21969 .cindex "suffix for local part" "including in envelope"
21970 .cindex "local part" "prefix"
21971 .cindex "local part" "suffix"
21972 When this option is false (the default), and an address that has had any
21973 affixes (prefixes or suffixes) removed from the local part is delivered by any
21974 form of SMTP or LMTP, the affixes are not included. For example, if a router
21975 that contains
21976 .code
21977 local_part_prefix = *-
21978 .endd
21979 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21980 is delivered with
21981 .code
21982 RCPT TO:<xyz@some.domain>
21983 .endd
21984 This is also the case when an ACL-time callout is being used to verify a
21985 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21986 whole local part is included in the RCPT command. This option applies to BSMTP
21987 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21988 &(lmtp)& and &(smtp)& transports.
21989
21990
21991 .option retry_use_local_part transports boolean "see below"
21992 .cindex "hints database" "retry keys"
21993 When a delivery suffers a temporary failure, a retry record is created
21994 in Exim's hints database. For remote deliveries, the key for the retry record
21995 is based on the name and/or IP address of the failing remote host. For local
21996 deliveries, the key is normally the entire address, including both the local
21997 part and the domain. This is suitable for most common cases of local delivery
21998 temporary failure &-- for example, exceeding a mailbox quota should delay only
21999 deliveries to that mailbox, not to the whole domain.
22000
22001 However, in some special cases you may want to treat a temporary local delivery
22002 as a failure associated with the domain, and not with a particular local part.
22003 (For example, if you are storing all mail for some domain in files.) You can do
22004 this by setting &%retry_use_local_part%& false.
22005
22006 For all the local transports, its default value is true. For remote transports,
22007 the default value is false for tidiness, but changing the value has no effect
22008 on a remote transport in the current implementation.
22009
22010
22011 .option return_path transports string&!! unset
22012 .cindex "envelope sender"
22013 .cindex "envelope from"
22014 .cindex "transport" "return path; changing"
22015 .cindex "return path" "changing in transport"
22016 If this option is set, the string is expanded at transport time and replaces
22017 the existing return path (envelope sender) value in the copy of the message
22018 that is being delivered. An empty return path is permitted. This feature is
22019 designed for remote deliveries, where the value of this option is used in the
22020 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22021 only effect is to change the address that is placed in the &'Return-path:'&
22022 header line, if one is added to the message (see the next option).
22023
22024 &*Note:*& A changed return path is not logged unless you add
22025 &%return_path_on_delivery%& to the log selector.
22026
22027 .vindex "&$return_path$&"
22028 The expansion can refer to the existing value via &$return_path$&. This is
22029 either the message's envelope sender, or an address set by the
22030 &%errors_to%& option on a router. If the expansion is forced to fail, no
22031 replacement occurs; if it fails for another reason, delivery is deferred. This
22032 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22033 section &<<SECTverp>>&.
22034
22035 &*Note*&: If a delivery error is detected locally, including the case when a
22036 remote server rejects a message at SMTP time, the bounce message is not sent to
22037 the value of this option. It is sent to the previously set errors address.
22038 This defaults to the incoming sender address, but can be changed by setting
22039 &%errors_to%& in a router.
22040
22041
22042
22043 .option return_path_add transports boolean false
22044 .cindex "&'Return-path:'& header line"
22045 If this option is true, a &'Return-path:'& header is added to the message.
22046 Although the return path is normally available in the prefix line of BSD
22047 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22048 have easy access to it.
22049
22050 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22051 the delivery SMTP server makes the final delivery"&. This implies that this
22052 header should not be present in incoming messages. Exim has a configuration
22053 option, &%return_path_remove%&, which requests removal of this header from
22054 incoming messages, so that delivered messages can safely be resent to other
22055 recipients.
22056
22057
22058 .option shadow_condition transports string&!! unset
22059 See &%shadow_transport%& below.
22060
22061
22062 .option shadow_transport transports string unset
22063 .cindex "shadow transport"
22064 .cindex "transport" "shadow"
22065 A local transport may set the &%shadow_transport%& option to the name of
22066 another local transport. Shadow remote transports are not supported.
22067
22068 Whenever a delivery to the main transport succeeds, and either
22069 &%shadow_condition%& is unset, or its expansion does not result in the empty
22070 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22071 passed to the shadow transport, with the same delivery address or addresses. If
22072 expansion fails, no action is taken except that non-forced expansion failures
22073 cause a log line to be written.
22074
22075 The result of the shadow transport is discarded and does not affect the
22076 subsequent processing of the message. Only a single level of shadowing is
22077 provided; the &%shadow_transport%& option is ignored on any transport when it
22078 is running as a shadow. Options concerned with output from pipes are also
22079 ignored. The log line for the successful delivery has an item added on the end,
22080 of the form
22081 .code
22082 ST=<shadow transport name>
22083 .endd
22084 If the shadow transport did not succeed, the error message is put in
22085 parentheses afterwards. Shadow transports can be used for a number of different
22086 purposes, including keeping more detailed log information than Exim normally
22087 provides, and implementing automatic acknowledgment policies based on message
22088 headers that some sites insist on.
22089
22090
22091 .option transport_filter transports string&!! unset
22092 .cindex "transport" "filter"
22093 .cindex "filter" "transport filter"
22094 This option sets up a filtering (in the Unix shell sense) process for messages
22095 at transport time. It should not be confused with mail filtering as set up by
22096 individual users or via a system filter.
22097 If unset, or expanding to an empty string, no filtering is done.
22098
22099 When the message is about to be written out, the command specified by
22100 &%transport_filter%& is started up in a separate, parallel process, and
22101 the entire message, including the header lines, is passed to it on its standard
22102 input (this in fact is done from a third process, to avoid deadlock). The
22103 command must be specified as an absolute path.
22104
22105 The lines of the message that are written to the transport filter are
22106 terminated by newline (&"\n"&). The message is passed to the filter before any
22107 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22108 lines beginning with a dot, and also before any processing implied by the
22109 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22110 &(pipe)& transports.
22111
22112 The standard error for the filter process is set to the same destination as its
22113 standard output; this is read and written to the message's ultimate
22114 destination. The process that writes the message to the filter, the
22115 filter itself, and the original process that reads the result and delivers it
22116 are all run in parallel, like a shell pipeline.
22117
22118 The filter can perform any transformations it likes, but of course should take
22119 care not to break RFC 2822 syntax. Exim does not check the result, except to
22120 test for a final newline when SMTP is in use. All messages transmitted over
22121 SMTP must end with a newline, so Exim supplies one if it is missing.
22122
22123 .cindex "content scanning" "per user"
22124 A transport filter can be used to provide content-scanning on a per-user basis
22125 at delivery time if the only required effect of the scan is to modify the
22126 message. For example, a content scan could insert a new header line containing
22127 a spam score. This could be interpreted by a filter in the user's MUA. It is
22128 not possible to discard a message at this stage.
22129
22130 .cindex "SMTP" "SIZE"
22131 A problem might arise if the filter increases the size of a message that is
22132 being sent down an SMTP connection. If the receiving SMTP server has indicated
22133 support for the SIZE parameter, Exim will have sent the size of the message
22134 at the start of the SMTP session. If what is actually sent is substantially
22135 more, the server might reject the message. This can be worked round by setting
22136 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22137 additions to the message, or to disable the use of SIZE altogether.
22138
22139 .vindex "&$pipe_addresses$&"
22140 The value of the &%transport_filter%& option is the command string for starting
22141 the filter, which is run directly from Exim, not under a shell. The string is
22142 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22143 Exim breaks it up into arguments and then expands each argument separately (see
22144 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22145 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22146 of arguments, one for each address that applies to this delivery. (This isn't
22147 an ideal name for this feature here, but as it was already implemented for the
22148 &(pipe)& transport, it seemed sensible not to change it.)
22149
22150 .vindex "&$host$&"
22151 .vindex "&$host_address$&"
22152 The expansion variables &$host$& and &$host_address$& are available when the
22153 transport is a remote one. They contain the name and IP address of the host to
22154 which the message is being sent. For example:
22155 .code
22156 transport_filter = /some/directory/transport-filter.pl \
22157   $host $host_address $sender_address $pipe_addresses
22158 .endd
22159
22160 Two problems arise if you want to use more complicated expansion items to
22161 generate transport filter commands, both of which due to the fact that the
22162 command is split up &'before'& expansion.
22163 .ilist
22164 If an expansion item contains white space, you must quote it, so that it is all
22165 part of the same command item. If the entire option setting is one such
22166 expansion item, you have to take care what kind of quoting you use. For
22167 example:
22168 .code
22169 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22170 .endd
22171 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22172 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22173 stripped by Exim when it read the option's value. When the value is used, if
22174 the single quotes were missing, the line would be split into two items,
22175 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22176 Exim tried to expand the first one.
22177 .next
22178 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22179 expansion cannot generate multiple arguments, or a command name followed by
22180 arguments. Consider this example:
22181 .code
22182 transport_filter = ${lookup{$host}lsearch{/a/file}\
22183                     {$value}{/bin/cat}}
22184 .endd
22185 The result of the lookup is interpreted as the name of the command, even
22186 if it contains white space. The simplest way round this is to use a shell:
22187 .code
22188 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22189                                {$value}{/bin/cat}}
22190 .endd
22191 .endlist
22192
22193 The filter process is run under the same uid and gid as the normal delivery.
22194 For remote deliveries this is the Exim uid/gid by default. The command should
22195 normally yield a zero return code. Transport filters are not supposed to fail.
22196 A non-zero code is taken to mean that the transport filter encountered some
22197 serious problem. Delivery of the message is deferred; the message remains on
22198 the queue and is tried again later. It is not possible to cause a message to be
22199 bounced from a transport filter.
22200
22201 If a transport filter is set on an autoreply transport, the original message is
22202 passed through the filter as it is being copied into the newly generated
22203 message, which happens if the &%return_message%& option is set.
22204
22205
22206 .option transport_filter_timeout transports time 5m
22207 .cindex "transport" "filter, timeout"
22208 When Exim is reading the output of a transport filter, it applies a timeout
22209 that can be set by this option. Exceeding the timeout is normally treated as a
22210 temporary delivery failure. However, if a transport filter is used with a
22211 &(pipe)& transport, a timeout in the transport filter is treated in the same
22212 way as a timeout in the pipe command itself. By default, a timeout is a hard
22213 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22214 becomes a temporary error.
22215
22216
22217 .option user transports string&!! "Exim user"
22218 .cindex "uid (user id)" "local delivery"
22219 .cindex "transport" "user, specifying"
22220 This option specifies the user under whose uid the delivery process is to be
22221 run, overriding any uid that may have been set by the router. If the user is
22222 given as a name, the uid is looked up from the password data, and the
22223 associated group is taken as the value of the gid to be used if the &%group%&
22224 option is not set.
22225
22226 For deliveries that use local transports, a user and group are normally
22227 specified explicitly or implicitly (for example, as a result of
22228 &%check_local_user%&) by the router or transport.
22229
22230 .cindex "hints database" "access by remote transport"
22231 For remote transports, you should leave this option unset unless you really are
22232 sure you know what you are doing. When a remote transport is running, it needs
22233 to be able to access Exim's hints databases, because each host may have its own
22234 retry data.
22235 .ecindex IIDgenoptra1
22236 .ecindex IIDgenoptra2
22237 .ecindex IIDgenoptra3
22238
22239
22240
22241
22242
22243
22244 . ////////////////////////////////////////////////////////////////////////////
22245 . ////////////////////////////////////////////////////////////////////////////
22246
22247 .chapter "Address batching in local transports" "CHAPbatching" &&&
22248          "Address batching"
22249 .cindex "transport" "local; address batching in"
22250 The only remote transport (&(smtp)&) is normally configured to handle more than
22251 one address at a time, so that when several addresses are routed to the same
22252 remote host, just one copy of the message is sent. Local transports, however,
22253 normally handle one address at a time. That is, a separate instance of the
22254 transport is run for each address that is routed to the transport. A separate
22255 copy of the message is delivered each time.
22256
22257 .cindex "batched local delivery"
22258 .oindex "&%batch_max%&"
22259 .oindex "&%batch_id%&"
22260 In special cases, it may be desirable to handle several addresses at once in a
22261 local transport, for example:
22262
22263 .ilist
22264 In an &(appendfile)& transport, when storing messages in files for later
22265 delivery by some other means, a single copy of the message with multiple
22266 recipients saves space.
22267 .next
22268 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22269 a single copy saves time, and is the normal way LMTP is expected to work.
22270 .next
22271 In a &(pipe)& transport, when passing the message
22272 to a scanner program or
22273 to some other delivery mechanism such as UUCP, multiple recipients may be
22274 acceptable.
22275 .endlist
22276
22277 These three local transports all have the same options for controlling multiple
22278 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22279 repeating the information for each transport, these options are described here.
22280
22281 The &%batch_max%& option specifies the maximum number of addresses that can be
22282 delivered together in a single run of the transport. Its default value is one
22283 (no batching). When more than one address is routed to a transport that has a
22284 &%batch_max%& value greater than one, the addresses are delivered in a batch
22285 (that is, in a single run of the transport with multiple recipients), subject
22286 to certain conditions:
22287
22288 .ilist
22289 .vindex "&$local_part$&"
22290 If any of the transport's options contain a reference to &$local_part$&, no
22291 batching is possible.
22292 .next
22293 .vindex "&$domain$&"
22294 If any of the transport's options contain a reference to &$domain$&, only
22295 addresses with the same domain are batched.
22296 .next
22297 .cindex "customizing" "batching condition"
22298 If &%batch_id%& is set, it is expanded for each address, and only those
22299 addresses with the same expanded value are batched. This allows you to specify
22300 customized batching conditions. Failure of the expansion for any reason,
22301 including forced failure, disables batching, but it does not stop the delivery
22302 from taking place.
22303 .next
22304 Batched addresses must also have the same errors address (where to send
22305 delivery errors), the same header additions and removals, the same user and
22306 group for the transport, and if a host list is present, the first host must
22307 be the same.
22308 .endlist
22309
22310 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22311 both when the file or pipe command is specified in the transport, and when it
22312 is specified by a &(redirect)& router, but all the batched addresses must of
22313 course be routed to the same file or pipe command. These two transports have an
22314 option called &%use_bsmtp%&, which causes them to deliver the message in
22315 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22316 &%check_string%& and &%escape_string%& options are forced to the values
22317 .code
22318 check_string = "."
22319 escape_string = ".."
22320 .endd
22321 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22322 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22323 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22324
22325 .cindex "&'Envelope-to:'& header line"
22326 If the generic &%envelope_to_add%& option is set for a batching transport, the
22327 &'Envelope-to:'& header that is added to the message contains all the addresses
22328 that are being processed together. If you are using a batching &(appendfile)&
22329 transport without &%use_bsmtp%&, the only way to preserve the recipient
22330 addresses is to set the &%envelope_to_add%& option.
22331
22332 .cindex "&(pipe)& transport" "with multiple addresses"
22333 .vindex "&$pipe_addresses$&"
22334 If you are using a &(pipe)& transport without BSMTP, and setting the
22335 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22336 the command. This is not a true variable; it is a bit of magic that causes each
22337 of the recipient addresses to be inserted into the command as a separate
22338 argument. This provides a way of accessing all the addresses that are being
22339 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22340 are specified by a &(redirect)& router.
22341
22342
22343
22344
22345 . ////////////////////////////////////////////////////////////////////////////
22346 . ////////////////////////////////////////////////////////////////////////////
22347
22348 .chapter "The appendfile transport" "CHAPappendfile"
22349 .scindex IIDapptra1 "&(appendfile)& transport"
22350 .scindex IIDapptra2 "transports" "&(appendfile)&"
22351 .cindex "directory creation"
22352 .cindex "creating directories"
22353 The &(appendfile)& transport delivers a message by appending it to an existing
22354 file, or by creating an entirely new file in a specified directory. Single
22355 files to which messages are appended can be in the traditional Unix mailbox
22356 format, or optionally in the MBX format supported by the Pine MUA and
22357 University of Washington IMAP daemon, &'inter alia'&. When each message is
22358 being delivered as a separate file, &"maildir"& format can optionally be used
22359 to give added protection against failures that happen part-way through the
22360 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22361 supported. For all file formats, Exim attempts to create as many levels of
22362 directory as necessary, provided that &%create_directory%& is set.
22363
22364 The code for the optional formats is not included in the Exim binary by
22365 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22366 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22367 included.
22368
22369 .cindex "quota" "system"
22370 Exim recognizes system quota errors, and generates an appropriate message. Exim
22371 also supports its own quota control within the transport, for use when the
22372 system facility is unavailable or cannot be used for some reason.
22373
22374 If there is an error while appending to a file (for example, quota exceeded or
22375 partition filled), Exim attempts to reset the file's length and last
22376 modification time back to what they were before. If there is an error while
22377 creating an entirely new file, the new file is removed.
22378
22379 Before appending to a file, a number of security checks are made, and the
22380 file is locked. A detailed description is given below, after the list of
22381 private options.
22382
22383 The &(appendfile)& transport is most commonly used for local deliveries to
22384 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22385 putting messages into files for remote delivery by some means other than Exim.
22386 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22387 option).
22388
22389
22390
22391 .section "The file and directory options" "SECTfildiropt"
22392 The &%file%& option specifies a single file, to which the message is appended;
22393 the &%directory%& option specifies a directory, in which a new file containing
22394 the message is created. Only one of these two options can be set, and for
22395 normal deliveries to mailboxes, one of them &'must'& be set.
22396
22397 .vindex "&$address_file$&"
22398 .vindex "&$local_part$&"
22399 However, &(appendfile)& is also used for delivering messages to files or
22400 directories whose names (or parts of names) are obtained from alias,
22401 forwarding, or filtering operations (for example, a &%save%& command in a
22402 user's Exim filter). When such a transport is running, &$local_part$& contains
22403 the local part that was aliased or forwarded, and &$address_file$& contains the
22404 name (or partial name) of the file or directory generated by the redirection
22405 operation. There are two cases:
22406
22407 .ilist
22408 If neither &%file%& nor &%directory%& is set, the redirection operation
22409 must specify an absolute path (one that begins with &`/`&). This is the most
22410 common case when users with local accounts use filtering to sort mail into
22411 different folders. See for example, the &(address_file)& transport in the
22412 default configuration. If the path ends with a slash, it is assumed to be the
22413 name of a directory. A delivery to a directory can also be forced by setting
22414 &%maildir_format%& or &%mailstore_format%&.
22415 .next
22416 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22417 used to determine the file or directory name for the delivery. Normally, the
22418 contents of &$address_file$& are used in some way in the string expansion.
22419 .endlist
22420 .new
22421 .cindex "tainted data" "in filenames"
22422 .cindex appendfile "tainted data"
22423 Tainted data may not be used for a file or directory name.
22424 This means that, for instance, &$local_part$& cannot be used directly
22425 as a component of a path.  It can however be used as the key for a lookup
22426 which returns a path (or component).
22427 .wen
22428
22429
22430 .cindex "Sieve filter" "configuring &(appendfile)&"
22431 .cindex "Sieve filter" "relative mailbox path handling"
22432 As an example of the second case, consider an environment where users do not
22433 have home directories. They may be permitted to use Exim filter commands of the
22434 form:
22435 .code
22436 save folder23
22437 .endd
22438 or Sieve filter commands of the form:
22439 .code
22440 require "fileinto";
22441 fileinto "folder23";
22442 .endd
22443 In this situation, the expansion of &%file%& or &%directory%& in the transport
22444 must transform the relative path into an appropriate absolute filename. In the
22445 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22446 is used as a result of a &"keep"& action in the filter. This example shows one
22447 way of handling this requirement:
22448 .code
22449 file = ${if eq{$address_file}{inbox} \
22450             {/var/mail/$local_part} \
22451             {${if eq{${substr_0_1:$address_file}}{/} \
22452                   {$address_file} \
22453                   {$home/mail/$address_file} \
22454             }} \
22455        }
22456 .endd
22457 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22458 location, absolute paths are used without change, and other folders are in the
22459 &_mail_& directory within the home directory.
22460
22461 &*Note 1*&: While processing an Exim filter, a relative path such as
22462 &_folder23_& is turned into an absolute path if a home directory is known to
22463 the router. In particular, this is the case if &%check_local_user%& is set. If
22464 you want to prevent this happening at routing time, you can set
22465 &%router_home_directory%& empty. This forces the router to pass the relative
22466 path to the transport.
22467
22468 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22469 the &%file%& or &%directory%& option is still used if it is set.
22470
22471
22472
22473
22474 .section "Private options for appendfile" "SECID134"
22475 .cindex "options" "&(appendfile)& transport"
22476
22477
22478
22479 .option allow_fifo appendfile boolean false
22480 .cindex "fifo (named pipe)"
22481 .cindex "named pipe (fifo)"
22482 .cindex "pipe" "named (fifo)"
22483 Setting this option permits delivery to named pipes (FIFOs) as well as to
22484 regular files. If no process is reading the named pipe at delivery time, the
22485 delivery is deferred.
22486
22487
22488 .option allow_symlink appendfile boolean false
22489 .cindex "symbolic link" "to mailbox"
22490 .cindex "mailbox" "symbolic link"
22491 By default, &(appendfile)& will not deliver if the path name for the file is
22492 that of a symbolic link. Setting this option relaxes that constraint, but there
22493 are security issues involved in the use of symbolic links. Be sure you know
22494 what you are doing if you set this. Details of exactly what this option affects
22495 are included in the discussion which follows this list of options.
22496
22497
22498 .option batch_id appendfile string&!! unset
22499 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22500 However, batching is automatically disabled for &(appendfile)& deliveries that
22501 happen as a result of forwarding or aliasing or other redirection directly to a
22502 file.
22503
22504
22505 .option batch_max appendfile integer 1
22506 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22507
22508
22509 .option check_group appendfile boolean false
22510 When this option is set, the group owner of the file defined by the &%file%&
22511 option is checked to see that it is the same as the group under which the
22512 delivery process is running. The default setting is false because the default
22513 file mode is 0600, which means that the group is irrelevant.
22514
22515
22516 .option check_owner appendfile boolean true
22517 When this option is set, the owner of the file defined by the &%file%& option
22518 is checked to ensure that it is the same as the user under which the delivery
22519 process is running.
22520
22521
22522 .option check_string appendfile string "see below"
22523 .cindex "&""From""& line"
22524 As &(appendfile)& writes the message, the start of each line is tested for
22525 matching &%check_string%&, and if it does, the initial matching characters are
22526 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22527 a literal string, not a regular expression, and the case of any letters it
22528 contains is significant.
22529
22530 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22531 are forced to &"."& and &".."& respectively, and any settings in the
22532 configuration are ignored. Otherwise, they default to &"From&~"& and
22533 &">From&~"& when the &%file%& option is set, and unset when any of the
22534 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22535
22536 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22537 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22538 &"From&~"& indicates the start of a new message. All four options need changing
22539 if another format is used. For example, to deliver to mailboxes in MMDF format:
22540 .cindex "MMDF format mailbox"
22541 .cindex "mailbox" "MMDF format"
22542 .code
22543 check_string = "\1\1\1\1\n"
22544 escape_string = "\1\1\1\1 \n"
22545 message_prefix = "\1\1\1\1\n"
22546 message_suffix = "\1\1\1\1\n"
22547 .endd
22548 .option create_directory appendfile boolean true
22549 .cindex "directory creation"
22550 When this option is true, Exim attempts to create any missing superior
22551 directories for the file that it is about to write. A created directory's mode
22552 is given by the &%directory_mode%& option.
22553
22554 The group ownership of a newly created directory is highly dependent on the
22555 operating system (and possibly the file system) that is being used. For
22556 example, in Solaris, if the parent directory has the setgid bit set, its group
22557 is propagated to the child; if not, the currently set group is used. However,
22558 in FreeBSD, the parent's group is always used.
22559
22560
22561
22562 .option create_file appendfile string anywhere
22563 This option constrains the location of files and directories that are created
22564 by this transport. It applies to files defined by the &%file%& option and
22565 directories defined by the &%directory%& option. In the case of maildir
22566 delivery, it applies to the top level directory, not the maildir directories
22567 beneath.
22568
22569 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22570 &"belowhome"&. In the second and third cases, a home directory must have been
22571 set for the transport. This option is not useful when an explicit filename is
22572 given for normal mailbox deliveries. It is intended for the case when filenames
22573 are generated from users' &_.forward_& files. These are usually handled
22574 by an &(appendfile)& transport called &%address_file%&. See also
22575 &%file_must_exist%&.
22576
22577
22578 .option directory appendfile string&!! unset
22579 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22580 or &%directory%& must be set, unless the delivery is the direct result of a
22581 redirection (see section &<<SECTfildiropt>>&).
22582
22583 When &%directory%& is set, the string is expanded, and the message is delivered
22584 into a new file or files in or below the given directory, instead of being
22585 appended to a single mailbox file. A number of different formats are provided
22586 (see &%maildir_format%& and &%mailstore_format%&), and see section
22587 &<<SECTopdir>>& for further details of this form of delivery.
22588
22589
22590 .option directory_file appendfile string&!! "see below"
22591 .cindex "base62"
22592 .vindex "&$inode$&"
22593 When &%directory%& is set, but neither &%maildir_format%& nor
22594 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22595 whose name is obtained by expanding this string. The default value is:
22596 .code
22597 q${base62:$tod_epoch}-$inode
22598 .endd
22599 This generates a unique name from the current time, in base 62 form, and the
22600 inode of the file. The variable &$inode$& is available only when expanding this
22601 option.
22602
22603
22604 .option directory_mode appendfile "octal integer" 0700
22605 If &(appendfile)& creates any directories as a result of the
22606 &%create_directory%& option, their mode is specified by this option.
22607
22608
22609 .option escape_string appendfile string "see description"
22610 See &%check_string%& above.
22611
22612
22613 .option file appendfile string&!! unset
22614 This option is mutually exclusive with the &%directory%& option, but one of
22615 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22616 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22617 specifies a single file, to which the message is appended. One or more of
22618 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22619 &%file%&.
22620
22621 .cindex "NFS" "lock file"
22622 .cindex "locking files"
22623 .cindex "lock files"
22624 If you are using more than one host to deliver over NFS into the same
22625 mailboxes, you should always use lock files.
22626
22627 The string value is expanded for each delivery, and must yield an absolute
22628 path. The most common settings of this option are variations on one of these
22629 examples:
22630 .code
22631 file = /var/spool/mail/$local_part
22632 file = /home/$local_part/inbox
22633 file = $home/inbox
22634 .endd
22635 .cindex "&""sticky""& bit"
22636 In the first example, all deliveries are done into the same directory. If Exim
22637 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22638 create a file in the directory, so the &"sticky"& bit must be turned on for
22639 deliveries to be possible, or alternatively the &%group%& option can be used to
22640 run the delivery under a group id which has write access to the directory.
22641
22642
22643
22644 .option file_format appendfile string unset
22645 .cindex "file" "mailbox; checking existing format"
22646 This option requests the transport to check the format of an existing file
22647 before adding to it. The check consists of matching a specific string at the
22648 start of the file. The value of the option consists of an even number of
22649 colon-separated strings. The first of each pair is the test string, and the
22650 second is the name of a transport. If the transport associated with a matched
22651 string is not the current transport, control is passed over to the other
22652 transport. For example, suppose the standard &(local_delivery)& transport has
22653 this added to it:
22654 .code
22655 file_format = "From       : local_delivery :\
22656                \1\1\1\1\n : local_mmdf_delivery"
22657 .endd
22658 Mailboxes that begin with &"From"& are still handled by this transport, but if
22659 a mailbox begins with four binary ones followed by a newline, control is passed
22660 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22661 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22662 is assumed to match the current transport. If the start of a mailbox doesn't
22663 match any string, or if the transport named for a given string is not defined,
22664 delivery is deferred.
22665
22666
22667 .option file_must_exist appendfile boolean false
22668 If this option is true, the file specified by the &%file%& option must exist.
22669 A temporary error occurs if it does not, causing delivery to be deferred.
22670 If this option is false, the file is created if it does not exist.
22671
22672
22673 .option lock_fcntl_timeout appendfile time 0s
22674 .cindex "timeout" "mailbox locking"
22675 .cindex "mailbox" "locking, blocking and non-blocking"
22676 .cindex "locking files"
22677 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22678 when locking an open mailbox file. If the call fails, the delivery process
22679 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22680 Non-blocking calls are used so that the file is not kept open during the wait
22681 for the lock; the reason for this is to make it as safe as possible for
22682 deliveries over NFS in the case when processes might be accessing an NFS
22683 mailbox without using a lock file. This should not be done, but
22684 misunderstandings and hence misconfigurations are not unknown.
22685
22686 On a busy system, however, the performance of a non-blocking lock approach is
22687 not as good as using a blocking lock with a timeout. In this case, the waiting
22688 is done inside the system call, and Exim's delivery process acquires the lock
22689 and can proceed as soon as the previous lock holder releases it.
22690
22691 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22692 timeout, are used. There may still be some retrying: the maximum number of
22693 retries is
22694 .code
22695 (lock_retries * lock_interval) / lock_fcntl_timeout
22696 .endd
22697 rounded up to the next whole number. In other words, the total time during
22698 which &(appendfile)& is trying to get a lock is roughly the same, unless
22699 &%lock_fcntl_timeout%& is set very large.
22700
22701 You should consider setting this option if you are getting a lot of delayed
22702 local deliveries because of errors of the form
22703 .code
22704 failed to lock mailbox /some/file (fcntl)
22705 .endd
22706
22707 .option lock_flock_timeout appendfile time 0s
22708 This timeout applies to file locking when using &[flock()]& (see
22709 &%use_flock%&); the timeout operates in a similar manner to
22710 &%lock_fcntl_timeout%&.
22711
22712
22713 .option lock_interval appendfile time 3s
22714 This specifies the time to wait between attempts to lock the file. See below
22715 for details of locking.
22716
22717
22718 .option lock_retries appendfile integer 10
22719 This specifies the maximum number of attempts to lock the file. A value of zero
22720 is treated as 1. See below for details of locking.
22721
22722
22723 .option lockfile_mode appendfile "octal integer" 0600
22724 This specifies the mode of the created lock file, when a lock file is being
22725 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22726
22727
22728 .option lockfile_timeout appendfile time 30m
22729 .cindex "timeout" "mailbox locking"
22730 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22731 exists and is older than this value, it is assumed to have been left behind by
22732 accident, and Exim attempts to remove it.
22733
22734
22735 .option mailbox_filecount appendfile string&!! unset
22736 .cindex "mailbox" "specifying size of"
22737 .cindex "size" "of mailbox"
22738 If this option is set, it is expanded, and the result is taken as the current
22739 number of files in the mailbox. It must be a decimal number, optionally
22740 followed by K or M. This provides a way of obtaining this information from an
22741 external source that maintains the data.
22742
22743
22744 .option mailbox_size appendfile string&!! unset
22745 .cindex "mailbox" "specifying size of"
22746 .cindex "size" "of mailbox"
22747 If this option is set, it is expanded, and the result is taken as the current
22748 size the mailbox. It must be a decimal number, optionally followed by K or M.
22749 This provides a way of obtaining this information from an external source that
22750 maintains the data. This is likely to be helpful for maildir deliveries where
22751 it is computationally expensive to compute the size of a mailbox.
22752
22753
22754
22755 .option maildir_format appendfile boolean false
22756 .cindex "maildir format" "specifying"
22757 If this option is set with the &%directory%& option, the delivery is into a new
22758 file, in the &"maildir"& format that is used by other mail software. When the
22759 transport is activated directly from a &(redirect)& router (for example, the
22760 &(address_file)& transport in the default configuration), setting
22761 &%maildir_format%& causes the path received from the router to be treated as a
22762 directory, whether or not it ends with &`/`&. This option is available only if
22763 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22764 &<<SECTmaildirdelivery>>& below for further details.
22765
22766
22767 .option maildir_quota_directory_regex appendfile string "See below"
22768 .cindex "maildir format" "quota; directories included in"
22769 .cindex "quota" "maildir; directories included in"
22770 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22771 a regular expression for specifying directories, relative to the quota
22772 directory (see &%quota_directory%&), that should be included in the quota
22773 calculation. The default value is:
22774 .code
22775 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22776 .endd
22777 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22778 (directories whose names begin with a dot). If you want to exclude the
22779 &_Trash_&
22780 folder from the count (as some sites do), you need to change this setting to
22781 .code
22782 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22783 .endd
22784 This uses a negative lookahead in the regular expression to exclude the
22785 directory whose name is &_.Trash_&. When a directory is excluded from quota
22786 calculations, quota processing is bypassed for any messages that are delivered
22787 directly into that directory.
22788
22789
22790 .option maildir_retries appendfile integer 10
22791 This option specifies the number of times to retry when writing a file in
22792 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22793
22794
22795 .option maildir_tag appendfile string&!! unset
22796 This option applies only to deliveries in maildir format, and is described in
22797 section &<<SECTmaildirdelivery>>& below.
22798
22799
22800 .option maildir_use_size_file appendfile&!! boolean false
22801 .cindex "maildir format" "&_maildirsize_& file"
22802 The result of string expansion for this option must be a valid boolean value.
22803 If it is true, it enables support for &_maildirsize_& files. Exim
22804 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22805 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22806 value is zero. See &%maildir_quota_directory_regex%& above and section
22807 &<<SECTmaildirdelivery>>& below for further details.
22808
22809 .option maildirfolder_create_regex appendfile string unset
22810 .cindex "maildir format" "&_maildirfolder_& file"
22811 .cindex "&_maildirfolder_&, creating"
22812 The value of this option is a regular expression. If it is unset, it has no
22813 effect. Otherwise, before a maildir delivery takes place, the pattern is
22814 matched against the name of the maildir directory, that is, the directory
22815 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22816 delivery. If there is a match, Exim checks for the existence of a file called
22817 &_maildirfolder_& in the directory, and creates it if it does not exist.
22818 See section &<<SECTmaildirdelivery>>& for more details.
22819
22820
22821 .option mailstore_format appendfile boolean false
22822 .cindex "mailstore format" "specifying"
22823 If this option is set with the &%directory%& option, the delivery is into two
22824 new files in  &"mailstore"& format. The option is available only if
22825 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22826 below for further details.
22827
22828
22829 .option mailstore_prefix appendfile string&!! unset
22830 This option applies only to deliveries in mailstore format, and is described in
22831 section &<<SECTopdir>>& below.
22832
22833
22834 .option mailstore_suffix appendfile string&!! unset
22835 This option applies only to deliveries in mailstore format, and is described in
22836 section &<<SECTopdir>>& below.
22837
22838
22839 .option mbx_format appendfile boolean false
22840 .cindex "locking files"
22841 .cindex "file" "locking"
22842 .cindex "file" "MBX format"
22843 .cindex "MBX format, specifying"
22844 This option is available only if Exim has been compiled with SUPPORT_MBX
22845 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22846 the message is appended to the mailbox file in MBX format instead of
22847 traditional Unix format. This format is supported by Pine4 and its associated
22848 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22849
22850 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22851 automatically changed by the use of &%mbx_format%&. They should normally be set
22852 empty when using MBX format, so this option almost always appears in this
22853 combination:
22854 .code
22855 mbx_format = true
22856 message_prefix =
22857 message_suffix =
22858 .endd
22859 If none of the locking options are mentioned in the configuration,
22860 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22861 is possible to specify the other kinds of locking with &%mbx_format%&, but
22862 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22863 interworks with &'c-client'&, providing for shared access to the mailbox. It
22864 should not be used if any program that does not use this form of locking is
22865 going to access the mailbox, nor should it be used if the mailbox file is NFS
22866 mounted, because it works only when the mailbox is accessed from a single host.
22867
22868 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22869 the standard version of &'c-client'&, because as long as it has a mailbox open
22870 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22871 append messages to it.
22872
22873
22874 .option message_prefix appendfile string&!! "see below"
22875 .cindex "&""From""& line"
22876 The string specified here is expanded and output at the start of every message.
22877 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22878 in which case it is:
22879 .code
22880 message_prefix = "From ${if def:return_path{$return_path}\
22881   {MAILER-DAEMON}} $tod_bsdinbox\n"
22882 .endd
22883 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22884 &`\n`& to &`\r\n`& in &%message_prefix%&.
22885
22886 .option message_suffix appendfile string&!! "see below"
22887 The string specified here is expanded and output at the end of every message.
22888 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22889 in which case it is a single newline character. The suffix can be suppressed by
22890 setting
22891 .code
22892 message_suffix =
22893 .endd
22894 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22895 &`\n`& to &`\r\n`& in &%message_suffix%&.
22896
22897 .option mode appendfile "octal integer" 0600
22898 If the output file is created, it is given this mode. If it already exists and
22899 has wider permissions, they are reduced to this mode. If it has narrower
22900 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22901 if the delivery is the result of a &%save%& command in a filter file specifying
22902 a particular mode, the mode of the output file is always forced to take that
22903 value, and this option is ignored.
22904
22905
22906 .option mode_fail_narrower appendfile boolean true
22907 This option applies in the case when an existing mailbox file has a narrower
22908 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22909 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22910 continues with the delivery attempt, using the existing mode of the file.
22911
22912
22913 .option notify_comsat appendfile boolean false
22914 If this option is true, the &'comsat'& daemon is notified after every
22915 successful delivery to a user mailbox. This is the daemon that notifies logged
22916 on users about incoming mail.
22917
22918
22919 .option quota appendfile string&!! unset
22920 .cindex "quota" "imposed by Exim"
22921 This option imposes a limit on the size of the file to which Exim is appending,
22922 or to the total space used in the directory tree when the &%directory%& option
22923 is set. In the latter case, computation of the space used is expensive, because
22924 all the files in the directory (and any sub-directories) have to be
22925 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22926 &%maildir_use_size_file%& for ways to avoid this in environments where users
22927 have no shell access to their mailboxes).
22928
22929 As there is no interlock against two simultaneous deliveries into a
22930 multi-file mailbox, it is possible for the quota to be overrun in this case.
22931 For single-file mailboxes, of course, an interlock is a necessity.
22932
22933 A file's size is taken as its &'used'& value. Because of blocking effects, this
22934 may be a lot less than the actual amount of disk space allocated to the file.
22935 If the sizes of a number of files are being added up, the rounding effect can
22936 become quite noticeable, especially on systems that have large block sizes.
22937 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22938 the obvious value which users understand most easily.
22939
22940 The value of the option is expanded, and must then be a numerical value
22941 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22942 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22943 and further option modifiers. If Exim is running on a system with
22944 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22945 be handled.
22946
22947 The option modifier &%no_check%& can be used to force delivery even if the over
22948 quota condition is met. The quota gets updated as usual.
22949
22950 &*Note*&: A value of zero is interpreted as &"no quota"&.
22951
22952 The expansion happens while Exim is running as root, before it changes uid for
22953 the delivery. This means that files that are inaccessible to the end user can
22954 be used to hold quota values that are looked up in the expansion. When delivery
22955 fails because this quota is exceeded, the handling of the error is as for
22956 system quota failures.
22957
22958 By default, Exim's quota checking mimics system quotas, and restricts the
22959 mailbox to the specified maximum size, though the value is not accurate to the
22960 last byte, owing to separator lines and additional headers that may get added
22961 during message delivery. When a mailbox is nearly full, large messages may get
22962 refused even though small ones are accepted, because the size of the current
22963 message is added to the quota when the check is made. This behaviour can be
22964 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22965 for exceeding the quota does not include the current message. Thus, deliveries
22966 continue until the quota has been exceeded; thereafter, no further messages are
22967 delivered. See also &%quota_warn_threshold%&.
22968
22969
22970 .option quota_directory appendfile string&!! unset
22971 This option defines the directory to check for quota purposes when delivering
22972 into individual files. The default is the delivery directory, or, if a file
22973 called &_maildirfolder_& exists in a maildir directory, the parent of the
22974 delivery directory.
22975
22976
22977 .option quota_filecount appendfile string&!! 0
22978 This option applies when the &%directory%& option is set. It limits the total
22979 number of files in the directory (compare the inode limit in system quotas). It
22980 can only be used if &%quota%& is also set. The value is expanded; an expansion
22981 failure causes delivery to be deferred. A value of zero is interpreted as
22982 &"no quota"&.
22983
22984 The option modifier &%no_check%& can be used to force delivery even if the over
22985 quota condition is met. The quota gets updated as usual.
22986
22987 .option quota_is_inclusive appendfile boolean true
22988 See &%quota%& above.
22989
22990
22991 .option quota_size_regex appendfile string unset
22992 This option applies when one of the delivery modes that writes a separate file
22993 for each message is being used. When Exim wants to find the size of one of
22994 these files in order to test the quota, it first checks &%quota_size_regex%&.
22995 If this is set to a regular expression that matches the filename, and it
22996 captures one string, that string is interpreted as a representation of the
22997 file's size. The value of &%quota_size_regex%& is not expanded.
22998
22999 This feature is useful only when users have no shell access to their mailboxes
23000 &-- otherwise they could defeat the quota simply by renaming the files. This
23001 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23002 the file length to the filename. For example:
23003 .code
23004 maildir_tag = ,S=$message_size
23005 quota_size_regex = ,S=(\d+)
23006 .endd
23007 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23008 number of lines in the message.
23009
23010 The regular expression should not assume that the length is at the end of the
23011 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23012 sometimes add other information onto the ends of message filenames.
23013
23014 Section &<<SECID136>>& contains further information.
23015
23016 This option should not be used when other message-handling software
23017 may duplicate messages by making hardlinks to the files.  When that is done Exim
23018 will count the message size once for each filename, in contrast with the actual
23019 disk usage.  When the option is not set, calculating total usage requires
23020 a system-call per file to get the size; the number of links is then available also
23021 as is used to adjust the effective size.
23022
23023
23024 .option quota_warn_message appendfile string&!! "see below"
23025 See below for the use of this option. If it is not set when
23026 &%quota_warn_threshold%& is set, it defaults to
23027 .code
23028 quota_warn_message = "\
23029   To: $local_part@$domain\n\
23030   Subject: Your mailbox\n\n\
23031   This message is automatically created \
23032   by mail delivery software.\n\n\
23033   The size of your mailbox has exceeded \
23034   a warning threshold that is\n\
23035   set by the system administrator.\n"
23036 .endd
23037
23038
23039 .option quota_warn_threshold appendfile string&!! 0
23040 .cindex "quota" "warning threshold"
23041 .cindex "mailbox" "size warning"
23042 .cindex "size" "of mailbox"
23043 This option is expanded in the same way as &%quota%& (see above). If the
23044 resulting value is greater than zero, and delivery of the message causes the
23045 size of the file or total space in the directory tree to cross the given
23046 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23047 may be specified as a percentage of it by following the value with a percent
23048 sign. For example:
23049 .code
23050 quota = 10M
23051 quota_warn_threshold = 75%
23052 .endd
23053 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23054 percent sign is ignored.
23055
23056 The warning message itself is specified by the &%quota_warn_message%& option,
23057 and it must start with a &'To:'& header line containing the recipient(s) of the
23058 warning message. These do not necessarily have to include the recipient(s) of
23059 the original message. A &'Subject:'& line should also normally be supplied. You
23060 can include any other header lines that you want. If you do not include a
23061 &'From:'& line, the default is:
23062 .code
23063 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23064 .endd
23065 .oindex &%errors_reply_to%&
23066 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23067 option.
23068
23069 The &%quota%& option does not have to be set in order to use this option; they
23070 are independent of one another except when the threshold is specified as a
23071 percentage.
23072
23073
23074 .option use_bsmtp appendfile boolean false
23075 .cindex "envelope from"
23076 .cindex "envelope sender"
23077 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23078 format, with the envelope sender and recipient(s) included as SMTP commands. If
23079 you want to include a leading HELO command with such messages, you can do
23080 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23081 for details of batch SMTP.
23082
23083
23084 .option use_crlf appendfile boolean false
23085 .cindex "carriage return"
23086 .cindex "linefeed"
23087 This option causes lines to be terminated with the two-character CRLF sequence
23088 (carriage return, linefeed) instead of just a linefeed character. In the case
23089 of batched SMTP, the byte sequence written to the file is then an exact image
23090 of what would be sent down a real SMTP connection.
23091
23092 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23093 (which are used to supply the traditional &"From&~"& and blank line separators
23094 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23095 carriage return characters if these are needed. In cases where these options
23096 have non-empty defaults, the values end with a single linefeed, so they must be
23097 changed to end with &`\r\n`& if &%use_crlf%& is set.
23098
23099
23100 .option use_fcntl_lock appendfile boolean "see below"
23101 This option controls the use of the &[fcntl()]& function to lock a file for
23102 exclusive use when a message is being appended. It is set by default unless
23103 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23104 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23105 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23106
23107
23108 .option use_flock_lock appendfile boolean false
23109 This option is provided to support the use of &[flock()]& for file locking, for
23110 the few situations where it is needed. Most modern operating systems support
23111 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23112 each other. Exim uses &[fcntl()]& locking by default.
23113
23114 This option is required only if you are using an operating system where
23115 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23116 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23117 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23118
23119 .cindex "Solaris" "&[flock()]& support"
23120 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23121 have it (and some, I think, provide a not quite right version built on top of
23122 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23123 the ability to use it, and any attempt to do so will cause a configuration
23124 error.
23125
23126 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23127 is just being mapped onto &[fcntl()]& by the OS).
23128
23129
23130 .option use_lockfile appendfile boolean "see below"
23131 If this option is turned off, Exim does not attempt to create a lock file when
23132 appending to a mailbox file. In this situation, the only locking is by
23133 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23134 sure that every MUA that is ever going to look at your users' mailboxes uses
23135 &[fcntl()]& rather than a lock file, and even then only when you are not
23136 delivering over NFS from more than one host.
23137
23138 .cindex "NFS" "lock file"
23139 In order to append to an NFS file safely from more than one host, it is
23140 necessary to take out a lock &'before'& opening the file, and the lock file
23141 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23142 file corruption.
23143
23144 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23145 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23146 except when &%mbx_format%& is set.
23147
23148
23149 .option use_mbx_lock appendfile boolean "see below"
23150 This option is available only if Exim has been compiled with SUPPORT_MBX
23151 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23152 locking rules be used. It is set by default if &%mbx_format%& is set and none
23153 of the locking options are mentioned in the configuration. The locking rules
23154 are the same as are used by the &'c-client'& library that underlies Pine and
23155 the IMAP4 and POP daemons that come with it (see the discussion below). The
23156 rules allow for shared access to the mailbox. However, this kind of locking
23157 does not work when the mailbox is NFS mounted.
23158
23159 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23160 &%use_flock_lock%& to control what kind of locking is used in implementing the
23161 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23162 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23163
23164
23165
23166
23167 .section "Operational details for appending" "SECTopappend"
23168 .cindex "appending to a file"
23169 .cindex "file" "appending"
23170 Before appending to a file, the following preparations are made:
23171
23172 .ilist
23173 If the name of the file is &_/dev/null_&, no action is taken, and a success
23174 return is given.
23175
23176 .next
23177 .cindex "directory creation"
23178 If any directories on the file's path are missing, Exim creates them if the
23179 &%create_directory%& option is set. A created directory's mode is given by the
23180 &%directory_mode%& option.
23181
23182 .next
23183 If &%file_format%& is set, the format of an existing file is checked. If this
23184 indicates that a different transport should be used, control is passed to that
23185 transport.
23186
23187 .next
23188 .cindex "file" "locking"
23189 .cindex "locking files"
23190 .cindex "NFS" "lock file"
23191 If &%use_lockfile%& is set, a lock file is built in a way that will work
23192 reliably over NFS, as follows:
23193
23194 .olist
23195 Create a &"hitching post"& file whose name is that of the lock file with the
23196 current time, primary host name, and process id added, by opening for writing
23197 as a new file. If this fails with an access error, delivery is deferred.
23198 .next
23199 Close the hitching post file, and hard link it to the lock filename.
23200 .next
23201 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23202 Unlink the hitching post name.
23203 .next
23204 Otherwise, use &[stat()]& to get information about the hitching post file, and
23205 then unlink hitching post name. If the number of links is exactly two, creation
23206 of the lock file succeeded but something (for example, an NFS server crash and
23207 restart) caused this fact not to be communicated to the &[link()]& call.
23208 .next
23209 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23210 up to &%lock_retries%& times. However, since any program that writes to a
23211 mailbox should complete its task very quickly, it is reasonable to time out old
23212 lock files that are normally the result of user agent and system crashes. If an
23213 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23214 it before trying again.
23215 .endlist olist
23216
23217 .next
23218 A call is made to &[lstat()]& to discover whether the main file exists, and if
23219 so, what its characteristics are. If &[lstat()]& fails for any reason other
23220 than non-existence, delivery is deferred.
23221
23222 .next
23223 .cindex "symbolic link" "to mailbox"
23224 .cindex "mailbox" "symbolic link"
23225 If the file does exist and is a symbolic link, delivery is deferred, unless the
23226 &%allow_symlink%& option is set, in which case the ownership of the link is
23227 checked, and then &[stat()]& is called to find out about the real file, which
23228 is then subjected to the checks below. The check on the top-level link
23229 ownership prevents one user creating a link for another's mailbox in a sticky
23230 directory, though allowing symbolic links in this case is definitely not a good
23231 idea. If there is a chain of symbolic links, the intermediate ones are not
23232 checked.
23233
23234 .next
23235 If the file already exists but is not a regular file, or if the file's owner
23236 and group (if the group is being checked &-- see &%check_group%& above) are
23237 different from the user and group under which the delivery is running,
23238 delivery is deferred.
23239
23240 .next
23241 If the file's permissions are more generous than specified, they are reduced.
23242 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23243 is set false, in which case the delivery is tried using the existing
23244 permissions.
23245
23246 .next
23247 The file's inode number is saved, and the file is then opened for appending.
23248 If this fails because the file has vanished, &(appendfile)& behaves as if it
23249 hadn't existed (see below). For any other failures, delivery is deferred.
23250
23251 .next
23252 If the file is opened successfully, check that the inode number hasn't
23253 changed, that it is still a regular file, and that the owner and permissions
23254 have not changed. If anything is wrong, defer delivery and freeze the message.
23255
23256 .next
23257 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23258 option is set. Otherwise, check that the file is being created in a permitted
23259 directory if the &%create_file%& option is set (deferring on failure), and then
23260 open for writing as a new file, with the O_EXCL and O_CREAT options,
23261 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23262 set). In this case, which can happen if the link points to a non-existent file,
23263 the file is opened for writing using O_CREAT but not O_EXCL, because
23264 that prevents link following.
23265
23266 .next
23267 .cindex "loop" "while file testing"
23268 If opening fails because the file exists, obey the tests given above for
23269 existing files. However, to avoid looping in a situation where the file is
23270 being continuously created and destroyed, the exists/not-exists loop is broken
23271 after 10 repetitions, and the message is then frozen.
23272
23273 .next
23274 If opening fails with any other error, defer delivery.
23275
23276 .next
23277 .cindex "file" "locking"
23278 .cindex "locking files"
23279 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23280 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23281 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23282 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23283 file, and an exclusive lock on the file whose name is
23284 .code
23285 /tmp/.<device-number>.<inode-number>
23286 .endd
23287 using the device and inode numbers of the open mailbox file, in accordance with
23288 the MBX locking rules. This file is created with a mode that is specified by
23289 the &%lockfile_mode%& option.
23290
23291 If Exim fails to lock the file, there are two possible courses of action,
23292 depending on the value of the locking timeout. This is obtained from
23293 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23294
23295 If the timeout value is zero, the file is closed, Exim waits for
23296 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23297 to lock it again. This happens up to &%lock_retries%& times, after which the
23298 delivery is deferred.
23299
23300 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23301 &[flock()]& are used (with the given timeout), so there has already been some
23302 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23303 immediately. It retries up to
23304 .code
23305 (lock_retries * lock_interval) / <timeout>
23306 .endd
23307 times (rounded up).
23308 .endlist
23309
23310 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23311 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23312
23313
23314 .section "Operational details for delivery to a new file" "SECTopdir"
23315 .cindex "delivery" "to single file"
23316 .cindex "&""From""& line"
23317 When the &%directory%& option is set instead of &%file%&, each message is
23318 delivered into a newly-created file or set of files. When &(appendfile)& is
23319 activated directly from a &(redirect)& router, neither &%file%& nor
23320 &%directory%& is normally set, because the path for delivery is supplied by the
23321 router. (See for example, the &(address_file)& transport in the default
23322 configuration.) In this case, delivery is to a new file if either the path name
23323 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23324
23325 No locking is required while writing the message to a new file, so the various
23326 locking options of the transport are ignored. The &"From"& line that by default
23327 separates messages in a single file is not normally needed, nor is the escaping
23328 of message lines that start with &"From"&, and there is no need to ensure a
23329 newline at the end of each message. Consequently, the default values for
23330 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23331 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23332
23333 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23334 the files in the delivery directory by default. However, you can specify a
23335 different directory by setting &%quota_directory%&. Also, for maildir
23336 deliveries (see below) the &_maildirfolder_& convention is honoured.
23337
23338
23339 .cindex "maildir format"
23340 .cindex "mailstore format"
23341 There are three different ways in which delivery to individual files can be
23342 done, controlled by the settings of the &%maildir_format%& and
23343 &%mailstore_format%& options. Note that code to support maildir or mailstore
23344 formats is not included in the binary unless SUPPORT_MAILDIR or
23345 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23346
23347 .cindex "directory creation"
23348 In all three cases an attempt is made to create the directory and any necessary
23349 sub-directories if they do not exist, provided that the &%create_directory%&
23350 option is set (the default). The location of a created directory can be
23351 constrained by setting &%create_file%&. A created directory's mode is given by
23352 the &%directory_mode%& option. If creation fails, or if the
23353 &%create_directory%& option is not set when creation is required, delivery is
23354 deferred.
23355
23356
23357
23358 .section "Maildir delivery" "SECTmaildirdelivery"
23359 .cindex "maildir format" "description of"
23360 If the &%maildir_format%& option is true, Exim delivers each message by writing
23361 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23362 directory that is defined by the &%directory%& option (the &"delivery
23363 directory"&). If the delivery is successful, the file is renamed into the
23364 &_new_& subdirectory.
23365
23366 In the filename, <&'stime'&> is the current time of day in seconds, and
23367 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23368 Exim checks that the time-of-day clock has moved on by at least one microsecond
23369 before terminating the delivery process. This guarantees uniqueness for the
23370 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23371 opening it. If any response other than ENOENT (does not exist) is given,
23372 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23373
23374 Before Exim carries out a maildir delivery, it ensures that subdirectories
23375 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23376 do not exist, Exim tries to create them and any superior directories in their
23377 path, subject to the &%create_directory%& and &%create_file%& options. If the
23378 &%maildirfolder_create_regex%& option is set, and the regular expression it
23379 contains matches the delivery directory, Exim also ensures that a file called
23380 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23381 &_maildirfolder_& file cannot be created, delivery is deferred.
23382
23383 These features make it possible to use Exim to create all the necessary files
23384 and directories in a maildir mailbox, including subdirectories for maildir++
23385 folders. Consider this example:
23386 .code
23387 maildir_format = true
23388 directory = /var/mail/$local_part\
23389            ${if eq{$local_part_suffix}{}{}\
23390            {/.${substr_1:$local_part_suffix}}}
23391 maildirfolder_create_regex = /\.[^/]+$
23392 .endd
23393 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23394 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23395 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23396 not match this name, so Exim will not look for or create the file
23397 &_/var/mail/pimbo/maildirfolder_&, though it will create
23398 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23399
23400 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23401 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23402 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23403 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23404 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23405
23406 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23407 not inadvertently match the toplevel maildir directory, because a
23408 &_maildirfolder_& file at top level would completely break quota calculations.
23409
23410 .cindex "quota" "in maildir delivery"
23411 .cindex "maildir++"
23412 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23413 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23414 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23415 Exim assumes the directory is a maildir++ folder directory, which is one level
23416 down from the user's top level mailbox directory. This causes it to start at
23417 the parent directory instead of the current directory when calculating the
23418 amount of space used.
23419
23420 One problem with delivering into a multi-file mailbox is that it is
23421 computationally expensive to compute the size of the mailbox for quota
23422 checking. Various approaches have been taken to reduce the amount of work
23423 needed. The next two sections describe two of them. A third alternative is to
23424 use some external process for maintaining the size data, and use the expansion
23425 of the &%mailbox_size%& option as a way of importing it into Exim.
23426
23427
23428
23429
23430 .section "Using tags to record message sizes" "SECID135"
23431 If &%maildir_tag%& is set, the string is expanded for each delivery.
23432 When the maildir file is renamed into the &_new_& sub-directory, the
23433 tag is added to its name. However, if adding the tag takes the length of the
23434 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23435 the tag is dropped and the maildir file is created with no tag.
23436
23437
23438 .vindex "&$message_size$&"
23439 Tags can be used to encode the size of files in their names; see
23440 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23441 happens after the message has been written. The value of the &$message_size$&
23442 variable is set to the number of bytes actually written. If the expansion is
23443 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23444 be deferred. The expanded tag may contain any printing characters except &"/"&.
23445 Non-printing characters in the string are ignored; if the resulting string is
23446 empty, it is ignored. If it starts with an alphanumeric character, a leading
23447 colon is inserted; this default has not proven to be the path that popular
23448 maildir implementations have chosen (but changing it in Exim would break
23449 backwards compatibility).
23450
23451 For one common implementation, you might set:
23452 .code
23453 maildir_tag = ,S=${message_size}
23454 .endd
23455 but you should check the documentation of the other software to be sure.
23456
23457 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23458 as this allows Exim to extract the size from your tag, instead of having to
23459 &[stat()]& each message file.
23460
23461
23462 .section "Using a maildirsize file" "SECID136"
23463 .cindex "quota" "in maildir delivery"
23464 .cindex "maildir format" "&_maildirsize_& file"
23465 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23466 storing quota and message size information in a file called &_maildirsize_&
23467 within the toplevel maildir directory. If this file does not exist, Exim
23468 creates it, setting the quota from the &%quota%& option of the transport. If
23469 the maildir directory itself does not exist, it is created before any attempt
23470 to write a &_maildirsize_& file.
23471
23472 The &_maildirsize_& file is used to hold information about the sizes of
23473 messages in the maildir, thus speeding up quota calculations. The quota value
23474 in the file is just a cache; if the quota is changed in the transport, the new
23475 value overrides the cached value when the next message is delivered. The cache
23476 is maintained for the benefit of other programs that access the maildir and
23477 need to know the quota.
23478
23479 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23480 file is maintained (with a zero quota setting), but no quota is imposed.
23481
23482 A regular expression is available for controlling which directories in the
23483 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23484 See the description of the &%maildir_quota_directory_regex%& option above for
23485 details.
23486
23487
23488 .section "Mailstore delivery" "SECID137"
23489 .cindex "mailstore format" "description of"
23490 If the &%mailstore_format%& option is true, each message is written as two
23491 files in the given directory. A unique base name is constructed from the
23492 message id and the current delivery process, and the files that are written use
23493 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23494 contains the message's envelope, and the &_.msg_& file contains the message
23495 itself. The base name is placed in the variable &$mailstore_basename$&.
23496
23497 During delivery, the envelope is first written to a file with the suffix
23498 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23499 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23500 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23501 file before accessing either of them. An alternative approach is to wait for
23502 the absence of a &_.tmp_& file.
23503
23504 The envelope file starts with any text defined by the &%mailstore_prefix%&
23505 option, expanded and terminated by a newline if there isn't one. Then follows
23506 the sender address on one line, then all the recipient addresses, one per line.
23507 There can be more than one recipient only if the &%batch_max%& option is set
23508 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23509 appended to the file, followed by a newline if it does not end with one.
23510
23511 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23512 failure, it is ignored. Other expansion errors are treated as serious
23513 configuration errors, and delivery is deferred. The variable
23514 &$mailstore_basename$& is available for use during these expansions.
23515
23516
23517 .section "Non-special new file delivery" "SECID138"
23518 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23519 file is created directly in the named directory. For example, when delivering
23520 messages into files in batched SMTP format for later delivery to some host (see
23521 section &<<SECTbatchSMTP>>&), a setting such as
23522 .code
23523 directory = /var/bsmtp/$host
23524 .endd
23525 might be used. A message is written to a file with a temporary name, which is
23526 then renamed when the delivery is complete. The final name is obtained by
23527 expanding the contents of the &%directory_file%& option.
23528 .ecindex IIDapptra1
23529 .ecindex IIDapptra2
23530
23531
23532
23533
23534
23535
23536 . ////////////////////////////////////////////////////////////////////////////
23537 . ////////////////////////////////////////////////////////////////////////////
23538
23539 .chapter "The autoreply transport" "CHID8"
23540 .scindex IIDauttra1 "transports" "&(autoreply)&"
23541 .scindex IIDauttra2 "&(autoreply)& transport"
23542 The &(autoreply)& transport is not a true transport in that it does not cause
23543 the message to be transmitted. Instead, it generates a new mail message as an
23544 automatic reply to the incoming message. &'References:'& and
23545 &'Auto-Submitted:'& header lines are included. These are constructed according
23546 to the rules in RFCs 2822 and 3834, respectively.
23547
23548 If the router that passes the message to this transport does not have the
23549 &%unseen%& option set, the original message (for the current recipient) is not
23550 delivered anywhere. However, when the &%unseen%& option is set on the router
23551 that passes the message to this transport, routing of the address continues, so
23552 another router can set up a normal message delivery.
23553
23554
23555 The &(autoreply)& transport is usually run as the result of mail filtering, a
23556 &"vacation"& message being the standard example. However, it can also be run
23557 directly from a router like any other transport. To reduce the possibility of
23558 message cascades, messages created by the &(autoreply)& transport always have
23559 empty envelope sender addresses, like bounce messages.
23560
23561 The parameters of the message to be sent can be specified in the configuration
23562 by options described below. However, these are used only when the address
23563 passed to the transport does not contain its own reply information. When the
23564 transport is run as a consequence of a
23565 &%mail%&
23566 or &%vacation%& command in a filter file, the parameters of the message are
23567 supplied by the filter, and passed with the address. The transport's options
23568 that define the message are then ignored (so they are not usually set in this
23569 case). The message is specified entirely by the filter or by the transport; it
23570 is never built from a mixture of options. However, the &%file_optional%&,
23571 &%mode%&, and &%return_message%& options apply in all cases.
23572
23573 &(Autoreply)& is implemented as a local transport. When used as a result of a
23574 command in a user's filter file, &(autoreply)& normally runs under the uid and
23575 gid of the user, and with appropriate current and home directories (see chapter
23576 &<<CHAPenvironment>>&).
23577
23578 There is a subtle difference between routing a message to a &(pipe)& transport
23579 that generates some text to be returned to the sender, and routing it to an
23580 &(autoreply)& transport. This difference is noticeable only if more than one
23581 address from the same message is so handled. In the case of a pipe, the
23582 separate outputs from the different addresses are gathered up and returned to
23583 the sender in a single message, whereas if &(autoreply)& is used, a separate
23584 message is generated for each address that is passed to it.
23585
23586 Non-printing characters are not permitted in the header lines generated for the
23587 message that &(autoreply)& creates, with the exception of newlines that are
23588 immediately followed by white space. If any non-printing characters are found,
23589 the transport defers.
23590 Whether characters with the top bit set count as printing characters or not is
23591 controlled by the &%print_topbitchars%& global option.
23592
23593 If any of the generic options for manipulating headers (for example,
23594 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23595 of the original message that is included in the generated message when
23596 &%return_message%& is set. They do not apply to the generated message itself.
23597
23598 .vindex "&$sender_address$&"
23599 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23600 the message, indicating that there were no recipients, it does not treat this
23601 as an error. This means that autoreplies sent to &$sender_address$& when this
23602 is empty (because the incoming message is a bounce message) do not cause
23603 problems. They are just discarded.
23604
23605
23606
23607 .section "Private options for autoreply" "SECID139"
23608 .cindex "options" "&(autoreply)& transport"
23609
23610 .option bcc autoreply string&!! unset
23611 This specifies the addresses that are to receive &"blind carbon copies"& of the
23612 message when the message is specified by the transport.
23613
23614
23615 .option cc autoreply string&!! unset
23616 This specifies recipients of the message and the contents of the &'Cc:'& header
23617 when the message is specified by the transport.
23618
23619
23620 .option file autoreply string&!! unset
23621 The contents of the file are sent as the body of the message when the message
23622 is specified by the transport. If both &%file%& and &%text%& are set, the text
23623 string comes first.
23624
23625
23626 .option file_expand autoreply boolean false
23627 If this is set, the contents of the file named by the &%file%& option are
23628 subjected to string expansion as they are added to the message.
23629
23630
23631 .option file_optional autoreply boolean false
23632 If this option is true, no error is generated if the file named by the &%file%&
23633 option or passed with the address does not exist or cannot be read.
23634
23635
23636 .option from autoreply string&!! unset
23637 This specifies the contents of the &'From:'& header when the message is
23638 specified by the transport.
23639
23640
23641 .option headers autoreply string&!! unset
23642 This specifies additional RFC 2822 headers that are to be added to the message
23643 when the message is specified by the transport. Several can be given by using
23644 &"\n"& to separate them. There is no check on the format.
23645
23646
23647 .option log autoreply string&!! unset
23648 This option names a file in which a record of every message sent is logged when
23649 the message is specified by the transport.
23650
23651
23652 .option mode autoreply "octal integer" 0600
23653 If either the log file or the &"once"& file has to be created, this mode is
23654 used.
23655
23656
23657 .option never_mail autoreply "address list&!!" unset
23658 If any run of the transport creates a message with a recipient that matches any
23659 item in the list, that recipient is quietly discarded. If all recipients are
23660 discarded, no message is created. This applies both when the recipients are
23661 generated by a filter and when they are specified in the transport.
23662
23663
23664
23665 .option once autoreply string&!! unset
23666 This option names a file or DBM database in which a record of each &'To:'&
23667 recipient is kept when the message is specified by the transport. &*Note*&:
23668 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23669
23670 If &%once%& is unset, or is set to an empty string, the message is always sent.
23671 By default, if &%once%& is set to a non-empty filename, the message
23672 is not sent if a potential recipient is already listed in the database.
23673 However, if the &%once_repeat%& option specifies a time greater than zero, the
23674 message is sent if that much time has elapsed since a message was last sent to
23675 this recipient. A setting of zero time for &%once_repeat%& (the default)
23676 prevents a message from being sent a second time &-- in this case, zero means
23677 infinity.
23678
23679 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23680 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23681 greater than zero, it changes the way Exim implements the &%once%& option.
23682 Instead of using a DBM file to record every recipient it sends to, it uses a
23683 regular file, whose size will never get larger than the given value.
23684
23685 In the file, Exim keeps a linear list of recipient addresses and the times at
23686 which they were sent messages. If the file is full when a new address needs to
23687 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23688 means that a given recipient may receive multiple messages, but at
23689 unpredictable intervals that depend on the rate of turnover of addresses in the
23690 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23691
23692
23693 .option once_file_size autoreply integer 0
23694 See &%once%& above.
23695
23696
23697 .option once_repeat autoreply time&!! 0s
23698 See &%once%& above.
23699 After expansion, the value of this option must be a valid time value.
23700
23701
23702 .option reply_to autoreply string&!! unset
23703 This specifies the contents of the &'Reply-To:'& header when the message is
23704 specified by the transport.
23705
23706
23707 .option return_message autoreply boolean false
23708 If this is set, a copy of the original message is returned with the new
23709 message, subject to the maximum size set in the &%return_size_limit%& global
23710 configuration option.
23711
23712
23713 .option subject autoreply string&!! unset
23714 This specifies the contents of the &'Subject:'& header when the message is
23715 specified by the transport. It is tempting to quote the original subject in
23716 automatic responses. For example:
23717 .code
23718 subject = Re: $h_subject:
23719 .endd
23720 There is a danger in doing this, however. It may allow a third party to
23721 subscribe your users to an opt-in mailing list, provided that the list accepts
23722 bounce messages as subscription confirmations. Well-managed lists require a
23723 non-bounce message to confirm a subscription, so the danger is relatively
23724 small.
23725
23726
23727
23728 .option text autoreply string&!! unset
23729 This specifies a single string to be used as the body of the message when the
23730 message is specified by the transport. If both &%text%& and &%file%& are set,
23731 the text comes first.
23732
23733
23734 .option to autoreply string&!! unset
23735 This specifies recipients of the message and the contents of the &'To:'& header
23736 when the message is specified by the transport.
23737 .ecindex IIDauttra1
23738 .ecindex IIDauttra2
23739
23740
23741
23742
23743 . ////////////////////////////////////////////////////////////////////////////
23744 . ////////////////////////////////////////////////////////////////////////////
23745
23746 .chapter "The lmtp transport" "CHAPLMTP"
23747 .cindex "transports" "&(lmtp)&"
23748 .cindex "&(lmtp)& transport"
23749 .cindex "LMTP" "over a pipe"
23750 .cindex "LMTP" "over a socket"
23751 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23752 specified command
23753 or by interacting with a Unix domain socket.
23754 This transport is something of a cross between the &(pipe)& and &(smtp)&
23755 transports. Exim also has support for using LMTP over TCP/IP; this is
23756 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23757 to be of minority interest, the default build-time configure in &_src/EDITME_&
23758 has it commented out. You need to ensure that
23759 .code
23760 TRANSPORT_LMTP=yes
23761 .endd
23762 .cindex "options" "&(lmtp)& transport"
23763 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23764 included in the Exim binary. The private options of the &(lmtp)& transport are
23765 as follows:
23766
23767 .option batch_id lmtp string&!! unset
23768 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23769
23770
23771 .option batch_max lmtp integer 1
23772 This limits the number of addresses that can be handled in a single delivery.
23773 Most LMTP servers can handle several addresses at once, so it is normally a
23774 good idea to increase this value. See the description of local delivery
23775 batching in chapter &<<CHAPbatching>>&.
23776
23777
23778 .option command lmtp string&!! unset
23779 This option must be set if &%socket%& is not set. The string is a command which
23780 is run in a separate process. It is split up into a command name and list of
23781 arguments, each of which is separately expanded (so expansion cannot change the
23782 number of arguments). The command is run directly, not via a shell. The message
23783 is passed to the new process using the standard input and output to operate the
23784 LMTP protocol.
23785
23786 .option ignore_quota lmtp boolean false
23787 .cindex "LMTP" "ignoring quota errors"
23788 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23789 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23790 in its response to the LHLO command.
23791
23792 .option socket lmtp string&!! unset
23793 This option must be set if &%command%& is not set. The result of expansion must
23794 be the name of a Unix domain socket. The transport connects to the socket and
23795 delivers the message to it using the LMTP protocol.
23796
23797
23798 .option timeout lmtp time 5m
23799 The transport is aborted if the created process or Unix domain socket does not
23800 respond to LMTP commands or message input within this timeout. Delivery
23801 is deferred, and will be tried again later. Here is an example of a typical
23802 LMTP transport:
23803 .code
23804 lmtp:
23805   driver = lmtp
23806   command = /some/local/lmtp/delivery/program
23807   batch_max = 20
23808   user = exim
23809 .endd
23810 This delivers up to 20 addresses at a time, in a mixture of domains if
23811 necessary, running as the user &'exim'&.
23812
23813
23814
23815 . ////////////////////////////////////////////////////////////////////////////
23816 . ////////////////////////////////////////////////////////////////////////////
23817
23818 .chapter "The pipe transport" "CHAPpipetransport"
23819 .scindex IIDpiptra1 "transports" "&(pipe)&"
23820 .scindex IIDpiptra2 "&(pipe)& transport"
23821 The &(pipe)& transport is used to deliver messages via a pipe to a command
23822 running in another process. One example is the use of &(pipe)& as a
23823 pseudo-remote transport for passing messages to some other delivery mechanism
23824 (such as UUCP). Another is the use by individual users to automatically process
23825 their incoming messages. The &(pipe)& transport can be used in one of the
23826 following ways:
23827
23828 .ilist
23829 .vindex "&$local_part$&"
23830 A router routes one address to a transport in the normal way, and the
23831 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23832 contains the local part of the address (as usual), and the command that is run
23833 is specified by the &%command%& option on the transport.
23834 .next
23835 .vindex "&$pipe_addresses$&"
23836 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23837 transport can handle more than one address in a single run. In this case, when
23838 more than one address is routed to the transport, &$local_part$& is not set
23839 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23840 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23841 that are routed to the transport.
23842 .next
23843 .vindex "&$address_pipe$&"
23844 A router redirects an address directly to a pipe command (for example, from an
23845 alias or forward file). In this case, &$address_pipe$& contains the text of the
23846 pipe command, and the &%command%& option on the transport is ignored unless
23847 &%force_command%& is set. If only one address is being transported
23848 (&%batch_max%& is not greater than one, or only one address was redirected to
23849 this pipe command), &$local_part$& contains the local part that was redirected.
23850 .endlist
23851
23852
23853 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23854 deliver messages over pipes using the LMTP interactive protocol. This is
23855 implemented by the &(lmtp)& transport.
23856
23857 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23858 &_.forward_& file, the command runs under the uid and gid of that user. In
23859 other cases, the uid and gid have to be specified explicitly, either on the
23860 transport or on the router that handles the address. Current and &"home"&
23861 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23862 details of the local delivery environment and chapter &<<CHAPbatching>>&
23863 for a discussion of local delivery batching.
23864
23865 .new
23866 .cindex "tainted data" "in pipe command"
23867 .cindex pipe "tainted data"
23868 Tainted data may not be used for the command name.
23869 .wen
23870
23871
23872 .section "Concurrent delivery" "SECID140"
23873 If two messages arrive at almost the same time, and both are routed to a pipe
23874 delivery, the two pipe transports may be run concurrently. You must ensure that
23875 any pipe commands you set up are robust against this happening. If the commands
23876 write to a file, the &%exim_lock%& utility might be of use.
23877 Alternatively the &%max_parallel%& option could be used with a value
23878 of "1" to enforce serialization.
23879
23880
23881
23882
23883 .section "Returned status and data" "SECID141"
23884 .cindex "&(pipe)& transport" "returned data"
23885 If the command exits with a non-zero return code, the delivery is deemed to
23886 have failed, unless either the &%ignore_status%& option is set (in which case
23887 the return code is treated as zero), or the return code is one of those listed
23888 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23889 later"&. In this case, delivery is deferred. Details of a permanent failure are
23890 logged, but are not included in the bounce message, which merely contains
23891 &"local delivery failed"&.
23892
23893 If the command exits on a signal and the &%freeze_signal%& option is set then
23894 the message will be frozen in the queue. If that option is not set, a bounce
23895 will be sent as normal.
23896
23897 If the return code is greater than 128 and the command being run is a shell
23898 script, it normally means that the script was terminated by a signal whose
23899 value is the return code minus 128. The &%freeze_signal%& option does not
23900 apply in this case.
23901
23902 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23903 return code is set to 127. This is the value that a shell returns if it is
23904 asked to run a non-existent command. The wording for the log line suggests that
23905 a non-existent command may be the problem.
23906
23907 The &%return_output%& option can affect the result of a pipe delivery. If it is
23908 set and the command produces any output on its standard output or standard
23909 error streams, the command is considered to have failed, even if it gave a zero
23910 return code or if &%ignore_status%& is set. The output from the command is
23911 included as part of the bounce message. The &%return_fail_output%& option is
23912 similar, except that output is returned only when the command exits with a
23913 failure return code, that is, a value other than zero or a code that matches
23914 &%temp_errors%&.
23915
23916
23917
23918 .section "How the command is run" "SECThowcommandrun"
23919 .cindex "&(pipe)& transport" "path for command"
23920 The command line is (by default) broken down into a command name and arguments
23921 by the &(pipe)& transport itself. The &%allow_commands%& and
23922 &%restrict_to_path%& options can be used to restrict the commands that may be
23923 run.
23924
23925 .cindex "quoting" "in pipe command"
23926 Unquoted arguments are delimited by white space. If an argument appears in
23927 double quotes, backslash is interpreted as an escape character in the usual
23928 way. If an argument appears in single quotes, no escaping is done.
23929
23930 String expansion is applied to the command line except when it comes from a
23931 traditional &_.forward_& file (commands from a filter file are expanded). The
23932 expansion is applied to each argument in turn rather than to the whole line.
23933 For this reason, any string expansion item that contains white space must be
23934 quoted so as to be contained within a single argument. A setting such as
23935 .code
23936 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23937 .endd
23938 will not work, because the expansion item gets split between several
23939 arguments. You have to write
23940 .code
23941 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23942 .endd
23943 to ensure that it is all in one argument. The expansion is done in this way,
23944 argument by argument, so that the number of arguments cannot be changed as a
23945 result of expansion, and quotes or backslashes in inserted variables do not
23946 interact with external quoting. However, this leads to problems if you want to
23947 generate multiple arguments (or the command name plus arguments) from a single
23948 expansion. In this situation, the simplest solution is to use a shell. For
23949 example:
23950 .code
23951 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23952 .endd
23953
23954 .cindex "transport" "filter"
23955 .cindex "filter" "transport filter"
23956 .vindex "&$pipe_addresses$&"
23957 Special handling takes place when an argument consists of precisely the text
23958 &`$pipe_addresses`& (no quotes).
23959 This is not a general expansion variable; the only
23960 place this string is recognized is when it appears as an argument for a pipe or
23961 transport filter command. It causes each address that is being handled to be
23962 inserted in the argument list at that point &'as a separate argument'&. This
23963 avoids any problems with spaces or shell metacharacters, and is of use when a
23964 &(pipe)& transport is handling groups of addresses in a batch.
23965
23966 If &%force_command%& is enabled on the transport, special handling takes place
23967 for an argument that consists of precisely the text &`$address_pipe`&.  It
23968 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23969 argument is inserted in the argument list at that point
23970 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23971 the only item in the argument; in fact, if it were then &%force_command%&
23972 should behave as a no-op.  Rather, it should be used to adjust the command
23973 run while preserving the argument vector separation.
23974
23975 After splitting up into arguments and expansion, the resulting command is run
23976 in a subprocess directly from the transport, &'not'& under a shell. The
23977 message that is being delivered is supplied on the standard input, and the
23978 standard output and standard error are both connected to a single pipe that is
23979 read by Exim. The &%max_output%& option controls how much output the command
23980 may produce, and the &%return_output%& and &%return_fail_output%& options
23981 control what is done with it.
23982
23983 Not running the command under a shell (by default) lessens the security risks
23984 in cases when a command from a user's filter file is built out of data that was
23985 taken from an incoming message. If a shell is required, it can of course be
23986 explicitly specified as the command to be run. However, there are circumstances
23987 where existing commands (for example, in &_.forward_& files) expect to be run
23988 under a shell and cannot easily be modified. To allow for these cases, there is
23989 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23990 works. Instead of breaking up the command line as just described, it expands it
23991 as a single string and passes the result to &_/bin/sh_&. The
23992 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23993 with &%use_shell%&, and the whole mechanism is inherently less secure.
23994
23995
23996
23997 .section "Environment variables" "SECTpipeenv"
23998 .cindex "&(pipe)& transport" "environment for command"
23999 .cindex "environment" "&(pipe)& transport"
24000 The environment variables listed below are set up when the command is invoked.
24001 This list is a compromise for maximum compatibility with other MTAs. Note that
24002 the &%environment%& option can be used to add additional variables to this
24003 environment. The environment for the &(pipe)& transport is not subject
24004 to the &%add_environment%& and &%keep_environment%& main config options.
24005 .display
24006 &`DOMAIN            `&   the domain of the address
24007 &`HOME              `&   the home directory, if set
24008 &`HOST              `&   the host name when called from a router (see below)
24009 &`LOCAL_PART        `&   see below
24010 &`LOCAL_PART_PREFIX `&   see below
24011 &`LOCAL_PART_SUFFIX `&   see below
24012 &`LOGNAME           `&   see below
24013 &`MESSAGE_ID        `&   Exim's local ID for the message
24014 &`PATH              `&   as specified by the &%path%& option below
24015 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24016 &`RECIPIENT         `&   the complete recipient address
24017 &`SENDER            `&   the sender of the message (empty if a bounce)
24018 &`SHELL             `&   &`/bin/sh`&
24019 &`TZ                `&   the value of the &%timezone%& option, if set
24020 &`USER              `&   see below
24021 .endd
24022 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24023 router, LOCAL_PART is set to the local part of the address. When it is
24024 called as a result of a forward or alias expansion, LOCAL_PART is set to
24025 the local part of the address that was expanded. In both cases, any affixes are
24026 removed from the local part, and made available in LOCAL_PART_PREFIX and
24027 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24028 same value as LOCAL_PART for compatibility with other MTAs.
24029
24030 .cindex "HOST"
24031 HOST is set only when a &(pipe)& transport is called from a router that
24032 associates hosts with an address, typically when using &(pipe)& as a
24033 pseudo-remote transport. HOST is set to the first host name specified by
24034 the router.
24035
24036 .cindex "HOME"
24037 If the transport's generic &%home_directory%& option is set, its value is used
24038 for the HOME environment variable. Otherwise, a home directory may be set
24039 by the router's &%transport_home_directory%& option, which defaults to the
24040 user's home directory if &%check_local_user%& is set.
24041
24042
24043 .section "Private options for pipe" "SECID142"
24044 .cindex "options" "&(pipe)& transport"
24045
24046
24047
24048 .option allow_commands pipe "string list&!!" unset
24049 .cindex "&(pipe)& transport" "permitted commands"
24050 The string is expanded, and is then interpreted as a colon-separated list of
24051 permitted commands. If &%restrict_to_path%& is not set, the only commands
24052 permitted are those in the &%allow_commands%& list. They need not be absolute
24053 paths; the &%path%& option is still used for relative paths. If
24054 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24055 in the &%allow_commands%& list, or a name without any slashes that is found on
24056 the path. In other words, if neither &%allow_commands%& nor
24057 &%restrict_to_path%& is set, there is no restriction on the command, but
24058 otherwise only commands that are permitted by one or the other are allowed. For
24059 example, if
24060 .code
24061 allow_commands = /usr/bin/vacation
24062 .endd
24063 and &%restrict_to_path%& is not set, the only permitted command is
24064 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24065 &%use_shell%& is set.
24066
24067
24068 .option batch_id pipe string&!! unset
24069 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24070
24071
24072 .option batch_max pipe integer 1
24073 This limits the number of addresses that can be handled in a single delivery.
24074 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24075
24076
24077 .option check_string pipe string unset
24078 As &(pipe)& writes the message, the start of each line is tested for matching
24079 &%check_string%&, and if it does, the initial matching characters are replaced
24080 by the contents of &%escape_string%&, provided both are set. The value of
24081 &%check_string%& is a literal string, not a regular expression, and the case of
24082 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24083 of &%check_string%& and &%escape_string%& are forced to values that implement
24084 the SMTP escaping protocol. Any settings made in the configuration file are
24085 ignored.
24086
24087
24088 .option command pipe string&!! unset
24089 This option need not be set when &(pipe)& is being used to deliver to pipes
24090 obtained directly from address redirections. In other cases, the option must be
24091 set, to provide a command to be run. It need not yield an absolute path (see
24092 the &%path%& option below). The command is split up into separate arguments by
24093 Exim, and each argument is separately expanded, as described in section
24094 &<<SECThowcommandrun>>& above.
24095
24096
24097 .option environment pipe string&!! unset
24098 .cindex "&(pipe)& transport" "environment for command"
24099 .cindex "environment" "&(pipe)& transport"
24100 This option is used to add additional variables to the environment in which the
24101 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24102 a string which is expanded, and then interpreted as a colon-separated list of
24103 environment settings of the form <&'name'&>=<&'value'&>.
24104
24105
24106 .option escape_string pipe string unset
24107 See &%check_string%& above.
24108
24109
24110 .option freeze_exec_fail pipe boolean false
24111 .cindex "exec failure"
24112 .cindex "failure of exec"
24113 .cindex "&(pipe)& transport" "failure of exec"
24114 Failure to exec the command in a pipe transport is by default treated like
24115 any other failure while running the command. However, if &%freeze_exec_fail%&
24116 is set, failure to exec is treated specially, and causes the message to be
24117 frozen, whatever the setting of &%ignore_status%&.
24118
24119
24120 .option freeze_signal pipe boolean false
24121 .cindex "signal exit"
24122 .cindex "&(pipe)& transport", "signal exit"
24123 Normally if the process run by a command in a pipe transport exits on a signal,
24124 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24125 frozen in Exim's queue instead.
24126
24127
24128 .option force_command pipe boolean false
24129 .cindex "force command"
24130 .cindex "&(pipe)& transport", "force command"
24131 Normally when a router redirects an address directly to a pipe command
24132 the &%command%& option on the transport is ignored.  If &%force_command%&
24133 is set, the &%command%& option will used. This is especially
24134 useful for forcing a wrapper or additional argument to be added to the
24135 command. For example:
24136 .code
24137 command = /usr/bin/remote_exec myhost -- $address_pipe
24138 force_command
24139 .endd
24140
24141 Note that &$address_pipe$& is handled specially in &%command%& when
24142 &%force_command%& is set, expanding out to the original argument vector as
24143 separate items, similarly to a Unix shell &`"$@"`& construct.
24144
24145
24146 .option ignore_status pipe boolean false
24147 If this option is true, the status returned by the subprocess that is set up to
24148 run the command is ignored, and Exim behaves as if zero had been returned.
24149 Otherwise, a non-zero status or termination by signal causes an error return
24150 from the transport unless the status value is one of those listed in
24151 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24152
24153 &*Note*&: This option does not apply to timeouts, which do not return a status.
24154 See the &%timeout_defer%& option for how timeouts are handled.
24155
24156
24157 .option log_defer_output pipe boolean false
24158 .cindex "&(pipe)& transport" "logging output"
24159 If this option is set, and the status returned by the command is
24160 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24161 and any output was produced on stdout or stderr, the first line of it is
24162 written to the main log.
24163
24164
24165 .option log_fail_output pipe boolean false
24166 If this option is set, and the command returns any output on stdout or
24167 stderr, and also ends with a return code that is neither zero nor one of
24168 the return codes listed in &%temp_errors%& (that is, the delivery
24169 failed), the first line of output is written to the main log. This
24170 option and &%log_output%& are mutually exclusive.  Only one of them may
24171 be set.
24172
24173
24174 .option log_output pipe boolean false
24175 If this option is set and the command returns any output on stdout or
24176 stderr, the first line of output is written to the main log, whatever
24177 the return code. This option and &%log_fail_output%& are mutually
24178 exclusive. Only one of them may be set.
24179
24180
24181 .option max_output pipe integer 20K
24182 This specifies the maximum amount of output that the command may produce on its
24183 standard output and standard error file combined. If the limit is exceeded, the
24184 process running the command is killed. This is intended as a safety measure to
24185 catch runaway processes. The limit is applied independently of the settings of
24186 the options that control what is done with such output (for example,
24187 &%return_output%&). Because of buffering effects, the amount of output may
24188 exceed the limit by a small amount before Exim notices.
24189
24190
24191 .option message_prefix pipe string&!! "see below"
24192 The string specified here is expanded and output at the start of every message.
24193 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24194 .code
24195 message_prefix = \
24196   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24197   ${tod_bsdinbox}\n
24198 .endd
24199 .cindex "Cyrus"
24200 .cindex "&%tmail%&"
24201 .cindex "&""From""& line"
24202 This is required by the commonly used &_/usr/bin/vacation_& program.
24203 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24204 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24205 setting
24206 .code
24207 message_prefix =
24208 .endd
24209 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24210 &`\n`& to &`\r\n`& in &%message_prefix%&.
24211
24212
24213 .option message_suffix pipe string&!! "see below"
24214 The string specified here is expanded and output at the end of every message.
24215 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24216 The suffix can be suppressed by setting
24217 .code
24218 message_suffix =
24219 .endd
24220 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24221 &`\n`& to &`\r\n`& in &%message_suffix%&.
24222
24223
24224 .option path pipe string&!! "/bin:/usr/bin"
24225 This option is expanded and
24226 specifies the string that is set up in the PATH environment
24227 variable of the subprocess.
24228 If the &%command%& option does not yield an absolute path name, the command is
24229 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24230 apply to a command specified as a transport filter.
24231
24232
24233 .option permit_coredump pipe boolean false
24234 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24235 a core-dump of a pipe command, enable this command.  This enables core-dumps
24236 during delivery and affects both the Exim binary and the pipe command run.
24237 It is recommended that this option remain off unless and until you have a need
24238 for it and that this only be enabled when needed, as the risk of excessive
24239 resource consumption can be quite high.  Note also that Exim is typically
24240 installed as a setuid binary and most operating systems will inhibit coredumps
24241 of these by default, so further OS-specific action may be required.
24242
24243
24244 .option pipe_as_creator pipe boolean false
24245 .cindex "uid (user id)" "local delivery"
24246 If the generic &%user%& option is not set and this option is true, the delivery
24247 process is run under the uid that was in force when Exim was originally called
24248 to accept the message. If the group id is not otherwise set (via the generic
24249 &%group%& option), the gid that was in force when Exim was originally called to
24250 accept the message is used.
24251
24252
24253 .option restrict_to_path pipe boolean false
24254 When this option is set, any command name not listed in &%allow_commands%& must
24255 contain no slashes. The command is searched for only in the directories listed
24256 in the &%path%& option. This option is intended for use in the case when a pipe
24257 command has been generated from a user's &_.forward_& file. This is usually
24258 handled by a &(pipe)& transport called &%address_pipe%&.
24259
24260
24261 .option return_fail_output pipe boolean false
24262 If this option is true, and the command produced any output and ended with a
24263 return code other than zero or one of the codes listed in &%temp_errors%& (that
24264 is, the delivery failed), the output is returned in the bounce message.
24265 However, if the message has a null sender (that is, it is itself a bounce
24266 message), output from the command is discarded. This option and
24267 &%return_output%& are mutually exclusive. Only one of them may be set.
24268
24269
24270
24271 .option return_output pipe boolean false
24272 If this option is true, and the command produced any output, the delivery is
24273 deemed to have failed whatever the return code from the command, and the output
24274 is returned in the bounce message. Otherwise, the output is just discarded.
24275 However, if the message has a null sender (that is, it is a bounce message),
24276 output from the command is always discarded, whatever the setting of this
24277 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24278 of them may be set.
24279
24280
24281
24282 .option temp_errors pipe "string list" "see below"
24283 .cindex "&(pipe)& transport" "temporary failure"
24284 This option contains either a colon-separated list of numbers, or a single
24285 asterisk. If &%ignore_status%& is false
24286 and &%return_output%& is not set,
24287 and the command exits with a non-zero return code, the failure is treated as
24288 temporary and the delivery is deferred if the return code matches one of the
24289 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24290 codes are treated as permanent errors. The default setting contains the codes
24291 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24292 compiled on a system that does not define these macros, it assumes values of 75
24293 and 73, respectively.
24294
24295
24296 .option timeout pipe time 1h
24297 If the command fails to complete within this time, it is killed. This normally
24298 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24299 specifies no timeout. In order to ensure that any subprocesses created by the
24300 command are also killed, Exim makes the initial process a process group leader,
24301 and kills the whole process group on a timeout. However, this can be defeated
24302 if one of the processes starts a new process group.
24303
24304 .option timeout_defer pipe boolean false
24305 A timeout in a &(pipe)& transport, either in the command that the transport
24306 runs, or in a transport filter that is associated with it, is by default
24307 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24308 is set true, both kinds of timeout become temporary errors, causing the
24309 delivery to be deferred.
24310
24311 .option umask pipe "octal integer" 022
24312 This specifies the umask setting for the subprocess that runs the command.
24313
24314
24315 .option use_bsmtp pipe boolean false
24316 .cindex "envelope sender"
24317 If this option is set true, the &(pipe)& transport writes messages in &"batch
24318 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24319 commands. If you want to include a leading HELO command with such messages,
24320 you can do so by setting the &%message_prefix%& option. See section
24321 &<<SECTbatchSMTP>>& for details of batch SMTP.
24322
24323 .option use_classresources pipe boolean false
24324 .cindex "class resources (BSD)"
24325 This option is available only when Exim is running on FreeBSD, NetBSD, or
24326 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24327 resource limits when a &(pipe)& transport is run to perform a delivery. The
24328 limits for the uid under which the pipe is to run are obtained from the login
24329 class database.
24330
24331
24332 .option use_crlf pipe boolean false
24333 .cindex "carriage return"
24334 .cindex "linefeed"
24335 This option causes lines to be terminated with the two-character CRLF sequence
24336 (carriage return, linefeed) instead of just a linefeed character. In the case
24337 of batched SMTP, the byte sequence written to the pipe is then an exact image
24338 of what would be sent down a real SMTP connection.
24339
24340 The contents of the &%message_prefix%& and &%message_suffix%& options are
24341 written verbatim, so must contain their own carriage return characters if these
24342 are needed. When &%use_bsmtp%& is not set, the default values for both
24343 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24344 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24345
24346
24347 .option use_shell pipe boolean false
24348 .vindex "&$pipe_addresses$&"
24349 If this option is set, it causes the command to be passed to &_/bin/sh_&
24350 instead of being run directly from the transport, as described in section
24351 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24352 where the command is expected to be run under a shell and cannot easily be
24353 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24354 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24355 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24356 its &%-c%& option.
24357
24358
24359
24360 .section "Using an external local delivery agent" "SECID143"
24361 .cindex "local delivery" "using an external agent"
24362 .cindex "&'procmail'&"
24363 .cindex "external local delivery"
24364 .cindex "delivery" "&'procmail'&"
24365 .cindex "delivery" "by external agent"
24366 The &(pipe)& transport can be used to pass all messages that require local
24367 delivery to a separate local delivery agent such as &%procmail%&. When doing
24368 this, care must be taken to ensure that the pipe is run under an appropriate
24369 uid and gid. In some configurations one wants this to be a uid that is trusted
24370 by the delivery agent to supply the correct sender of the message. It may be
24371 necessary to recompile or reconfigure the delivery agent so that it trusts an
24372 appropriate user. The following is an example transport and router
24373 configuration for &%procmail%&:
24374 .code
24375 # transport
24376 procmail_pipe:
24377   driver = pipe
24378   command = /usr/local/bin/procmail -d $local_part
24379   return_path_add
24380   delivery_date_add
24381   envelope_to_add
24382   check_string = "From "
24383   escape_string = ">From "
24384   umask = 077
24385   user = $local_part
24386   group = mail
24387
24388 # router
24389 procmail:
24390   driver = accept
24391   check_local_user
24392   transport = procmail_pipe
24393 .endd
24394 In this example, the pipe is run as the local user, but with the group set to
24395 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24396 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24397 user to supply a correct sender address. If you do not specify either a
24398 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24399 home directory is the user's home directory by default.
24400
24401 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24402 .code
24403 IFS=" "
24404 .endd
24405 as shown in some &%procmail%& documentation, because Exim does not by default
24406 use a shell to run pipe commands.
24407
24408 .cindex "Cyrus"
24409 The next example shows a transport and a router for a system where local
24410 deliveries are handled by the Cyrus IMAP server.
24411 .code
24412 # transport
24413 local_delivery_cyrus:
24414   driver = pipe
24415   command = /usr/cyrus/bin/deliver \
24416             -m ${substr_1:$local_part_suffix} -- $local_part
24417   user = cyrus
24418   group = mail
24419   return_output
24420   log_output
24421   message_prefix =
24422   message_suffix =
24423
24424 # router
24425 local_user_cyrus:
24426   driver = accept
24427   check_local_user
24428   local_part_suffix = .*
24429   transport = local_delivery_cyrus
24430 .endd
24431 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24432 &%return_output%& to cause any text written by Cyrus to be returned to the
24433 sender.
24434 .ecindex IIDpiptra1
24435 .ecindex IIDpiptra2
24436
24437
24438 . ////////////////////////////////////////////////////////////////////////////
24439 . ////////////////////////////////////////////////////////////////////////////
24440
24441 .chapter "The smtp transport" "CHAPsmtptrans"
24442 .scindex IIDsmttra1 "transports" "&(smtp)&"
24443 .scindex IIDsmttra2 "&(smtp)& transport"
24444 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24445 or LMTP protocol. The list of hosts to try can either be taken from the address
24446 that is being processed (having been set up by the router), or specified
24447 explicitly for the transport. Timeout and retry processing (see chapter
24448 &<<CHAPretry>>&) is applied to each IP address independently.
24449
24450
24451 .section "Multiple messages on a single connection" "SECID144"
24452 The sending of multiple messages over a single TCP/IP connection can arise in
24453 two ways:
24454
24455 .ilist
24456 If a message contains more than &%max_rcpt%& (see below) addresses that are
24457 routed to the same host, more than one copy of the message has to be sent to
24458 that host. In this situation, multiple copies may be sent in a single run of
24459 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24460 does when it has too many addresses to send in one message also depends on the
24461 value of the global &%remote_max_parallel%& option. Details are given in
24462 section &<<SECToutSMTPTCP>>&.)
24463 .next
24464 .cindex "hints database" "remembering routing"
24465 When a message has been successfully delivered over a TCP/IP connection, Exim
24466 looks in its hints database to see if there are any other messages awaiting a
24467 connection to the same host. If there are, a new delivery process is started
24468 for one of them, and the current TCP/IP connection is passed on to it. The new
24469 process may in turn send multiple copies and possibly create yet another
24470 process.
24471 .endlist
24472
24473
24474 For each copy sent over the same TCP/IP connection, a sequence counter is
24475 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24476 no further messages are sent over that connection.
24477
24478
24479
24480 .section "Use of the $host and $host_address variables" "SECID145"
24481 .vindex "&$host$&"
24482 .vindex "&$host_address$&"
24483 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24484 &$host_address$& are the name and IP address of the first host on the host list
24485 passed by the router. However, when the transport is about to connect to a
24486 specific host, and while it is connected to that host, &$host$& and
24487 &$host_address$& are set to the values for that host. These are the values
24488 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24489 &%serialize_hosts%&, and the various TLS options are expanded.
24490
24491
24492 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24493 .vindex &$tls_bits$&
24494 .vindex &$tls_cipher$&
24495 .vindex &$tls_peerdn$&
24496 .vindex &$tls_sni$&
24497 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24498 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24499 are the values that were set when the message was received.
24500 These are the values that are used for options that are expanded before any
24501 SMTP connections are made. Just before each connection is made, these four
24502 variables are emptied. If TLS is subsequently started, they are set to the
24503 appropriate values for the outgoing connection, and these are the values that
24504 are in force when any authenticators are run and when the
24505 &%authenticated_sender%& option is expanded.
24506
24507 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24508 and will be removed in a future release.
24509
24510
24511 .section "Private options for smtp" "SECID146"
24512 .cindex "options" "&(smtp)& transport"
24513 The private options of the &(smtp)& transport are as follows:
24514
24515
24516 .option address_retry_include_sender smtp boolean true
24517 .cindex "4&'xx'& responses" "retrying after"
24518 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24519 is the combination of sender and recipient that is delayed in subsequent queue
24520 runs until the retry time is reached. You can delay the recipient without
24521 reference to the sender (which is what earlier versions of Exim did), by
24522 setting &%address_retry_include_sender%& false. However, this can lead to
24523 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24524
24525 .option allow_localhost smtp boolean false
24526 .cindex "local host" "sending to"
24527 .cindex "fallback" "hosts specified on transport"
24528 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24529 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24530 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24531 the delivery anyway. This should be used only in special cases when the
24532 configuration ensures that no looping will result (for example, a differently
24533 configured Exim is listening on the port to which the message is sent).
24534
24535
24536 .option authenticated_sender smtp string&!! unset
24537 .cindex "Cyrus"
24538 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24539 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24540 overriding any existing authenticated sender value. If the string expansion is
24541 forced to fail, the option is ignored. Other expansion failures cause delivery
24542 to be deferred. If the result of expansion is an empty string, that is also
24543 ignored.
24544
24545 The expansion happens after the outgoing connection has been made and TLS
24546 started, if required. This means that the &$host$&, &$host_address$&,
24547 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24548 particular connection.
24549
24550 If the SMTP session is not authenticated, the expansion of
24551 &%authenticated_sender%& still happens (and can cause the delivery to be
24552 deferred if it fails), but no AUTH= item is added to MAIL commands
24553 unless &%authenticated_sender_force%& is true.
24554
24555 This option allows you to use the &(smtp)& transport in LMTP mode to
24556 deliver mail to Cyrus IMAP and provide the proper local part as the
24557 &"authenticated sender"&, via a setting such as:
24558 .code
24559 authenticated_sender = $local_part
24560 .endd
24561 This removes the need for IMAP subfolders to be assigned special ACLs to
24562 allow direct delivery to those subfolders.
24563
24564 Because of expected uses such as that just described for Cyrus (when no
24565 domain is involved), there is no checking on the syntax of the provided
24566 value.
24567
24568
24569 .option authenticated_sender_force smtp boolean false
24570 If this option is set true, the &%authenticated_sender%& option's value
24571 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24572 authenticated as a client.
24573
24574
24575 .option command_timeout smtp time 5m
24576 This sets a timeout for receiving a response to an SMTP command that has been
24577 sent out. It is also used when waiting for the initial banner line from the
24578 remote host. Its value must not be zero.
24579
24580
24581 .option connect_timeout smtp time 5m
24582 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24583 to a remote host. A setting of zero allows the system timeout (typically
24584 several minutes) to act. To have any effect, the value of this option must be
24585 less than the system timeout. However, it has been observed that on some
24586 systems there is no system timeout, which is why the default value for this
24587 option is 5 minutes, a value recommended by RFC 1123.
24588
24589
24590 .option connection_max_messages smtp integer 500
24591 .cindex "SMTP" "passed connection"
24592 .cindex "SMTP" "multiple deliveries"
24593 .cindex "multiple SMTP deliveries"
24594 This controls the maximum number of separate message deliveries that are sent
24595 over a single TCP/IP connection. If the value is zero, there is no limit.
24596 For testing purposes, this value can be overridden by the &%-oB%& command line
24597 option.
24598
24599
24600 .option dane_require_tls_ciphers smtp string&!! unset
24601 .cindex "TLS" "requiring specific ciphers for DANE"
24602 .cindex "cipher" "requiring specific"
24603 .cindex DANE "TLS ciphers"
24604 This option may be used to override &%tls_require_ciphers%& for connections
24605 where DANE has been determined to be in effect.
24606 If not set, then &%tls_require_ciphers%& will be used.
24607 Normal SMTP delivery is not able to make strong demands of TLS cipher
24608 configuration, because delivery will fall back to plaintext.  Once DANE has
24609 been determined to be in effect, there is no plaintext fallback and making the
24610 TLS cipherlist configuration stronger will increase security, rather than
24611 counter-intuitively decreasing it.
24612 If the option expands to be empty or is forced to fail, then it will
24613 be treated as unset and &%tls_require_ciphers%& will be used instead.
24614
24615
24616 .option data_timeout smtp time 5m
24617 This sets a timeout for the transmission of each block in the data portion of
24618 the message. As a result, the overall timeout for a message depends on the size
24619 of the message. Its value must not be zero. See also &%final_timeout%&.
24620
24621
24622 .option dkim_canon smtp string&!! unset
24623 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24624 .option dkim_domain smtp string list&!! unset
24625 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24626 .option dkim_hash smtp string&!! sha256
24627 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24628 .option dkim_identity smtp string&!! unset
24629 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24630 .option dkim_private_key smtp string&!! unset
24631 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24632 .option dkim_selector smtp string&!! unset
24633 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24634 .option dkim_strict smtp string&!! unset
24635 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24636 .option dkim_sign_headers smtp string&!! "per RFC"
24637 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24638 .option dkim_timestamps smtp string&!! unset
24639 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24640
24641
24642 .option delay_after_cutoff smtp boolean true
24643 .cindex "final cutoff" "retries, controlling"
24644 .cindex retry "final cutoff"
24645 This option controls what happens when all remote IP addresses for a given
24646 domain have been inaccessible for so long that they have passed their retry
24647 cutoff times.
24648
24649 In the default state, if the next retry time has not been reached for any of
24650 them, the address is bounced without trying any deliveries. In other words,
24651 Exim delays retrying an IP address after the final cutoff time until a new
24652 retry time is reached, and can therefore bounce an address without ever trying
24653 a delivery, when machines have been down for a long time. Some people are
24654 unhappy at this prospect, so...
24655
24656 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24657 addresses are past their final cutoff time, Exim tries to deliver to those
24658 IP addresses that have not been tried since the message arrived. If there are
24659 none, of if they all fail, the address is bounced. In other words, it does not
24660 delay when a new message arrives, but immediately tries those expired IP
24661 addresses that haven't been tried since the message arrived. If there is a
24662 continuous stream of messages for the dead hosts, unsetting
24663 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24664 to them.
24665
24666
24667 .option dns_qualify_single smtp boolean true
24668 If the &%hosts%& or &%fallback_hosts%& option is being used,
24669 and the &%gethostbyname%& option is false,
24670 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24671 in chapter &<<CHAPdnslookup>>& for more details.
24672
24673
24674 .option dns_search_parents smtp boolean false
24675 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24676 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24677 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24678 details.
24679
24680
24681 .option dnssec_request_domains smtp "domain list&!!" *
24682 .cindex "MX record" "security"
24683 .cindex "DNSSEC" "MX lookup"
24684 .cindex "security" "MX lookup"
24685 .cindex "DNS" "DNSSEC"
24686 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24687 the dnssec request bit set. Setting this transport option is only useful if the
24688 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24689 router option.
24690
24691
24692
24693 .option dnssec_require_domains smtp "domain list&!!" unset
24694 .cindex "MX record" "security"
24695 .cindex "DNSSEC" "MX lookup"
24696 .cindex "security" "MX lookup"
24697 .cindex "DNS" "DNSSEC"
24698 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24699 the dnssec request bit set.  Setting this transport option is only
24700 useful if the transport overrides or sets the host names. See the
24701 &%dnssec_require_domains%& router option.
24702
24703
24704
24705 .option dscp smtp string&!! unset
24706 .cindex "DCSP" "outbound"
24707 This option causes the DSCP value associated with a socket to be set to one
24708 of a number of fixed strings or to numeric value.
24709 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24710 Common values include &`throughput`&, &`mincost`&, and on newer systems
24711 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24712
24713 The outbound packets from Exim will be marked with this value in the header
24714 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24715 that these values will have any effect, not be stripped by networking
24716 equipment, or do much of anything without cooperation with your Network
24717 Engineer and those of all network operators between the source and destination.
24718
24719
24720 .option fallback_hosts smtp "string list" unset
24721 .cindex "fallback" "hosts specified on transport"
24722 String expansion is not applied to this option. The argument must be a
24723 colon-separated list of host names or IP addresses, optionally also including
24724 port numbers, though the separator can be changed, as described in section
24725 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24726 item in a &%route_list%& setting for the &(manualroute)& router, as described
24727 in section &<<SECTformatonehostitem>>&.
24728
24729 Fallback hosts can also be specified on routers, which associate them with the
24730 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24731 &%fallback_hosts%& specified on the transport is used only if the address does
24732 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24733 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24734 However, &%hosts_randomize%& does apply to fallback host lists.
24735
24736 If Exim is unable to deliver to any of the hosts for a particular address, and
24737 the errors are not permanent rejections, the address is put on a separate
24738 transport queue with its host list replaced by the fallback hosts, unless the
24739 address was routed via MX records and the current host was in the original MX
24740 list. In that situation, the fallback host list is not used.
24741
24742 Once normal deliveries are complete, the fallback queue is delivered by
24743 re-running the same transports with the new host lists. If several failing
24744 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24745 copy of the message is sent.
24746
24747 The resolution of the host names on the fallback list is controlled by the
24748 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24749 both to cases when the host list comes with the address and when it is taken
24750 from &%hosts%&. This option provides a &"use a smart host only if delivery
24751 fails"& facility.
24752
24753
24754 .option final_timeout smtp time 10m
24755 This is the timeout that applies while waiting for the response to the final
24756 line containing just &"."& that terminates a message. Its value must not be
24757 zero.
24758
24759 .option gethostbyname smtp boolean false
24760 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24761 being used, names are looked up using &[gethostbyname()]&
24762 (or &[getipnodebyname()]& when available)
24763 instead of using the DNS. Of course, that function may in fact use the DNS, but
24764 it may also consult other sources of information such as &_/etc/hosts_&.
24765
24766 .option gnutls_compat_mode smtp boolean unset
24767 This option controls whether GnuTLS is used in compatibility mode in an Exim
24768 server. This reduces security slightly, but improves interworking with older
24769 implementations of TLS.
24770
24771 .option helo_data smtp string&!! "see below"
24772 .cindex "HELO" "argument, setting"
24773 .cindex "EHLO" "argument, setting"
24774 .cindex "LHLO argument setting"
24775 The value of this option is expanded after a connection to a another host has
24776 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24777 command that starts the outgoing SMTP or LMTP session. The default value of the
24778 option is:
24779 .code
24780 $primary_hostname
24781 .endd
24782 During the expansion, the variables &$host$& and &$host_address$& are set to
24783 the identity of the remote host, and the variables &$sending_ip_address$& and
24784 &$sending_port$& are set to the local IP address and port number that are being
24785 used. These variables can be used to generate different values for different
24786 servers or different local IP addresses. For example, if you want the string
24787 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24788 interface address, you could use this:
24789 .code
24790 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24791   {$primary_hostname}}
24792 .endd
24793 The use of &%helo_data%& applies both to sending messages and when doing
24794 callouts.
24795
24796 .option hosts smtp "string list&!!" unset
24797 Hosts are associated with an address by a router such as &(dnslookup)&, which
24798 finds the hosts by looking up the address domain in the DNS, or by
24799 &(manualroute)&, which has lists of hosts in its configuration. However,
24800 email addresses can be passed to the &(smtp)& transport by any router, and not
24801 all of them can provide an associated list of hosts.
24802
24803 The &%hosts%& option specifies a list of hosts to be used if the address being
24804 processed does not have any hosts associated with it. The hosts specified by
24805 &%hosts%& are also used, whether or not the address has its own hosts, if
24806 &%hosts_override%& is set.
24807
24808 The string is first expanded, before being interpreted as a colon-separated
24809 list of host names or IP addresses, possibly including port numbers. The
24810 separator may be changed to something other than colon, as described in section
24811 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24812 item in a &%route_list%& setting for the &(manualroute)& router, as described
24813 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24814 of the &(manualroute)& router is not available here.
24815
24816 If the expansion fails, delivery is deferred. Unless the failure was caused by
24817 the inability to complete a lookup, the error is logged to the panic log as
24818 well as the main log. Host names are looked up either by searching directly for
24819 address records in the DNS or by calling &[gethostbyname()]& (or
24820 &[getipnodebyname()]& when available), depending on the setting of the
24821 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24822 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24823 address are used.
24824
24825 During delivery, the hosts are tried in order, subject to their retry status,
24826 unless &%hosts_randomize%& is set.
24827
24828
24829 .option hosts_avoid_esmtp smtp "host list&!!" unset
24830 .cindex "ESMTP, avoiding use of"
24831 .cindex "HELO" "forcing use of"
24832 .cindex "EHLO" "avoiding use of"
24833 .cindex "PIPELINING" "avoiding the use of"
24834 This option is for use with broken hosts that announce ESMTP facilities (for
24835 example, PIPELINING) and then fail to implement them properly. When a host
24836 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24837 start of the SMTP session. This means that it cannot use any of the ESMTP
24838 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24839
24840
24841 .option hosts_avoid_pipelining smtp "host list&!!" unset
24842 .cindex "PIPELINING" "avoiding the use of"
24843 Exim will not use the SMTP PIPELINING extension when delivering to any host
24844 that matches this list, even if the server host advertises PIPELINING support.
24845
24846 .option hosts_pipe_connect smtp "host list&!!" unset
24847 .cindex "pipelining" "early connection"
24848 .cindex "pipelining" PIPE_CONNECT
24849 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24850 this option controls which to hosts the facility watched for
24851 and recorded, and used for subsequent connections.
24852
24853 The retry hints database is used for the record,
24854 and records are subject to the &%retry_data_expire%& option.
24855 When used, the pipelining saves on roundtrip times.
24856 It also turns SMTP into a client-first protocol
24857 so combines well with TCP Fast Open.
24858
24859 See also the &%pipelining_connect_advertise_hosts%& main option.
24860
24861 Note:
24862 When the facility is used, the transport &%helo_data%& option
24863 will be expanded before the &$sending_ip_address$& variable
24864 is filled in.
24865 A check is made for the use of that variable, without the
24866 presence of a &"def:"& test on it, but suitably complex coding
24867 can avoid the check and produce unexpected results.
24868 You have been warned.
24869
24870
24871 .option hosts_avoid_tls smtp "host list&!!" unset
24872 .cindex "TLS" "avoiding for certain hosts"
24873 Exim will not try to start a TLS session when delivering to any host that
24874 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24875
24876 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24877 .cindex "TLS" "avoiding for certain hosts"
24878 Exim will not try to start a TLS session for a verify callout,
24879 or when delivering in cutthrough mode,
24880 to any host that matches this list.
24881
24882
24883 .option hosts_max_try smtp integer 5
24884 .cindex "host" "maximum number to try"
24885 .cindex "limit" "number of hosts tried"
24886 .cindex "limit" "number of MX tried"
24887 .cindex "MX record" "maximum tried"
24888 This option limits the number of IP addresses that are tried for any one
24889 delivery in cases where there are temporary delivery errors. Section
24890 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24891
24892
24893 .option hosts_max_try_hardlimit smtp integer 50
24894 This is an additional check on the maximum number of IP addresses that Exim
24895 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24896 why it exists.
24897
24898
24899
24900 .option hosts_nopass_tls smtp "host list&!!" unset
24901 .cindex "TLS" "passing connection"
24902 .cindex "multiple SMTP deliveries"
24903 .cindex "TLS" "multiple message deliveries"
24904 For any host that matches this list, a connection on which a TLS session has
24905 been started will not be passed to a new delivery process for sending another
24906 message on the same connection. See section &<<SECTmulmessam>>& for an
24907 explanation of when this might be needed.
24908
24909 .option hosts_noproxy_tls smtp "host list&!!" unset
24910 .cindex "TLS" "passing connection"
24911 .cindex "multiple SMTP deliveries"
24912 .cindex "TLS" "multiple message deliveries"
24913 For any host that matches this list, a TLS session which has
24914 been started will not be passed to a new delivery process for sending another
24915 message on the same session.
24916
24917 The traditional implementation closes down TLS and re-starts it in the new
24918 process, on the same open TCP connection, for each successive message
24919 sent.  If permitted by this option a pipe to to the new process is set up
24920 instead, and the original process maintains the TLS connection and proxies
24921 the SMTP connection from and to the new process and any subsequents.
24922 The new process has no access to TLS information, so cannot include it in
24923 logging.
24924
24925
24926
24927 .option hosts_override smtp boolean false
24928 If this option is set and the &%hosts%& option is also set, any hosts that are
24929 attached to the address are ignored, and instead the hosts specified by the
24930 &%hosts%& option are always used. This option does not apply to
24931 &%fallback_hosts%&.
24932
24933
24934 .option hosts_randomize smtp boolean false
24935 .cindex "randomized host list"
24936 .cindex "host" "list of; randomized"
24937 .cindex "fallback" "randomized hosts"
24938 If this option is set, and either the list of hosts is taken from the
24939 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24940 were not obtained from MX records (this includes fallback hosts from the
24941 router), and were not randomized by the router, the order of trying the hosts
24942 is randomized each time the transport runs. Randomizing the order of a host
24943 list can be used to do crude load sharing.
24944
24945 When &%hosts_randomize%& is true, a host list may be split into groups whose
24946 order is separately randomized. This makes it possible to set up MX-like
24947 behaviour. The boundaries between groups are indicated by an item that is just
24948 &`+`& in the host list. For example:
24949 .code
24950 hosts = host1:host2:host3:+:host4:host5
24951 .endd
24952 The order of the first three hosts and the order of the last two hosts is
24953 randomized for each use, but the first three always end up before the last two.
24954 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24955
24956 .option hosts_require_auth smtp "host list&!!" unset
24957 .cindex "authentication" "required by client"
24958 This option provides a list of servers for which authentication must succeed
24959 before Exim will try to transfer a message. If authentication fails for
24960 servers which are not in this list, Exim tries to send unauthenticated. If
24961 authentication fails for one of these servers, delivery is deferred. This
24962 temporary error is detectable in the retry rules, so it can be turned into a
24963 hard failure if required. See also &%hosts_try_auth%&, and chapter
24964 &<<CHAPSMTPAUTH>>& for details of authentication.
24965
24966
24967 .option hosts_request_ocsp smtp "host list&!!" *
24968 .cindex "TLS" "requiring for certain servers"
24969 Exim will request a Certificate Status on a
24970 TLS session for any host that matches this list.
24971 &%tls_verify_certificates%& should also be set for the transport.
24972
24973 .option hosts_require_dane smtp "host list&!!" unset
24974 .cindex DANE "transport options"
24975 .cindex DANE "requiring for certain servers"
24976 If built with DANE support, Exim  will require that a DNSSEC-validated
24977 TLSA record is present for any host matching the list,
24978 and that a DANE-verified TLS connection is made. See
24979 the &%dnssec_request_domains%& router and transport options.
24980 There will be no fallback to in-clear communication.
24981 See section &<<SECDANE>>&.
24982
24983 .option hosts_require_ocsp smtp "host list&!!" unset
24984 .cindex "TLS" "requiring for certain servers"
24985 Exim will request, and check for a valid Certificate Status being given, on a
24986 TLS session for any host that matches this list.
24987 &%tls_verify_certificates%& should also be set for the transport.
24988
24989 .option hosts_require_tls smtp "host list&!!" unset
24990 .cindex "TLS" "requiring for certain servers"
24991 Exim will insist on using a TLS session when delivering to any host that
24992 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24993 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24994 incoming messages, use an appropriate ACL.
24995
24996 .option hosts_try_auth smtp "host list&!!" unset
24997 .cindex "authentication" "optional in client"
24998 This option provides a list of servers to which, provided they announce
24999 authentication support, Exim will attempt to authenticate as a client when it
25000 connects. If authentication fails, Exim will try to transfer the message
25001 unauthenticated. See also &%hosts_require_auth%&, and chapter
25002 &<<CHAPSMTPAUTH>>& for details of authentication.
25003
25004 .option hosts_try_chunking smtp "host list&!!" *
25005 .cindex CHUNKING "enabling, in client"
25006 .cindex BDAT "SMTP command"
25007 .cindex "RFC 3030" "CHUNKING"
25008 This option provides a list of servers to which, provided they announce
25009 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25010 .new
25011 Unless DKIM signing is being done,
25012 .wen
25013 BDAT will not be used in conjunction with a transport filter.
25014
25015 .option hosts_try_dane smtp "host list&!!" *
25016 .cindex DANE "transport options"
25017 .cindex DANE "attempting for certain servers"
25018 If built with DANE support, Exim  will require that a DNSSEC-validated
25019 TLSA record is present for any host matching the list,
25020 and that a DANE-verified TLS connection is made. See
25021 the &%dnssec_request_domains%& router and transport options.
25022 There will be no fallback to in-clear communication.
25023 See section &<<SECDANE>>&.
25024
25025 .option hosts_try_fastopen smtp "host list&!!" *
25026 .cindex "fast open, TCP" "enabling, in client"
25027 .cindex "TCP Fast Open" "enabling, in client"
25028 .cindex "RFC 7413" "TCP Fast Open"
25029 This option provides a list of servers to which, provided
25030 the facility is supported by this system, Exim will attempt to
25031 perform a TCP Fast Open.
25032 No data is sent on the SYN segment but, if the remote server also
25033 supports the facility, it can send its SMTP banner immediately after
25034 the SYN,ACK segment.  This can save up to one round-trip time.
25035
25036 The facility is only active for previously-contacted servers,
25037 as the initiator must present a cookie in the SYN segment.
25038
25039 On (at least some) current Linux distributions the facility must be enabled
25040 in the kernel by the sysadmin before the support is usable.
25041 There is no option for control of the server side; if the system supports
25042 it it is always enabled.  Note that lengthy operations in the connect ACL,
25043 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25044
25045 .option hosts_try_prdr smtp "host list&!!" *
25046 .cindex "PRDR" "enabling, optional in client"
25047 This option provides a list of servers to which, provided they announce
25048 PRDR support, Exim will attempt to negotiate PRDR
25049 for multi-recipient messages.
25050 The option can usually be left as default.
25051
25052 .option interface smtp "string list&!!" unset
25053 .cindex "bind IP address"
25054 .cindex "IP address" "binding"
25055 .vindex "&$host$&"
25056 .vindex "&$host_address$&"
25057 This option specifies which interface to bind to when making an outgoing SMTP
25058 call. The value is an IP address, not an interface name such as
25059 &`eth0`&. Do not confuse this with the interface address that was used when a
25060 message was received, which is in &$received_ip_address$&, formerly known as
25061 &$interface_address$&. The name was changed to minimize confusion with the
25062 outgoing interface address. There is no variable that contains an outgoing
25063 interface address because, unless it is set by this option, its value is
25064 unknown.
25065
25066 During the expansion of the &%interface%& option the variables &$host$& and
25067 &$host_address$& refer to the host to which a connection is about to be made
25068 during the expansion of the string. Forced expansion failure, or an empty
25069 string result causes the option to be ignored. Otherwise, after expansion, the
25070 string must be a list of IP addresses, colon-separated by default, but the
25071 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25072 For example:
25073 .code
25074 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25075 .endd
25076 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25077 connection. If none of them are the correct type, the option is ignored. If
25078 &%interface%& is not set, or is ignored, the system's IP functions choose which
25079 interface to use if the host has more than one.
25080
25081
25082 .option keepalive smtp boolean true
25083 .cindex "keepalive" "on outgoing connection"
25084 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25085 connections. When set, it causes the kernel to probe idle connections
25086 periodically, by sending packets with &"old"& sequence numbers. The other end
25087 of the connection should send a acknowledgment if the connection is still okay
25088 or a reset if the connection has been aborted. The reason for doing this is
25089 that it has the beneficial effect of freeing up certain types of connection
25090 that can get stuck when the remote host is disconnected without tidying up the
25091 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25092 unreachable hosts.
25093
25094
25095 .option lmtp_ignore_quota smtp boolean false
25096 .cindex "LMTP" "ignoring quota errors"
25097 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25098 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25099 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25100
25101 .option max_rcpt smtp integer 100
25102 .cindex "RCPT" "maximum number of outgoing"
25103 This option limits the number of RCPT commands that are sent in a single
25104 SMTP message transaction. Each set of addresses is treated independently, and
25105 so can cause parallel connections to the same host if &%remote_max_parallel%&
25106 permits this.
25107
25108
25109 .option multi_domain smtp boolean&!! true
25110 .vindex "&$domain$&"
25111 When this option is set, the &(smtp)& transport can handle a number of
25112 addresses containing a mixture of different domains provided they all resolve
25113 to the same list of hosts. Turning the option off restricts the transport to
25114 handling only one domain at a time. This is useful if you want to use
25115 &$domain$& in an expansion for the transport, because it is set only when there
25116 is a single domain involved in a remote delivery.
25117
25118 It is expanded per-address and can depend on any of
25119 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25120 &$host$&, &$host_address$& and &$host_port$&.
25121
25122 .option port smtp string&!! "see below"
25123 .cindex "port" "sending TCP/IP"
25124 .cindex "TCP/IP" "setting outgoing port"
25125 This option specifies the TCP/IP port on the server to which Exim connects.
25126 &*Note:*& Do not confuse this with the port that was used when a message was
25127 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25128 The name was changed to minimize confusion with the outgoing port. There is no
25129 variable that contains an outgoing port.
25130
25131 If the value of this option begins with a digit it is taken as a port number;
25132 otherwise it is looked up using &[getservbyname()]&. The default value is
25133 normally &"smtp"&,
25134 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25135 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25136 If the expansion fails, or if a port number cannot be found, delivery
25137 is deferred.
25138
25139 Note that at least one Linux distribution has been seen failing
25140 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25141
25142
25143
25144 .option protocol smtp string smtp
25145 .cindex "LMTP" "over TCP/IP"
25146 .cindex "ssmtp protocol" "outbound"
25147 .cindex "TLS" "SSL-on-connect outbound"
25148 .vindex "&$port$&"
25149 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25150 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25151 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25152 deliveries into closed message stores. Exim also has support for running LMTP
25153 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25154
25155 If this option is set to &"smtps"&, the default value for the &%port%& option
25156 changes to &"smtps"&, and the transport initiates TLS immediately after
25157 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25158 The Internet standards bodies used to strongly discourage use of this mode,
25159 but as of RFC 8314 it is perferred over STARTTLS for message submission
25160 (as distinct from MTA-MTA communication).
25161
25162
25163 .option retry_include_ip_address smtp boolean&!! true
25164 Exim normally includes both the host name and the IP address in the key it
25165 constructs for indexing retry data after a temporary delivery failure. This
25166 means that when one of several IP addresses for a host is failing, it gets
25167 tried periodically (controlled by the retry rules), but use of the other IP
25168 addresses is not affected.
25169
25170 However, in some dialup environments hosts are assigned a different IP address
25171 each time they connect. In this situation the use of the IP address as part of
25172 the retry key leads to undesirable behaviour. Setting this option false causes
25173 Exim to use only the host name.
25174 Since it is expanded it can be made to depend on the host or domain.
25175
25176
25177 .option serialize_hosts smtp "host list&!!" unset
25178 .cindex "serializing connections"
25179 .cindex "host" "serializing connections"
25180 Because Exim operates in a distributed manner, if several messages for the same
25181 host arrive at around the same time, more than one simultaneous connection to
25182 the remote host can occur. This is not usually a problem except when there is a
25183 slow link between the hosts. In that situation it may be helpful to restrict
25184 Exim to one connection at a time. This can be done by setting
25185 &%serialize_hosts%& to match the relevant hosts.
25186
25187 .cindex "hints database" "serializing deliveries to a host"
25188 Exim implements serialization by means of a hints database in which a record is
25189 written whenever a process connects to one of the restricted hosts. The record
25190 is deleted when the connection is completed. Obviously there is scope for
25191 records to get left lying around if there is a system or program crash. To
25192 guard against this, Exim ignores any records that are more than six hours old.
25193
25194 If you set up this kind of serialization, you should also arrange to delete the
25195 relevant hints database whenever your system reboots. The names of the files
25196 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25197 may be one or two files, depending on the type of DBM in use. The same files
25198 are used for ETRN serialization.
25199
25200 See also the &%max_parallel%& generic transport option.
25201
25202
25203 .option size_addition smtp integer 1024
25204 .cindex "SMTP" "SIZE"
25205 .cindex "message" "size issue for transport filter"
25206 .cindex "size" "of message"
25207 .cindex "transport" "filter"
25208 .cindex "filter" "transport filter"
25209 If a remote SMTP server indicates that it supports the SIZE option of the
25210 MAIL command, Exim uses this to pass over the message size at the start of
25211 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25212 sends, to allow for headers and other text that may be added during delivery by
25213 configuration options or in a transport filter. It may be necessary to increase
25214 this if a lot of text is added to messages.
25215
25216 Alternatively, if the value of &%size_addition%& is set negative, it disables
25217 the use of the SIZE option altogether.
25218
25219
25220 .option socks_proxy smtp string&!! unset
25221 .cindex proxy SOCKS
25222 This option enables use of SOCKS proxies for connections made by the
25223 transport.  For details see section &<<SECTproxySOCKS>>&.
25224
25225
25226 .option tls_certificate smtp string&!! unset
25227 .cindex "TLS" "client certificate, location of"
25228 .cindex "certificate" "client, location of"
25229 .vindex "&$host$&"
25230 .vindex "&$host_address$&"
25231 The value of this option must be the absolute path to a file which contains the
25232 client's certificate, for possible use when sending a message over an encrypted
25233 connection. The values of &$host$& and &$host_address$& are set to the name and
25234 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25235 details of TLS.
25236
25237 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25238 certificate when sending messages as a client. The global option of the same
25239 name specifies the certificate for Exim as a server; it is not automatically
25240 assumed that the same certificate should be used when Exim is operating as a
25241 client.
25242
25243
25244 .option tls_crl smtp string&!! unset
25245 .cindex "TLS" "client certificate revocation list"
25246 .cindex "certificate" "revocation list for client"
25247 This option specifies a certificate revocation list. The expanded value must
25248 be the name of a file that contains a CRL in PEM format.
25249
25250
25251 .option tls_dh_min_bits smtp integer 1024
25252 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25253 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25254 key agreement is negotiated, the server will provide a large prime number
25255 for use.  This option establishes the minimum acceptable size of that number.
25256 If the parameter offered by the server is too small, then the TLS handshake
25257 will fail.
25258
25259 Only supported when using GnuTLS.
25260
25261
25262 .option tls_privatekey smtp string&!! unset
25263 .cindex "TLS" "client private key, location of"
25264 .vindex "&$host$&"
25265 .vindex "&$host_address$&"
25266 The value of this option must be the absolute path to a file which contains the
25267 client's private key. This is used when sending a message over an encrypted
25268 connection using a client certificate. The values of &$host$& and
25269 &$host_address$& are set to the name and address of the server during the
25270 expansion. If this option is unset, or the expansion is forced to fail, or the
25271 result is an empty string, the private key is assumed to be in the same file as
25272 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25273
25274
25275 .option tls_require_ciphers smtp string&!! unset
25276 .cindex "TLS" "requiring specific ciphers"
25277 .cindex "cipher" "requiring specific"
25278 .vindex "&$host$&"
25279 .vindex "&$host_address$&"
25280 The value of this option must be a list of permitted cipher suites, for use
25281 when setting up an outgoing encrypted connection. (There is a global option of
25282 the same name for controlling incoming connections.) The values of &$host$& and
25283 &$host_address$& are set to the name and address of the server during the
25284 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25285 is used in different ways by OpenSSL and GnuTLS (see sections
25286 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25287 ciphers is a preference order.
25288
25289
25290
25291 .option tls_sni smtp string&!! unset
25292 .cindex "TLS" "Server Name Indication"
25293 .vindex "&$tls_sni$&"
25294 If this option is set then it sets the $tls_out_sni variable and causes any
25295 TLS session to pass this value as the Server Name Indication extension to
25296 the remote side, which can be used by the remote side to select an appropriate
25297 certificate and private key for the session.
25298
25299 See &<<SECTtlssni>>& for more information.
25300
25301 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25302 TLS extensions.
25303
25304
25305
25306
25307 .option tls_tempfail_tryclear smtp boolean true
25308 .cindex "4&'xx'& responses" "to STARTTLS"
25309 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25310 setting up a TLS session, this option determines whether or not Exim should try
25311 to deliver the message unencrypted. If it is set false, delivery to the
25312 current host is deferred; if there are other hosts, they are tried. If this
25313 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25314 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25315 TLS negotiation fails, Exim closes the current connection (because it is in an
25316 unknown state), opens a new one to the same host, and then tries the delivery
25317 in clear.
25318
25319
25320 .option tls_try_verify_hosts smtp "host list&!!" *
25321 .cindex "TLS" "server certificate verification"
25322 .cindex "certificate" "verification of server"
25323 This option gives a list of hosts for which, on encrypted connections,
25324 certificate verification will be tried but need not succeed.
25325 The &%tls_verify_certificates%& option must also be set.
25326 Note that unless the host is in this list
25327 TLS connections will be denied to hosts using self-signed certificates
25328 when &%tls_verify_certificates%& is matched.
25329 The &$tls_out_certificate_verified$& variable is set when
25330 certificate verification succeeds.
25331
25332
25333 .option tls_verify_cert_hostnames smtp "host list&!!" *
25334 .cindex "TLS" "server certificate hostname verification"
25335 .cindex "certificate" "verification of server"
25336 This option give a list of hosts for which,
25337 while verifying the server certificate,
25338 checks will be included on the host name
25339 (note that this will generally be the result of a DNS MX lookup)
25340 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25341 limited to being the initial component of a 3-or-more component FQDN.
25342
25343 There is no equivalent checking on client certificates.
25344
25345
25346 .option tls_verify_certificates smtp string&!! system
25347 .cindex "TLS" "server certificate verification"
25348 .cindex "certificate" "verification of server"
25349 .vindex "&$host$&"
25350 .vindex "&$host_address$&"
25351 The value of this option must be either the
25352 word "system"
25353 or the absolute path to
25354 a file or directory containing permitted certificates for servers,
25355 for use when setting up an encrypted connection.
25356
25357 The "system" value for the option will use a location compiled into the SSL library.
25358 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25359 is taken as empty and an explicit location
25360 must be specified.
25361
25362 The use of a directory for the option value is not available for GnuTLS versions
25363 preceding 3.3.6 and a single file must be used.
25364
25365 With OpenSSL the certificates specified
25366 explicitly
25367 either by file or directory
25368 are added to those given by the system default location.
25369
25370 The values of &$host$& and
25371 &$host_address$& are set to the name and address of the server during the
25372 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25373
25374 For back-compatibility,
25375 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25376 (a single-colon empty list counts as being set)
25377 and certificate verification fails the TLS connection is closed.
25378
25379
25380 .option tls_verify_hosts smtp "host list&!!" unset
25381 .cindex "TLS" "server certificate verification"
25382 .cindex "certificate" "verification of server"
25383 This option gives a list of hosts for which, on encrypted connections,
25384 certificate verification must succeed.
25385 The &%tls_verify_certificates%& option must also be set.
25386 If both this option and &%tls_try_verify_hosts%& are unset
25387 operation is as if this option selected all hosts.
25388
25389 .option utf8_downconvert smtp integer!! unset
25390 .cindex utf8 "address downconversion"
25391 .cindex i18n "utf8 address downconversion"
25392 If built with internationalization support,
25393 this option controls conversion of UTF-8 in message addresses
25394 to a-label form.
25395 For details see section &<<SECTi18nMTA>>&.
25396
25397
25398
25399
25400 .section "How the limits for the number of hosts to try are used" &&&
25401          "SECTvalhosmax"
25402 .cindex "host" "maximum number to try"
25403 .cindex "limit" "hosts; maximum number tried"
25404 There are two options that are concerned with the number of hosts that are
25405 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25406 &%hosts_max_try_hardlimit%&.
25407
25408
25409 The &%hosts_max_try%& option limits the number of hosts that are tried
25410 for a single delivery. However, despite the term &"host"& in its name, the
25411 option actually applies to each IP address independently. In other words, a
25412 multihomed host is treated as several independent hosts, just as it is for
25413 retrying.
25414
25415 Many of the larger ISPs have multiple MX records which often point to
25416 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25417 created as a result of routing one of these domains.
25418
25419 Trying every single IP address on such a long list does not seem sensible; if
25420 several at the top of the list fail, it is reasonable to assume there is some
25421 problem that is likely to affect all of them. Roughly speaking, the value of
25422 &%hosts_max_try%& is the maximum number that are tried before deferring the
25423 delivery. However, the logic cannot be quite that simple.
25424
25425 Firstly, IP addresses that are skipped because their retry times have not
25426 arrived do not count, and in addition, addresses that are past their retry
25427 limits are also not counted, even when they are tried. This means that when
25428 some IP addresses are past their retry limits, more than the value of
25429 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25430 that all IP addresses are considered before timing out an email address (but
25431 see below for an exception).
25432
25433 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25434 list to see if there is a subsequent host with a different (higher valued) MX.
25435 If there is, that host is considered next, and the current IP address is used
25436 but not counted. This behaviour helps in the case of a domain with a retry rule
25437 that hardly ever delays any hosts, as is now explained:
25438
25439 Consider the case of a long list of hosts with one MX value, and a few with a
25440 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25441 hosts at the top of the list are tried at first. With the default retry rule,
25442 which specifies increasing retry times, the higher MX hosts are eventually
25443 tried when those at the top of the list are skipped because they have not
25444 reached their retry times.
25445
25446 However, it is common practice to put a fixed short retry time on domains for
25447 large ISPs, on the grounds that their servers are rarely down for very long.
25448 Unfortunately, these are exactly the domains that tend to resolve to long lists
25449 of hosts. The short retry time means that the lowest MX hosts are tried every
25450 time. The attempts may be in a different order because of random sorting, but
25451 without the special MX check, the higher MX hosts would never be tried until
25452 all the lower MX hosts had timed out (which might be several days), because
25453 there are always some lower MX hosts that have reached their retry times. With
25454 the special check, Exim considers at least one IP address from each MX value at
25455 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25456 reached.
25457
25458 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25459 particular, Exim normally eventually tries all the IP addresses before timing
25460 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25461 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25462 been set up with hundreds of IP addresses for some domains. It can
25463 take a very long time indeed for an address to time out in these cases.
25464
25465 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25466 Exim never tries more than this number of IP addresses; if it hits this limit
25467 and they are all timed out, the email address is bounced, even though not all
25468 possible IP addresses have been tried.
25469 .ecindex IIDsmttra1
25470 .ecindex IIDsmttra2
25471
25472
25473
25474
25475
25476 . ////////////////////////////////////////////////////////////////////////////
25477 . ////////////////////////////////////////////////////////////////////////////
25478
25479 .chapter "Address rewriting" "CHAPrewrite"
25480 .scindex IIDaddrew "rewriting" "addresses"
25481 There are some circumstances in which Exim automatically rewrites domains in
25482 addresses. The two most common are when an address is given without a domain
25483 (referred to as an &"unqualified address"&) or when an address contains an
25484 abbreviated domain that is expanded by DNS lookup.
25485
25486 Unqualified envelope addresses are accepted only for locally submitted
25487 messages, or for messages that are received from hosts matching
25488 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25489 appropriate. Unqualified addresses in header lines are qualified if they are in
25490 locally submitted messages, or messages from hosts that are permitted to send
25491 unqualified envelope addresses. Otherwise, unqualified addresses in header
25492 lines are neither qualified nor rewritten.
25493
25494 One situation in which Exim does &'not'& automatically rewrite a domain is
25495 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25496 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25497 do this. The new RFCs do not contain this suggestion.
25498
25499
25500 .section "Explicitly configured address rewriting" "SECID147"
25501 This chapter describes the rewriting rules that can be used in the
25502 main rewrite section of the configuration file, and also in the generic
25503 &%headers_rewrite%& option that can be set on any transport.
25504
25505 Some people believe that configured address rewriting is a Mortal Sin.
25506 Others believe that life is not possible without it. Exim provides the
25507 facility; you do not have to use it.
25508
25509 The main rewriting rules that appear in the &"rewrite"& section of the
25510 configuration file are applied to addresses in incoming messages, both envelope
25511 addresses and addresses in header lines. Each rule specifies the types of
25512 address to which it applies.
25513
25514 Whether or not addresses in header lines are rewritten depends on the origin of
25515 the headers and the type of rewriting. Global rewriting, that is, rewriting
25516 rules from the rewrite section of the configuration file, is applied only to
25517 those headers that were received with the message. Header lines that are added
25518 by ACLs or by a system filter or by individual routers or transports (which
25519 are specific to individual recipient addresses) are not rewritten by the global
25520 rules.
25521
25522 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25523 applies all headers except those added by routers and transports. That is, as
25524 well as the headers that were received with the message, it also applies to
25525 headers that were added by an ACL or a system filter.
25526
25527
25528 In general, rewriting addresses from your own system or domain has some
25529 legitimacy. Rewriting other addresses should be done only with great care and
25530 in special circumstances. The author of Exim believes that rewriting should be
25531 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25532 Although it can sometimes be used as a routing tool, this is very strongly
25533 discouraged.
25534
25535 There are two commonly encountered circumstances where rewriting is used, as
25536 illustrated by these examples:
25537
25538 .ilist
25539 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25540 exchange mail with each other behind a firewall, but there is only a single
25541 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25542 &'hitch.fict.example'& when sending mail off-site.
25543 .next
25544 A host rewrites the local parts of its own users so that, for example,
25545 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25546 .endlist
25547
25548
25549
25550 .section "When does rewriting happen?" "SECID148"
25551 .cindex "rewriting" "timing of"
25552 .cindex "&ACL;" "rewriting addresses in"
25553 Configured address rewriting can take place at several different stages of a
25554 message's processing.
25555
25556 .vindex "&$sender_address$&"
25557 At the start of an ACL for MAIL, the sender address may have been rewritten
25558 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25559 ordinary rewrite rules have yet been applied. If, however, the sender address
25560 is verified in the ACL, it is rewritten before verification, and remains
25561 rewritten thereafter. The subsequent value of &$sender_address$& is the
25562 rewritten address. This also applies if sender verification happens in a
25563 RCPT ACL. Otherwise, when the sender address is not verified, it is
25564 rewritten as soon as a message's header lines have been received.
25565
25566 .vindex "&$domain$&"
25567 .vindex "&$local_part$&"
25568 Similarly, at the start of an ACL for RCPT, the current recipient's address
25569 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25570 rewrite rules have yet been applied to it. However, the behaviour is different
25571 from the sender address when a recipient is verified. The address is rewritten
25572 for the verification, but the rewriting is not remembered at this stage. The
25573 value of &$local_part$& and &$domain$& after verification are always the same
25574 as they were before (that is, they contain the unrewritten &-- except for
25575 SMTP-time rewriting &-- address).
25576
25577 As soon as a message's header lines have been received, all the envelope
25578 recipient addresses are permanently rewritten, and rewriting is also applied to
25579 the addresses in the header lines (if configured). This happens before adding
25580 any header lines that were specified in MAIL or RCPT ACLs, and
25581 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25582 before the DATA ACL and &[local_scan()]& functions are run.
25583
25584 When an address is being routed, either for delivery or for verification,
25585 rewriting is applied immediately to child addresses that are generated by
25586 redirection, unless &%no_rewrite%& is set on the router.
25587
25588 .cindex "envelope from"
25589 .cindex "envelope sender" "rewriting at transport time"
25590 .cindex "rewriting" "at transport time"
25591 .cindex "header lines" "rewriting at transport time"
25592 At transport time, additional rewriting of addresses in header lines can be
25593 specified by setting the generic &%headers_rewrite%& option on a transport.
25594 This option contains rules that are identical in form to those in the rewrite
25595 section of the configuration file. They are applied to the original message
25596 header lines and any that were added by ACLs or a system filter. They are not
25597 applied to header lines that are added by routers or the transport.
25598
25599 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25600 transport option. However, it is not possible to rewrite envelope recipients at
25601 transport time.
25602
25603
25604
25605
25606 .section "Testing the rewriting rules that apply on input" "SECID149"
25607 .cindex "rewriting" "testing"
25608 .cindex "testing" "rewriting"
25609 Exim's input rewriting configuration appears in a part of the runtime
25610 configuration file headed by &"begin rewrite"&. It can be tested by the
25611 &%-brw%& command line option. This takes an address (which can be a full RFC
25612 2822 address) as its argument. The output is a list of how the address would be
25613 transformed by the rewriting rules for each of the different places it might
25614 appear in an incoming message, that is, for each different header and for the
25615 envelope sender and recipient fields. For example,
25616 .code
25617 exim -brw ph10@exim.workshop.example
25618 .endd
25619 might produce the output
25620 .code
25621 sender: Philip.Hazel@exim.workshop.example
25622 from: Philip.Hazel@exim.workshop.example
25623 to: ph10@exim.workshop.example
25624 cc: ph10@exim.workshop.example
25625 bcc: ph10@exim.workshop.example
25626 reply-to: Philip.Hazel@exim.workshop.example
25627 env-from: Philip.Hazel@exim.workshop.example
25628 env-to: ph10@exim.workshop.example
25629 .endd
25630 which shows that rewriting has been set up for that address when used in any of
25631 the source fields, but not when it appears as a recipient address. At the
25632 present time, there is no equivalent way of testing rewriting rules that are
25633 set for a particular transport.
25634
25635
25636 .section "Rewriting rules" "SECID150"
25637 .cindex "rewriting" "rules"
25638 The rewrite section of the configuration file consists of lines of rewriting
25639 rules in the form
25640 .display
25641 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25642 .endd
25643 Rewriting rules that are specified for the &%headers_rewrite%& generic
25644 transport option are given as a colon-separated list. Each item in the list
25645 takes the same form as a line in the main rewriting configuration (except that
25646 any colons must be doubled, of course).
25647
25648 The formats of source patterns and replacement strings are described below.
25649 Each is terminated by white space, unless enclosed in double quotes, in which
25650 case normal quoting conventions apply inside the quotes. The flags are single
25651 characters which may appear in any order. Spaces and tabs between them are
25652 ignored.
25653
25654 For each address that could potentially be rewritten, the rules are scanned in
25655 order, and replacements for the address from earlier rules can themselves be
25656 replaced by later rules (but see the &"q"& and &"R"& flags).
25657
25658 The order in which addresses are rewritten is undefined, may change between
25659 releases, and must not be relied on, with one exception: when a message is
25660 received, the envelope sender is always rewritten first, before any header
25661 lines are rewritten. For example, the replacement string for a rewrite of an
25662 address in &'To:'& must not assume that the message's address in &'From:'& has
25663 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25664 that the envelope sender has already been rewritten.
25665
25666 .vindex "&$domain$&"
25667 .vindex "&$local_part$&"
25668 The variables &$local_part$& and &$domain$& can be used in the replacement
25669 string to refer to the address that is being rewritten. Note that lookup-driven
25670 rewriting can be done by a rule of the form
25671 .code
25672 *@*   ${lookup ...
25673 .endd
25674 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25675 refer to the address that is being rewritten.
25676
25677
25678 .section "Rewriting patterns" "SECID151"
25679 .cindex "rewriting" "patterns"
25680 .cindex "address list" "in a rewriting pattern"
25681 The source pattern in a rewriting rule is any item which may appear in an
25682 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25683 single-item address list, which means that it is expanded before being tested
25684 against the address. As always, if you use a regular expression as a pattern,
25685 you must take care to escape dollar and backslash characters, or use the &`\N`&
25686 facility to suppress string expansion within the regular expression.
25687
25688 Domains in patterns should be given in lower case. Local parts in patterns are
25689 case-sensitive. If you want to do case-insensitive matching of local parts, you
25690 can use a regular expression that starts with &`^(?i)`&.
25691
25692 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25693 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25694 depending on the type of match which occurred. These can be used in the
25695 replacement string to insert portions of the incoming address. &$0$& always
25696 refers to the complete incoming address. When a regular expression is used, the
25697 numerical variables are set from its capturing subexpressions. For other types
25698 of pattern they are set as follows:
25699
25700 .ilist
25701 If a local part or domain starts with an asterisk, the numerical variables
25702 refer to the character strings matched by asterisks, with &$1$& associated with
25703 the first asterisk, and &$2$& with the second, if present. For example, if the
25704 pattern
25705 .code
25706 *queen@*.fict.example
25707 .endd
25708 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25709 .code
25710 $0 = hearts-queen@wonderland.fict.example
25711 $1 = hearts-
25712 $2 = wonderland
25713 .endd
25714 Note that if the local part does not start with an asterisk, but the domain
25715 does, it is &$1$& that contains the wild part of the domain.
25716
25717 .next
25718 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25719 of the domain are placed in the next available numerical variables. Suppose,
25720 for example, that the address &'foo@bar.baz.example'& is processed by a
25721 rewriting rule of the form
25722 .display
25723 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25724 .endd
25725 and the key in the file that matches the domain is &`*.baz.example`&. Then
25726 .code
25727 $1 = foo
25728 $2 = bar
25729 $3 = baz.example
25730 .endd
25731 If the address &'foo@baz.example'& is looked up, this matches the same
25732 wildcard file entry, and in this case &$2$& is set to the empty string, but
25733 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25734 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25735 whole domain. For non-partial domain lookups, no numerical variables are set.
25736 .endlist
25737
25738
25739 .section "Rewriting replacements" "SECID152"
25740 .cindex "rewriting" "replacements"
25741 If the replacement string for a rule is a single asterisk, addresses that
25742 match the pattern and the flags are &'not'& rewritten, and no subsequent
25743 rewriting rules are scanned. For example,
25744 .code
25745 hatta@lookingglass.fict.example  *  f
25746 .endd
25747 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25748 &'From:'& headers.
25749
25750 .vindex "&$domain$&"
25751 .vindex "&$local_part$&"
25752 If the replacement string is not a single asterisk, it is expanded, and must
25753 yield a fully qualified address. Within the expansion, the variables
25754 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25755 Any letters they contain retain their original case &-- they are not lower
25756 cased. The numerical variables are set up according to the type of pattern that
25757 matched the address, as described above. If the expansion is forced to fail by
25758 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25759 current rule is abandoned, but subsequent rules may take effect. Any other
25760 expansion failure causes the entire rewriting operation to be abandoned, and an
25761 entry written to the panic log.
25762
25763
25764
25765 .section "Rewriting flags" "SECID153"
25766 There are three different kinds of flag that may appear on rewriting rules:
25767
25768 .ilist
25769 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25770 c, f, h, r, s, t.
25771 .next
25772 A flag that specifies rewriting at SMTP time: S.
25773 .next
25774 Flags that control the rewriting process: Q, q, R, w.
25775 .endlist
25776
25777 For rules that are part of the &%headers_rewrite%& generic transport option,
25778 E, F, T, and S are not permitted.
25779
25780
25781
25782 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25783          "SECID154"
25784 .cindex "rewriting" "flags"
25785 If none of the following flag letters, nor the &"S"& flag (see section
25786 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25787 and to both the sender and recipient fields of the envelope, whereas a
25788 transport-time rewriting rule just applies to all headers. Otherwise, the
25789 rewriting rule is skipped unless the relevant addresses are being processed.
25790 .display
25791 &`E`&       rewrite all envelope fields
25792 &`F`&       rewrite the envelope From field
25793 &`T`&       rewrite the envelope To field
25794 &`b`&       rewrite the &'Bcc:'& header
25795 &`c`&       rewrite the &'Cc:'& header
25796 &`f`&       rewrite the &'From:'& header
25797 &`h`&       rewrite all headers
25798 &`r`&       rewrite the &'Reply-To:'& header
25799 &`s`&       rewrite the &'Sender:'& header
25800 &`t`&       rewrite the &'To:'& header
25801 .endd
25802 "All headers" means all of the headers listed above that can be selected
25803 individually, plus their &'Resent-'& versions. It does not include
25804 other headers such as &'Subject:'& etc.
25805
25806 You should be particularly careful about rewriting &'Sender:'& headers, and
25807 restrict this to special known cases in your own domains.
25808
25809
25810 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25811 .cindex "SMTP" "rewriting malformed addresses"
25812 .cindex "RCPT" "rewriting argument of"
25813 .cindex "MAIL" "rewriting argument of"
25814 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25815 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25816 before any other processing; even before syntax checking. The pattern is
25817 required to be a regular expression, and it is matched against the whole of the
25818 data for the command, including any surrounding angle brackets.
25819
25820 .vindex "&$domain$&"
25821 .vindex "&$local_part$&"
25822 This form of rewrite rule allows for the handling of addresses that are not
25823 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25824 input). Because the input is not required to be a syntactically valid address,
25825 the variables &$local_part$& and &$domain$& are not available during the
25826 expansion of the replacement string. The result of rewriting replaces the
25827 original address in the MAIL or RCPT command.
25828
25829
25830 .section "Flags controlling the rewriting process" "SECID155"
25831 There are four flags which control the way the rewriting process works. These
25832 take effect only when a rule is invoked, that is, when the address is of the
25833 correct type (matches the flags) and matches the pattern:
25834
25835 .ilist
25836 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25837 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25838 absence of &"Q"& the rewritten address must always include a domain.
25839 .next
25840 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25841 even if no rewriting actually takes place because of a &"fail"& in the
25842 expansion. The &"q"& flag is not effective if the address is of the wrong type
25843 (does not match the flags) or does not match the pattern.
25844 .next
25845 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25846 address, up to ten times. It can be combined with the &"q"& flag, to stop
25847 rewriting once it fails to match (after at least one successful rewrite).
25848 .next
25849 .cindex "rewriting" "whole addresses"
25850 When an address in a header is rewritten, the rewriting normally applies only
25851 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25852 left unchanged. For example, rewriting might change
25853 .code
25854 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25855 .endd
25856 into
25857 .code
25858 From: Ford Prefect <prefectf@hitch.fict.example>
25859 .endd
25860 .cindex "RFC 2047"
25861 Sometimes there is a need to replace the whole address item, and this can be
25862 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25863 causes an address in a header line to be rewritten, the entire address is
25864 replaced, not just the working part. The replacement must be a complete RFC
25865 2822 address, including the angle brackets if necessary. If text outside angle
25866 brackets contains a character whose value is greater than 126 or less than 32
25867 (except for tab), the text is encoded according to RFC 2047. The character set
25868 is taken from &%headers_charset%&, which gets its default at build time.
25869
25870 When the &"w"& flag is set on a rule that causes an envelope address to be
25871 rewritten, all but the working part of the replacement address is discarded.
25872 .endlist
25873
25874
25875 .section "Rewriting examples" "SECID156"
25876 Here is an example of the two common rewriting paradigms:
25877 .code
25878 *@*.hitch.fict.example  $1@hitch.fict.example
25879 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25880                      {$value}fail}@hitch.fict.example bctfrF
25881 .endd
25882 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25883 the string expansion to fail if the lookup does not succeed. In this context it
25884 has the effect of leaving the original address unchanged, but Exim goes on to
25885 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25886 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25887 explicitly, which would cause the rewritten address to be the same as before,
25888 at the cost of a small bit of processing. Not supplying either of these is an
25889 error, since the rewritten address would then contain no local part.
25890
25891 The first example above replaces the domain with a superior, more general
25892 domain. This may not be desirable for certain local parts. If the rule
25893 .code
25894 root@*.hitch.fict.example  *
25895 .endd
25896 were inserted before the first rule, rewriting would be suppressed for the
25897 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25898
25899 Rewriting can be made conditional on a number of tests, by making use of
25900 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25901 messages that originate outside the local host:
25902 .code
25903 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25904                          {$1@hitch.fict.example}fail}"
25905 .endd
25906 The replacement string is quoted in this example because it contains white
25907 space.
25908
25909 .cindex "rewriting" "bang paths"
25910 .cindex "bang paths" "rewriting"
25911 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25912 an address it treats it as an unqualified local part which it qualifies with
25913 the local qualification domain (if the source of the message is local or if the
25914 remote host is permitted to send unqualified addresses). Rewriting can
25915 sometimes be used to handle simple bang paths with a fixed number of
25916 components. For example, the rule
25917 .code
25918 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25919 .endd
25920 rewrites a two-component bang path &'host.name!user'& as the domain address
25921 &'user@host.name'&. However, there is a security implication in using this as
25922 a global rewriting rule for envelope addresses. It can provide a backdoor
25923 method for using your system as a relay, because the incoming addresses appear
25924 to be local. If the bang path addresses are received via SMTP, it is safer to
25925 use the &"S"& flag to rewrite them as they are received, so that relay checking
25926 can be done on the rewritten addresses.
25927 .ecindex IIDaddrew
25928
25929
25930
25931
25932
25933 . ////////////////////////////////////////////////////////////////////////////
25934 . ////////////////////////////////////////////////////////////////////////////
25935
25936 .chapter "Retry configuration" "CHAPretry"
25937 .scindex IIDretconf1 "retry" "configuration, description of"
25938 .scindex IIDregconf2 "configuration file" "retry section"
25939 The &"retry"& section of the runtime configuration file contains a list of
25940 retry rules that control how often Exim tries to deliver messages that cannot
25941 be delivered at the first attempt. If there are no retry rules (the section is
25942 empty or not present), there are no retries. In this situation, temporary
25943 errors are treated as permanent. The default configuration contains a single,
25944 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25945 line option can be used to test which retry rule will be used for a given
25946 address, domain and error.
25947
25948 The most common cause of retries is temporary failure to deliver to a remote
25949 host because the host is down, or inaccessible because of a network problem.
25950 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25951 address) basis, not on a per-message basis. Thus, if one message has recently
25952 been delayed, delivery of a new message to the same host is not immediately
25953 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25954 log selector is set, the message
25955 .cindex "retry" "time not reached"
25956 &"retry time not reached"& is written to the main log whenever a delivery is
25957 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25958 the handling of errors during remote deliveries.
25959
25960 Retry processing applies to routing as well as to delivering, except as covered
25961 in the next paragraph. The retry rules do not distinguish between these
25962 actions. It is not possible, for example, to specify different behaviour for
25963 failures to route the domain &'snark.fict.example'& and failures to deliver to
25964 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25965 added complication, so did not implement it. However, although they share the
25966 same retry rule, the actual retry times for routing and transporting a given
25967 domain are maintained independently.
25968
25969 When a delivery is not part of a queue run (typically an immediate delivery on
25970 receipt of a message), the routers are always run, and local deliveries are
25971 always attempted, even if retry times are set for them. This makes for better
25972 behaviour if one particular message is causing problems (for example, causing
25973 quota overflow, or provoking an error in a filter file). If such a delivery
25974 suffers a temporary failure, the retry data is updated as normal, and
25975 subsequent delivery attempts from queue runs occur only when the retry time for
25976 the local address is reached.
25977
25978 .section "Changing retry rules" "SECID157"
25979 If you change the retry rules in your configuration, you should consider
25980 whether or not to delete the retry data that is stored in Exim's spool area in
25981 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25982 always safe; that is why they are called &"hints"&.
25983
25984 The hints retry data contains suggested retry times based on the previous
25985 rules. In the case of a long-running problem with a remote host, it might
25986 record the fact that the host has timed out. If your new rules increase the
25987 timeout time for such a host, you should definitely remove the old retry data
25988 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25989 messages that it should now be retaining.
25990
25991
25992
25993 .section "Format of retry rules" "SECID158"
25994 .cindex "retry" "rules"
25995 Each retry rule occupies one line and consists of three or four parts,
25996 separated by white space: a pattern, an error name, an optional list of sender
25997 addresses, and a list of retry parameters. The pattern and sender lists must be
25998 enclosed in double quotes if they contain white space. The rules are searched
25999 in order until one is found where the pattern, error name, and sender list (if
26000 present) match the failing host or address, the error that occurred, and the
26001 message's sender, respectively.
26002
26003
26004 The pattern is any single item that may appear in an address list (see section
26005 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26006 which means that it is expanded before being tested against the address that
26007 has been delayed. A negated address list item is permitted. Address
26008 list processing treats a plain domain name as if it were preceded by &"*@"&,
26009 which makes it possible for many retry rules to start with just a domain. For
26010 example,
26011 .code
26012 lookingglass.fict.example        *  F,24h,30m;
26013 .endd
26014 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26015 whereas
26016 .code
26017 alice@lookingglass.fict.example  *  F,24h,30m;
26018 .endd
26019 applies only to temporary failures involving the local part &%alice%&.
26020 In practice, almost all rules start with a domain name pattern without a local
26021 part.
26022
26023 .cindex "regular expressions" "in retry rules"
26024 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26025 must match a complete address, not just a domain, because that is how regular
26026 expressions work in address lists.
26027 .display
26028 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26029 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26030 .endd
26031
26032
26033 .section "Choosing which retry rule to use for address errors" "SECID159"
26034 When Exim is looking for a retry rule after a routing attempt has failed (for
26035 example, after a DNS timeout), each line in the retry configuration is tested
26036 against the complete address only if &%retry_use_local_part%& is set for the
26037 router. Otherwise, only the domain is used, except when matching against a
26038 regular expression, when the local part of the address is replaced with &"*"&.
26039 A domain on its own can match a domain pattern, or a pattern that starts with
26040 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26041 &%check_local_user%& is true, and false for other routers.
26042
26043 Similarly, when Exim is looking for a retry rule after a local delivery has
26044 failed (for example, after a mailbox full error), each line in the retry
26045 configuration is tested against the complete address only if
26046 &%retry_use_local_part%& is set for the transport (it defaults true for all
26047 local transports).
26048
26049 .cindex "4&'xx'& responses" "retry rules for"
26050 However, when Exim is looking for a retry rule after a remote delivery attempt
26051 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26052 whole address is always used as the key when searching the retry rules. The
26053 rule that is found is used to create a retry time for the combination of the
26054 failing address and the message's sender. It is the combination of sender and
26055 recipient that is delayed in subsequent queue runs until its retry time is
26056 reached. You can delay the recipient without regard to the sender by setting
26057 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26058 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26059 commands.
26060
26061
26062
26063 .section "Choosing which retry rule to use for host and message errors" &&&
26064          "SECID160"
26065 For a temporary error that is not related to an individual address (for
26066 example, a connection timeout), each line in the retry configuration is checked
26067 twice. First, the name of the remote host is used as a domain name (preceded by
26068 &"*@"& when matching a regular expression). If this does not match the line,
26069 the domain from the email address is tried in a similar fashion. For example,
26070 suppose the MX records for &'a.b.c.example'& are
26071 .code
26072 a.b.c.example  MX  5  x.y.z.example
26073                MX  6  p.q.r.example
26074                MX  7  m.n.o.example
26075 .endd
26076 and the retry rules are
26077 .code
26078 p.q.r.example    *      F,24h,30m;
26079 a.b.c.example    *      F,4d,45m;
26080 .endd
26081 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26082 first rule matches neither the host nor the domain, so Exim looks at the second
26083 rule. This does not match the host, but it does match the domain, so it is used
26084 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26085 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26086 first retry rule is used, because it matches the host.
26087
26088 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26089 first rule to determine retry times, but for all the other hosts for the domain
26090 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26091 routing to &'a.b.c.example'& suffers a temporary failure.
26092
26093 &*Note*&: The host name is used when matching the patterns, not its IP address.
26094 However, if a message is routed directly to an IP address without the use of a
26095 host name, for example, if a &(manualroute)& router contains a setting such as:
26096 .code
26097 route_list = *.a.example  192.168.34.23
26098 .endd
26099 then the &"host name"& that is used when searching for a retry rule is the
26100 textual form of the IP address.
26101
26102 .section "Retry rules for specific errors" "SECID161"
26103 .cindex "retry" "specific errors; specifying"
26104 The second field in a retry rule is the name of a particular error, or an
26105 asterisk, which matches any error. The errors that can be tested for are:
26106
26107 .vlist
26108 .vitem &%auth_failed%&
26109 Authentication failed when trying to send to a host in the
26110 &%hosts_require_auth%& list in an &(smtp)& transport.
26111
26112 .vitem &%data_4xx%&
26113 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26114 after the command, or after sending the message's data.
26115
26116 .vitem &%mail_4xx%&
26117 A 4&'xx'& error was received for an outgoing MAIL command.
26118
26119 .vitem &%rcpt_4xx%&
26120 A 4&'xx'& error was received for an outgoing RCPT command.
26121 .endlist
26122
26123 For the three 4&'xx'& errors, either the first or both of the x's can be given
26124 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26125 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26126 and have retries every ten minutes with a one-hour timeout, you could set up a
26127 retry rule of this form:
26128 .code
26129 the.domain.name  rcpt_452   F,1h,10m
26130 .endd
26131 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26132 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26133
26134 .vlist
26135 .vitem &%lost_connection%&
26136 A server unexpectedly closed the SMTP connection. There may, of course,
26137 legitimate reasons for this (host died, network died), but if it repeats a lot
26138 for the same host, it indicates something odd.
26139
26140 .vitem &%lookup%&
26141 A DNS lookup for a host failed.
26142 Note that a &%dnslookup%& router will need to have matched
26143 its &%fail_defer_domains%& option for this retry type to be usable.
26144 Also note that a &%manualroute%& router will probably need
26145 its &%host_find_failed%& option set to &%defer%&.
26146
26147 .vitem &%refused_MX%&
26148 A connection to a host obtained from an MX record was refused.
26149
26150 .vitem &%refused_A%&
26151 A connection to a host not obtained from an MX record was refused.
26152
26153 .vitem &%refused%&
26154 A connection was refused.
26155
26156 .vitem &%timeout_connect_MX%&
26157 A connection attempt to a host obtained from an MX record timed out.
26158
26159 .vitem &%timeout_connect_A%&
26160 A connection attempt to a host not obtained from an MX record timed out.
26161
26162 .vitem &%timeout_connect%&
26163 A connection attempt timed out.
26164
26165 .vitem &%timeout_MX%&
26166 There was a timeout while connecting or during an SMTP session with a host
26167 obtained from an MX record.
26168
26169 .vitem &%timeout_A%&
26170 There was a timeout while connecting or during an SMTP session with a host not
26171 obtained from an MX record.
26172
26173 .vitem &%timeout%&
26174 There was a timeout while connecting or during an SMTP session.
26175
26176 .vitem &%tls_required%&
26177 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26178 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26179 to STARTTLS, or there was a problem setting up the TLS connection.
26180
26181 .vitem &%quota%&
26182 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26183 transport.
26184
26185 .vitem &%quota_%&<&'time'&>
26186 .cindex "quota" "error testing in retry rule"
26187 .cindex "retry" "quota error testing"
26188 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26189 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26190 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26191 for four days.
26192 .endlist
26193
26194 .cindex "mailbox" "time of last read"
26195 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26196 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26197 it should be based on the last time that the user accessed the mailbox.
26198 However, it is not always possible to determine this. Exim uses the following
26199 heuristic rules:
26200
26201 .ilist
26202 If the mailbox is a single file, the time of last access (the &"atime"&) is
26203 used. As no new messages are being delivered (because the mailbox is over
26204 quota), Exim does not access the file, so this is the time of last user access.
26205 .next
26206 .cindex "maildir format" "time of last read"
26207 For a maildir delivery, the time of last modification of the &_new_&
26208 subdirectory is used. As the mailbox is over quota, no new files are created in
26209 the &_new_& subdirectory, because no new messages are being delivered. Any
26210 change to the &_new_& subdirectory is therefore assumed to be the result of an
26211 MUA moving a new message to the &_cur_& directory when it is first read. The
26212 time that is used is therefore the last time that the user read a new message.
26213 .next
26214 For other kinds of multi-file mailbox, the time of last access cannot be
26215 obtained, so a retry rule that uses this type of error field is never matched.
26216 .endlist
26217
26218 The quota errors apply both to system-enforced quotas and to Exim's own quota
26219 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26220 when a local delivery is deferred because a partition is full (the ENOSPC
26221 error).
26222
26223
26224
26225 .section "Retry rules for specified senders" "SECID162"
26226 .cindex "retry" "rules; sender-specific"
26227 You can specify retry rules that apply only when the failing message has a
26228 specific sender. In particular, this can be used to define retry rules that
26229 apply only to bounce messages. The third item in a retry rule can be of this
26230 form:
26231 .display
26232 &`senders=`&<&'address list'&>
26233 .endd
26234 The retry timings themselves are then the fourth item. For example:
26235 .code
26236 *   rcpt_4xx   senders=:   F,1h,30m
26237 .endd
26238 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26239 host. If the address list contains white space, it must be enclosed in quotes.
26240 For example:
26241 .code
26242 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26243 .endd
26244 &*Warning*&: This facility can be unhelpful if it is used for host errors
26245 (which do not depend on the recipient). The reason is that the sender is used
26246 only to match the retry rule. Once the rule has been found for a host error,
26247 its contents are used to set a retry time for the host, and this will apply to
26248 all messages, not just those with specific senders.
26249
26250 When testing retry rules using &%-brt%&, you can supply a sender using the
26251 &%-f%& command line option, like this:
26252 .code
26253 exim -f "" -brt user@dom.ain
26254 .endd
26255 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26256 list is never matched.
26257
26258
26259
26260
26261
26262 .section "Retry parameters" "SECID163"
26263 .cindex "retry" "parameters in rules"
26264 The third (or fourth, if a senders list is present) field in a retry rule is a
26265 sequence of retry parameter sets, separated by semicolons. Each set consists of
26266 .display
26267 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26268 .endd
26269 The letter identifies the algorithm for computing a new retry time; the cutoff
26270 time is the time beyond which this algorithm no longer applies, and the
26271 arguments vary the algorithm's action. The cutoff time is measured from the
26272 time that the first failure for the domain (combined with the local part if
26273 relevant) was detected, not from the time the message was received.
26274
26275 .cindex "retry" "algorithms"
26276 .cindex "retry" "fixed intervals"
26277 .cindex "retry" "increasing intervals"
26278 .cindex "retry" "random intervals"
26279 The available algorithms are:
26280
26281 .ilist
26282 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26283 the interval.
26284 .next
26285 &'G'&: retry at geometrically increasing intervals. The first argument
26286 specifies a starting value for the interval, and the second a multiplier, which
26287 is used to increase the size of the interval at each retry.
26288 .next
26289 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26290 retry, the previous interval is multiplied by the factor in order to get a
26291 maximum for the next interval. The minimum interval is the first argument of
26292 the parameter, and an actual interval is chosen randomly between them. Such a
26293 rule has been found to be helpful in cluster configurations when all the
26294 members of the cluster restart at once, and may therefore synchronize their
26295 queue processing times.
26296 .endlist
26297
26298 When computing the next retry time, the algorithm definitions are scanned in
26299 order until one whose cutoff time has not yet passed is reached. This is then
26300 used to compute a new retry time that is later than the current time. In the
26301 case of fixed interval retries, this simply means adding the interval to the
26302 current time. For geometrically increasing intervals, retry intervals are
26303 computed from the rule's parameters until one that is greater than the previous
26304 interval is found. The main configuration variable
26305 .cindex "limit" "retry interval"
26306 .cindex "retry" "interval, maximum"
26307 .oindex "&%retry_interval_max%&"
26308 &%retry_interval_max%& limits the maximum interval between retries. It
26309 cannot be set greater than &`24h`&, which is its default value.
26310
26311 A single remote domain may have a number of hosts associated with it, and each
26312 host may have more than one IP address. Retry algorithms are selected on the
26313 basis of the domain name, but are applied to each IP address independently. If,
26314 for example, a host has two IP addresses and one is unusable, Exim will
26315 generate retry times for it and will not try to use it until its next retry
26316 time comes. Thus the good IP address is likely to be tried first most of the
26317 time.
26318
26319 .cindex "hints database" "use for retrying"
26320 Retry times are hints rather than promises. Exim does not make any attempt to
26321 run deliveries exactly at the computed times. Instead, a queue runner process
26322 starts delivery processes for delayed messages periodically, and these attempt
26323 new deliveries only for those addresses that have passed their next retry time.
26324 If a new message arrives for a deferred address, an immediate delivery attempt
26325 occurs only if the address has passed its retry time. In the absence of new
26326 messages, the minimum time between retries is the interval between queue runner
26327 processes. There is not much point in setting retry times of five minutes if
26328 your queue runners happen only once an hour, unless there are a significant
26329 number of incoming messages (which might be the case on a system that is
26330 sending everything to a smart host, for example).
26331
26332 The data in the retry hints database can be inspected by using the
26333 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26334 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26335 &'exinext'& utility script can be used to find out what the next retry times
26336 are for the hosts associated with a particular mail domain, and also for local
26337 deliveries that have been deferred.
26338
26339
26340 .section "Retry rule examples" "SECID164"
26341 Here are some example retry rules:
26342 .code
26343 alice@wonderland.fict.example quota_5d  F,7d,3h
26344 wonderland.fict.example       quota_5d
26345 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26346 lookingglass.fict.example     *         F,24h,30m;
26347 *                 refused_A   F,2h,20m;
26348 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26349 .endd
26350 The first rule sets up special handling for mail to
26351 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26352 mailbox has not been read for at least 5 days. Retries continue every three
26353 hours for 7 days. The second rule handles over-quota errors for all other local
26354 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26355 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26356 fail are bounced immediately if the mailbox has not been read for at least 5
26357 days.
26358
26359 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26360 happen every 15 minutes for an hour, then with geometrically increasing
26361 intervals until two days have passed since a delivery first failed. After the
26362 first hour there is a delay of one hour, then two hours, then four hours, and
26363 so on (this is a rather extreme example).
26364
26365 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26366 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26367 all other domains, with special action for connection refusal from hosts that
26368 were not obtained from an MX record.
26369
26370 The final rule in a retry configuration should always have asterisks in the
26371 first two fields so as to provide a general catch-all for any addresses that do
26372 not have their own special handling. This example tries every 15 minutes for 2
26373 hours, then with intervals starting at one hour and increasing by a factor of
26374 1.5 up to 16 hours, then every 8 hours up to 5 days.
26375
26376
26377
26378 .section "Timeout of retry data" "SECID165"
26379 .cindex "timeout" "of retry data"
26380 .oindex "&%retry_data_expire%&"
26381 .cindex "hints database" "data expiry"
26382 .cindex "retry" "timeout of data"
26383 Exim timestamps the data that it writes to its retry hints database. When it
26384 consults the data during a delivery it ignores any that is older than the value
26385 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26386 been tried for 7 days, Exim will try to deliver to it immediately a message
26387 arrives, and if that fails, it will calculate a retry time as if it were
26388 failing for the first time.
26389
26390 This improves the behaviour for messages routed to rarely-used hosts such as MX
26391 backups. If such a host was down at one time, and happens to be down again when
26392 Exim tries a month later, using the old retry data would imply that it had been
26393 down all the time, which is not a justified assumption.
26394
26395 If a host really is permanently dead, this behaviour causes a burst of retries
26396 every now and again, but only if messages routed to it are rare. If there is a
26397 message at least once every 7 days the retry data never expires.
26398
26399
26400
26401
26402 .section "Long-term failures" "SECID166"
26403 .cindex "delivery failure, long-term"
26404 .cindex "retry" "after long-term failure"
26405 Special processing happens when an email address has been failing for so long
26406 that the cutoff time for the last algorithm is reached. For example, using the
26407 default retry rule:
26408 .code
26409 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26410 .endd
26411 the cutoff time is four days. Reaching the retry cutoff is independent of how
26412 long any specific message has been failing; it is the length of continuous
26413 failure for the recipient address that counts.
26414
26415 When the cutoff time is reached for a local delivery, or for all the IP
26416 addresses associated with a remote delivery, a subsequent delivery failure
26417 causes Exim to give up on the address, and a bounce message is generated.
26418 In order to cater for new messages that use the failing address, a next retry
26419 time is still computed from the final algorithm, and is used as follows:
26420
26421 For local deliveries, one delivery attempt is always made for any subsequent
26422 messages. If this delivery fails, the address fails immediately. The
26423 post-cutoff retry time is not used.
26424
26425 .cindex "final cutoff" "retries, controlling"
26426 .cindex retry "final cutoff"
26427 If the delivery is remote, there are two possibilities, controlled by the
26428 .oindex "&%delay_after_cutoff%&"
26429 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26430 default. Until the post-cutoff retry time for one of the IP addresses,
26431 as set by the &%retry_data_expire%& option, is
26432 reached, the failing email address is bounced immediately, without a delivery
26433 attempt taking place. After that time, one new delivery attempt is made to
26434 those IP addresses that are past their retry times, and if that still fails,
26435 the address is bounced and new retry times are computed.
26436
26437 In other words, when all the hosts for a given email address have been failing
26438 for a long time, Exim bounces rather then defers until one of the hosts' retry
26439 times is reached. Then it tries once, and bounces if that attempt fails. This
26440 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26441 to a broken destination, but if the host does recover, Exim will eventually
26442 notice.
26443
26444 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26445 addresses are past their final cutoff time, Exim tries to deliver to those IP
26446 addresses that have not been tried since the message arrived. If there are
26447 no suitable IP addresses, or if they all fail, the address is bounced. In other
26448 words, it does not delay when a new message arrives, but tries the expired
26449 addresses immediately, unless they have been tried since the message arrived.
26450 If there is a continuous stream of messages for the failing domains, setting
26451 &%delay_after_cutoff%& false means that there will be many more attempts to
26452 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26453 true.
26454
26455 .section "Deliveries that work intermittently" "SECID167"
26456 .cindex "retry" "intermittently working deliveries"
26457 Some additional logic is needed to cope with cases where a host is
26458 intermittently available, or when a message has some attribute that prevents
26459 its delivery when others to the same address get through. In this situation,
26460 because some messages are successfully delivered, the &"retry clock"& for the
26461 host or address keeps getting reset by the successful deliveries, and so
26462 failing messages remain in the queue for ever because the cutoff time is never
26463 reached.
26464
26465 Two exceptional actions are applied to prevent this happening. The first
26466 applies to errors that are related to a message rather than a remote host.
26467 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26468 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26469 commands, and quota failures. For this type of error, if a message's arrival
26470 time is earlier than the &"first failed"& time for the error, the earlier time
26471 is used when scanning the retry rules to decide when to try next and when to
26472 time out the address.
26473
26474 The exceptional second action applies in all cases. If a message has been on
26475 the queue for longer than the cutoff time of any applicable retry rule for a
26476 given address, a delivery is attempted for that address, even if it is not yet
26477 time, and if this delivery fails, the address is timed out. A new retry time is
26478 not computed in this case, so that other messages for the same address are
26479 considered immediately.
26480 .ecindex IIDretconf1
26481 .ecindex IIDregconf2
26482
26483
26484
26485
26486
26487
26488 . ////////////////////////////////////////////////////////////////////////////
26489 . ////////////////////////////////////////////////////////////////////////////
26490
26491 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26492 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26493 .scindex IIDauthconf2 "authentication"
26494 The &"authenticators"& section of Exim's runtime configuration is concerned
26495 with SMTP authentication. This facility is an extension to the SMTP protocol,
26496 described in RFC 2554, which allows a client SMTP host to authenticate itself
26497 to a server. This is a common way for a server to recognize clients that are
26498 permitted to use it as a relay. SMTP authentication is not of relevance to the
26499 transfer of mail between servers that have no managerial connection with each
26500 other.
26501
26502 .cindex "AUTH" "description of"
26503 Very briefly, the way SMTP authentication works is as follows:
26504
26505 .ilist
26506 The server advertises a number of authentication &'mechanisms'& in response to
26507 the client's EHLO command.
26508 .next
26509 The client issues an AUTH command, naming a specific mechanism. The command
26510 may, optionally, contain some authentication data.
26511 .next
26512 The server may issue one or more &'challenges'&, to which the client must send
26513 appropriate responses. In simple authentication mechanisms, the challenges are
26514 just prompts for user names and passwords. The server does not have to issue
26515 any challenges &-- in some mechanisms the relevant data may all be transmitted
26516 with the AUTH command.
26517 .next
26518 The server either accepts or denies authentication.
26519 .next
26520 If authentication succeeds, the client may optionally make use of the AUTH
26521 option on the MAIL command to pass an authenticated sender in subsequent
26522 mail transactions. Authentication lasts for the remainder of the SMTP
26523 connection.
26524 .next
26525 If authentication fails, the client may give up, or it may try a different
26526 authentication mechanism, or it may try transferring mail over the
26527 unauthenticated connection.
26528 .endlist
26529
26530 If you are setting up a client, and want to know which authentication
26531 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26532 SMTP port) on the server, and issue an EHLO command. The response to this
26533 includes the list of supported mechanisms. For example:
26534 .display
26535 &`$ `&&*&`telnet server.example 25`&*&
26536 &`Trying 192.168.34.25...`&
26537 &`Connected to server.example.`&
26538 &`Escape character is &#x0027;^]&#x0027;.`&
26539 &`220 server.example ESMTP Exim 4.20 ...`&
26540 &*&`ehlo client.example`&*&
26541 &`250-server.example Hello client.example [10.8.4.5]`&
26542 &`250-SIZE 52428800`&
26543 &`250-PIPELINING`&
26544 &`250-AUTH PLAIN`&
26545 &`250 HELP`&
26546 .endd
26547 The second-last line of this example output shows that the server supports
26548 authentication using the PLAIN mechanism. In Exim, the different authentication
26549 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26550 routers and transports, which authenticators are included in the binary is
26551 controlled by build-time definitions. The following are currently available,
26552 included by setting
26553 .code
26554 AUTH_CRAM_MD5=yes
26555 AUTH_CYRUS_SASL=yes
26556 AUTH_DOVECOT=yes
26557 AUTH_EXTERNAL=yes
26558 AUTH_GSASL=yes
26559 AUTH_HEIMDAL_GSSAPI=yes
26560 AUTH_PLAINTEXT=yes
26561 AUTH_SPA=yes
26562 AUTH_TLS=yes
26563 .endd
26564 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26565 authentication mechanism (RFC 2195), and the second provides an interface to
26566 the Cyrus SASL authentication library.
26567 The third is an interface to Dovecot's authentication system, delegating the
26568 work via a socket interface.
26569 The fourth provides for negotiation of authentication done via non-SMTP means,
26570 as defined by RFC 4422 Appendix A.
26571 The fifth provides an interface to the GNU SASL authentication library, which
26572 provides mechanisms but typically not data sources.
26573 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26574 supporting setting a server keytab.
26575 The seventh can be configured to support
26576 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26577 not formally documented, but used by several MUAs.
26578 The eighth authenticator
26579 supports Microsoft's &'Secure Password Authentication'& mechanism.
26580 The last is an Exim authenticator but not an SMTP one;
26581 instead it can use information from a TLS negotiation.
26582
26583 The authenticators are configured using the same syntax as other drivers (see
26584 section &<<SECTfordricon>>&). If no authenticators are required, no
26585 authentication section need be present in the configuration file. Each
26586 authenticator can in principle have both server and client functions. When Exim
26587 is receiving SMTP mail, it is acting as a server; when it is sending out
26588 messages over SMTP, it is acting as a client. Authenticator configuration
26589 options are provided for use in both these circumstances.
26590
26591 To make it clear which options apply to which situation, the prefixes
26592 &%server_%& and &%client_%& are used on option names that are specific to
26593 either the server or the client function, respectively. Server and client
26594 functions are disabled if none of their options are set. If an authenticator is
26595 to be used for both server and client functions, a single definition, using
26596 both sets of options, is required. For example:
26597 .code
26598 cram:
26599   driver = cram_md5
26600   public_name = CRAM-MD5
26601   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26602   client_name = ph10
26603   client_secret = secret2
26604 .endd
26605 The &%server_%& option is used when Exim is acting as a server, and the
26606 &%client_%& options when it is acting as a client.
26607
26608 Descriptions of the individual authenticators are given in subsequent chapters.
26609 The remainder of this chapter covers the generic options for the
26610 authenticators, followed by general discussion of the way authentication works
26611 in Exim.
26612
26613 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26614 per-mechanism basis.  Please read carefully to determine which variables hold
26615 account labels such as usercodes and which hold passwords or other
26616 authenticating data.
26617
26618 Note that some mechanisms support two different identifiers for accounts: the
26619 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26620 and &'authz'& are commonly encountered.  The American spelling is standard here.
26621 Conceptually, authentication data such as passwords are tied to the identifier
26622 used to authenticate; servers may have rules to permit one user to act as a
26623 second user, so that after login the session is treated as though that second
26624 user had logged in.  That second user is the &'authorization id'&.  A robust
26625 configuration might confirm that the &'authz'& field is empty or matches the
26626 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26627 as verified data, the &'authz'& as an unverified request which the server might
26628 choose to honour.
26629
26630 A &'realm'& is a text string, typically a domain name, presented by a server
26631 to a client to help it select an account and credentials to use.  In some
26632 mechanisms, the client and server provably agree on the realm, but clients
26633 typically can not treat the realm as secure data to be blindly trusted.
26634
26635
26636
26637 .section "Generic options for authenticators" "SECID168"
26638 .cindex "authentication" "generic options"
26639 .cindex "options" "generic; for authenticators"
26640
26641 .option client_condition authenticators string&!! unset
26642 When Exim is authenticating as a client, it skips any authenticator whose
26643 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26644 used, for example, to skip plain text authenticators when the connection is not
26645 encrypted by a setting such as:
26646 .code
26647 client_condition = ${if !eq{$tls_out_cipher}{}}
26648 .endd
26649
26650
26651 .option client_set_id authenticators string&!! unset
26652 When client authentication succeeds, this condition is expanded; the
26653 result is used in the log lines for outbound messages.
26654 Typically it will be the user name used for authentication.
26655
26656
26657 .option driver authenticators string unset
26658 This option must always be set. It specifies which of the available
26659 authenticators is to be used.
26660
26661
26662 .option public_name authenticators string unset
26663 This option specifies the name of the authentication mechanism that the driver
26664 implements, and by which it is known to the outside world. These names should
26665 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26666 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26667 defaults to the driver's instance name.
26668
26669
26670 .option server_advertise_condition authenticators string&!! unset
26671 When a server is about to advertise an authentication mechanism, the condition
26672 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26673 mechanism is not advertised.
26674 If the expansion fails, the mechanism is not advertised. If the failure was not
26675 forced, and was not caused by a lookup defer, the incident is logged.
26676 See section &<<SECTauthexiser>>& below for further discussion.
26677
26678
26679 .option server_condition authenticators string&!! unset
26680 This option must be set for a &%plaintext%& server authenticator, where it
26681 is used directly to control authentication. See section &<<SECTplainserver>>&
26682 for details.
26683
26684 For the &(gsasl)& authenticator, this option is required for various
26685 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26686
26687 For the other authenticators, &%server_condition%& can be used as an additional
26688 authentication or authorization mechanism that is applied after the other
26689 authenticator conditions succeed. If it is set, it is expanded when the
26690 authenticator would otherwise return a success code. If the expansion is forced
26691 to fail, authentication fails. Any other expansion failure causes a temporary
26692 error code to be returned. If the result of a successful expansion is an empty
26693 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26694 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26695 other result, a temporary error code is returned, with the expanded string as
26696 the error text.
26697
26698
26699 .option server_debug_print authenticators string&!! unset
26700 If this option is set and authentication debugging is enabled (see the &%-d%&
26701 command line option), the string is expanded and included in the debugging
26702 output when the authenticator is run as a server. This can help with checking
26703 out the values of variables.
26704 If expansion of the string fails, the error message is written to the debugging
26705 output, and Exim carries on processing.
26706
26707
26708 .option server_set_id authenticators string&!! unset
26709 .vindex "&$authenticated_id$&"
26710 .vindex "&$authenticated_fail_id$&"
26711 When an Exim server successfully authenticates a client, this string is
26712 expanded using data from the authentication, and preserved for any incoming
26713 messages in the variable &$authenticated_id$&. It is also included in the log
26714 lines for incoming messages. For example, a user/password authenticator
26715 configuration might preserve the user name that was used to authenticate, and
26716 refer to it subsequently during delivery of the message.
26717 On a failing authentication the expansion result is instead saved in
26718 the &$authenticated_fail_id$& variable.
26719 If expansion fails, the option is ignored.
26720
26721
26722 .option server_mail_auth_condition authenticators string&!! unset
26723 This option allows a server to discard authenticated sender addresses supplied
26724 as part of MAIL commands in SMTP connections that are authenticated by the
26725 driver on which &%server_mail_auth_condition%& is set. The option is not used
26726 as part of the authentication process; instead its (unexpanded) value is
26727 remembered for later use.
26728 How it is used is described in the following section.
26729
26730
26731
26732
26733
26734 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26735 .cindex "authentication" "sender; authenticated"
26736 .cindex "AUTH" "on MAIL command"
26737 When a client supplied an AUTH= item on a MAIL command, Exim applies
26738 the following checks before accepting it as the authenticated sender of the
26739 message:
26740
26741 .ilist
26742 If the connection is not using extended SMTP (that is, HELO was used rather
26743 than EHLO), the use of AUTH= is a syntax error.
26744 .next
26745 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26746 .next
26747 .vindex "&$authenticated_sender$&"
26748 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26749 running, the value of &$authenticated_sender$& is set to the value obtained
26750 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26751 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26752 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26753 given for the MAIL command.
26754 .next
26755 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26756 is accepted and placed in &$authenticated_sender$& only if the client has
26757 authenticated.
26758 .next
26759 If the AUTH= value was accepted by either of the two previous rules, and
26760 the client has authenticated, and the authenticator has a setting for the
26761 &%server_mail_auth_condition%&, the condition is checked at this point. The
26762 valued that was saved from the authenticator is expanded. If the expansion
26763 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26764 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26765 the value of &$authenticated_sender$& is retained and passed on with the
26766 message.
26767 .endlist
26768
26769
26770 When &$authenticated_sender$& is set for a message, it is passed on to other
26771 hosts to which Exim authenticates as a client. Do not confuse this value with
26772 &$authenticated_id$&, which is a string obtained from the authentication
26773 process, and which is not usually a complete email address.
26774
26775 .vindex "&$sender_address$&"
26776 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26777 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26778 therefore make use of &$authenticated_sender$&. The converse is not true: the
26779 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26780 ACL is run.
26781
26782
26783
26784 .section "Authentication on an Exim server" "SECTauthexiser"
26785 .cindex "authentication" "on an Exim server"
26786 When Exim receives an EHLO command, it advertises the public names of those
26787 authenticators that are configured as servers, subject to the following
26788 conditions:
26789
26790 .ilist
26791 The client host must match &%auth_advertise_hosts%& (default *).
26792 .next
26793 It the &%server_advertise_condition%& option is set, its expansion must not
26794 yield the empty string, &"0"&, &"no"&, or &"false"&.
26795 .endlist
26796
26797 The order in which the authenticators are defined controls the order in which
26798 the mechanisms are advertised.
26799
26800 Some mail clients (for example, some versions of Netscape) require the user to
26801 provide a name and password for authentication whenever AUTH is advertised,
26802 even though authentication may not in fact be needed (for example, Exim may be
26803 set up to allow unconditional relaying from the client by an IP address check).
26804 You can make such clients more friendly by not advertising AUTH to them.
26805 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26806 that runs for RCPT) to relay without authentication, you should set
26807 .code
26808 auth_advertise_hosts = ! 10.9.8.0/24
26809 .endd
26810 so that no authentication mechanisms are advertised to them.
26811
26812 The &%server_advertise_condition%& controls the advertisement of individual
26813 authentication mechanisms. For example, it can be used to restrict the
26814 advertisement of a particular mechanism to encrypted connections, by a setting
26815 such as:
26816 .code
26817 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26818 .endd
26819 .vindex "&$tls_in_cipher$&"
26820 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26821 yields &"yes"&, which allows the advertisement to happen.
26822
26823 When an Exim server receives an AUTH command from a client, it rejects it
26824 immediately if AUTH was not advertised in response to an earlier EHLO
26825 command. This is the case if
26826
26827 .ilist
26828 The client host does not match &%auth_advertise_hosts%&; or
26829 .next
26830 No authenticators are configured with server options; or
26831 .next
26832 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26833 server authenticators.
26834 .endlist
26835
26836
26837 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26838 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26839 AUTH is accepted from any client host.
26840
26841 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26842 server authentication mechanism that was advertised in response to EHLO and
26843 that matches the one named in the AUTH command. If it finds one, it runs
26844 the appropriate authentication protocol, and authentication either succeeds or
26845 fails. If there is no matching advertised mechanism, the AUTH command is
26846 rejected with a 504 error.
26847
26848 .vindex "&$received_protocol$&"
26849 .vindex "&$sender_host_authenticated$&"
26850 When a message is received from an authenticated host, the value of
26851 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26852 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26853 public name) of the authenticator driver that successfully authenticated the
26854 client from which the message was received. This variable is empty if there was
26855 no successful authentication.
26856
26857 .cindex authentication "expansion item"
26858 Successful authentication sets up information used by the
26859 &%authresults%& expansion item.
26860
26861
26862
26863
26864 .section "Testing server authentication" "SECID169"
26865 .cindex "authentication" "testing a server"
26866 .cindex "AUTH" "testing a server"
26867 .cindex "base64 encoding" "creating authentication test data"
26868 Exim's &%-bh%& option can be useful for testing server authentication
26869 configurations. The data for the AUTH command has to be sent using base64
26870 encoding. A quick way to produce such data for testing is the following Perl
26871 script:
26872 .code
26873 use MIME::Base64;
26874 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26875 .endd
26876 .cindex "binary zero" "in authentication data"
26877 This interprets its argument as a Perl string, and then encodes it. The
26878 interpretation as a Perl string allows binary zeros, which are required for
26879 some kinds of authentication, to be included in the data. For example, a
26880 command line to run this script on such data might be
26881 .code
26882 encode '\0user\0password'
26883 .endd
26884 Note the use of single quotes to prevent the shell interpreting the
26885 backslashes, so that they can be interpreted by Perl to specify characters
26886 whose code value is zero.
26887
26888 &*Warning 1*&: If either of the user or password strings starts with an octal
26889 digit, you must use three zeros instead of one after the leading backslash. If
26890 you do not, the octal digit that starts your string will be incorrectly
26891 interpreted as part of the code for the first character.
26892
26893 &*Warning 2*&: If there are characters in the strings that Perl interprets
26894 specially, you must use a Perl escape to prevent them being misinterpreted. For
26895 example, a command such as
26896 .code
26897 encode '\0user@domain.com\0pas$$word'
26898 .endd
26899 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26900
26901 If you have the &%mimencode%& command installed, another way to do produce
26902 base64-encoded strings is to run the command
26903 .code
26904 echo -e -n `\0user\0password' | mimencode
26905 .endd
26906 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26907 in the argument, and the &%-n%& option specifies no newline at the end of its
26908 output. However, not all versions of &%echo%& recognize these options, so you
26909 should check your version before relying on this suggestion.
26910
26911
26912
26913 .section "Authentication by an Exim client" "SECID170"
26914 .cindex "authentication" "on an Exim client"
26915 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26916 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26917 announces support for authentication, and the host matches an entry in either
26918 of these options, Exim (as a client) tries to authenticate as follows:
26919
26920 .ilist
26921 For each authenticator that is configured as a client, in the order in which
26922 they are defined in the configuration, it searches the authentication
26923 mechanisms announced by the server for one whose name matches the public name
26924 of the authenticator.
26925 .next
26926 .vindex "&$host$&"
26927 .vindex "&$host_address$&"
26928 When it finds one that matches, it runs the authenticator's client code. The
26929 variables &$host$& and &$host_address$& are available for any string expansions
26930 that the client might do. They are set to the server's name and IP address. If
26931 any expansion is forced to fail, the authentication attempt is abandoned, and
26932 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26933 delivery to be deferred.
26934 .next
26935 If the result of the authentication attempt is a temporary error or a timeout,
26936 Exim abandons trying to send the message to the host for the moment. It will
26937 try again later. If there are any backup hosts available, they are tried in the
26938 usual way.
26939 .next
26940 If the response to authentication is a permanent error (5&'xx'& code), Exim
26941 carries on searching the list of authenticators and tries another one if
26942 possible. If all authentication attempts give permanent errors, or if there are
26943 no attempts because no mechanisms match (or option expansions force failure),
26944 what happens depends on whether the host matches &%hosts_require_auth%& or
26945 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26946 delivery is deferred. The error can be detected in the retry rules, and thereby
26947 turned into a permanent error if you wish. In the second case, Exim tries to
26948 deliver the message unauthenticated.
26949 .endlist
26950
26951 Note that the hostlist test for whether to do authentication can be
26952 confused if name-IP lookups change between the time the peer is decided
26953 upon and the time that the transport runs.  For example, with a manualroute
26954 router given a host name, and with DNS "round-robin" used by that name: if
26955 the local resolver cache times out between the router and the transport
26956 running, the transport may get an IP for the name for its authentication
26957 check which does not match the connection peer IP.
26958 No authentication will then be done, despite the names being identical.
26959
26960 For such cases use a separate transport which always authenticates.
26961
26962 .cindex "AUTH" "on MAIL command"
26963 When Exim has authenticated itself to a remote server, it adds the AUTH
26964 parameter to the MAIL commands it sends, if it has an authenticated sender for
26965 the message. If the message came from a remote host, the authenticated sender
26966 is the one that was receiving on an incoming MAIL command, provided that the
26967 incoming connection was authenticated and the &%server_mail_auth%& condition
26968 allowed the authenticated sender to be retained. If a local process calls Exim
26969 to send a message, the sender address that is built from the login name and
26970 &%qualify_domain%& is treated as authenticated. However, if the
26971 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26972 the authenticated sender that was received with the message.
26973 .ecindex IIDauthconf1
26974 .ecindex IIDauthconf2
26975
26976
26977
26978
26979
26980
26981 . ////////////////////////////////////////////////////////////////////////////
26982 . ////////////////////////////////////////////////////////////////////////////
26983
26984 .chapter "The plaintext authenticator" "CHAPplaintext"
26985 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26986 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26987 The &(plaintext)& authenticator can be configured to support the PLAIN and
26988 LOGIN authentication mechanisms, both of which transfer authentication data as
26989 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26990 security risk; you are strongly advised to insist on the use of SMTP encryption
26991 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26992 use unencrypted plain text, you should not use the same passwords for SMTP
26993 connections as you do for login accounts.
26994
26995 .section "Avoiding cleartext use" "SECTplain_TLS"
26996 The following generic option settings will disable &(plaintext)& authenticators when
26997 TLS is not being used:
26998 .code
26999   server_advertise_condition = ${if def:tls_in_cipher }
27000   client_condition =           ${if def:tls_out_cipher}
27001 .endd
27002
27003 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27004 but is still vulnerable to a Man In The Middle attack unless certificates
27005 (including their names) have been properly verified.
27006
27007 .section "Plaintext server options" "SECID171"
27008 .cindex "options" "&(plaintext)& authenticator (server)"
27009 When configured as a server, &(plaintext)& uses the following options:
27010
27011 .option server_condition authenticators string&!! unset
27012 This is actually a global authentication option, but it must be set in order to
27013 configure the &(plaintext)& driver as a server. Its use is described below.
27014
27015 .option server_prompts plaintext "string list&!!" unset
27016 The contents of this option, after expansion, must be a colon-separated list of
27017 prompt strings. If expansion fails, a temporary authentication rejection is
27018 given.
27019
27020 .section "Using plaintext in a server" "SECTplainserver"
27021 .cindex "AUTH" "in &(plaintext)& authenticator"
27022 .cindex "binary zero" "in &(plaintext)& authenticator"
27023 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27024         "in &(plaintext)& authenticator"
27025 .vindex "&$auth1$&, &$auth2$&, etc"
27026 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27027
27028 When running as a server, &(plaintext)& performs the authentication test by
27029 expanding a string. The data sent by the client with the AUTH command, or in
27030 response to subsequent prompts, is base64 encoded, and so may contain any byte
27031 values when decoded. If any data is supplied with the command, it is treated as
27032 a list of strings, separated by NULs (binary zeros), the first three of which
27033 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27034 (neither LOGIN nor PLAIN uses more than three strings).
27035
27036 For compatibility with previous releases of Exim, the values are also placed in
27037 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27038 variables for this purpose is now deprecated, as it can lead to confusion in
27039 string expansions that also use them for other things.
27040
27041 If there are more strings in &%server_prompts%& than the number of strings
27042 supplied with the AUTH command, the remaining prompts are used to obtain more
27043 data. Each response from the client may be a list of NUL-separated strings.
27044
27045 .vindex "&$authenticated_id$&"
27046 Once a sufficient number of data strings have been received,
27047 &%server_condition%& is expanded. If the expansion is forced to fail,
27048 authentication fails. Any other expansion failure causes a temporary error code
27049 to be returned. If the result of a successful expansion is an empty string,
27050 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27051 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27052 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27053 For any other result, a temporary error code is returned, with the expanded
27054 string as the error text.
27055
27056 &*Warning*&: If you use a lookup in the expansion to find the user's
27057 password, be sure to make the authentication fail if the user is unknown.
27058 There are good and bad examples at the end of the next section.
27059
27060
27061
27062 .section "The PLAIN authentication mechanism" "SECID172"
27063 .cindex "PLAIN authentication mechanism"
27064 .cindex authentication PLAIN
27065 .cindex "binary zero" "in &(plaintext)& authenticator"
27066 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27067 sent as one item of data (that is, one combined string containing two NUL
27068 separators). The data is sent either as part of the AUTH command, or
27069 subsequently in response to an empty prompt from the server.
27070
27071 The second and third strings are a user name and a corresponding password.
27072 Using a single fixed user name and password as an example, this could be
27073 configured as follows:
27074 .code
27075 fixed_plain:
27076   driver = plaintext
27077   public_name = PLAIN
27078   server_prompts = :
27079   server_condition = \
27080     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27081   server_set_id = $auth2
27082 .endd
27083 Note that the default result strings from &%if%& (&"true"& or an empty string)
27084 are exactly what we want here, so they need not be specified. Obviously, if the
27085 password contains expansion-significant characters such as dollar, backslash,
27086 or closing brace, they have to be escaped.
27087
27088 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27089 the end of a string list are ignored). If all the data comes as part of the
27090 AUTH command, as is commonly the case, the prompt is not used. This
27091 authenticator is advertised in the response to EHLO as
27092 .code
27093 250-AUTH PLAIN
27094 .endd
27095 and a client host can authenticate itself by sending the command
27096 .code
27097 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27098 .endd
27099 As this contains three strings (more than the number of prompts), no further
27100 data is required from the client. Alternatively, the client may just send
27101 .code
27102 AUTH PLAIN
27103 .endd
27104 to initiate authentication, in which case the server replies with an empty
27105 prompt. The client must respond with the combined data string.
27106
27107 The data string is base64 encoded, as required by the RFC. This example,
27108 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27109 represents a zero byte. This is split up into three strings, the first of which
27110 is empty. The &%server_condition%& option in the authenticator checks that the
27111 second two are &`username`& and &`mysecret`& respectively.
27112
27113 Having just one fixed user name and password, as in this example, is not very
27114 realistic, though for a small organization with only a handful of
27115 authenticating clients it could make sense.
27116
27117 A more sophisticated instance of this authenticator could use the user name in
27118 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27119 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27120 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27121 This is an incorrect example:
27122 .code
27123 server_condition = \
27124   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27125 .endd
27126 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27127 which it then compares to the supplied password (&$auth3$&). Why is this example
27128 incorrect? It works fine for existing users, but consider what happens if a
27129 non-existent user name is given. The lookup fails, but as no success/failure
27130 strings are given for the lookup, it yields an empty string. Thus, to defeat
27131 the authentication, all a client has to do is to supply a non-existent user
27132 name and an empty password. The correct way of writing this test is:
27133 .code
27134 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27135   {${if eq{$value}{$auth3}}} {false}}
27136 .endd
27137 In this case, if the lookup succeeds, the result is checked; if the lookup
27138 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27139 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27140 always fails if its second argument is empty. However, the second way of
27141 writing the test makes the logic clearer.
27142
27143
27144 .section "The LOGIN authentication mechanism" "SECID173"
27145 .cindex "LOGIN authentication mechanism"
27146 .cindex authentication LOGIN
27147 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27148 in a number of programs. No data is sent with the AUTH command. Instead, a
27149 user name and password are supplied separately, in response to prompts. The
27150 plaintext authenticator can be configured to support this as in this example:
27151 .code
27152 fixed_login:
27153   driver = plaintext
27154   public_name = LOGIN
27155   server_prompts = User Name : Password
27156   server_condition = \
27157     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27158   server_set_id = $auth1
27159 .endd
27160 Because of the way plaintext operates, this authenticator accepts data supplied
27161 with the AUTH command (in contravention of the specification of LOGIN), but
27162 if the client does not supply it (as is the case for LOGIN clients), the prompt
27163 strings are used to obtain two data items.
27164
27165 Some clients are very particular about the precise text of the prompts. For
27166 example, Outlook Express is reported to recognize only &"Username:"& and
27167 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27168 strings. It uses the &%ldapauth%& expansion condition to check the user
27169 name and password by binding to an LDAP server:
27170 .code
27171 login:
27172   driver = plaintext
27173   public_name = LOGIN
27174   server_prompts = Username:: : Password::
27175   server_condition = ${if and{{ \
27176     !eq{}{$auth1} }{ \
27177     ldapauth{\
27178       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27179       pass=${quote:$auth2} \
27180       ldap://ldap.example.org/} }} }
27181   server_set_id = uid=$auth1,ou=people,o=example.org
27182 .endd
27183 We have to check that the username is not empty before using it, because LDAP
27184 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27185 operator to correctly quote the DN for authentication. However, the basic
27186 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27187 correct one to use for the password, because quoting is needed only to make
27188 the password conform to the Exim syntax. At the LDAP level, the password is an
27189 uninterpreted string.
27190
27191
27192 .section "Support for different kinds of authentication" "SECID174"
27193 A number of string expansion features are provided for the purpose of
27194 interfacing to different ways of user authentication. These include checking
27195 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27196 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27197 &<<SECTexpcond>>&.
27198
27199
27200
27201
27202 .section "Using plaintext in a client" "SECID175"
27203 .cindex "options" "&(plaintext)& authenticator (client)"
27204 The &(plaintext)& authenticator has two client options:
27205
27206 .option client_ignore_invalid_base64 plaintext boolean false
27207 If the client receives a server prompt that is not a valid base64 string,
27208 authentication is abandoned by default. However, if this option is set true,
27209 the error in the challenge is ignored and the client sends the response as
27210 usual.
27211
27212 .option client_send plaintext string&!! unset
27213 The string is a colon-separated list of authentication data strings. Each
27214 string is independently expanded before being sent to the server. The first
27215 string is sent with the AUTH command; any more strings are sent in response
27216 to prompts from the server. Before each string is expanded, the value of the
27217 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27218 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27219 way. Thus, the prompt that is received in response to sending the first string
27220 (with the AUTH command) can be used in the expansion of the second string, and
27221 so on. If an invalid base64 string is received when
27222 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27223 &$auth$&<&'n'&> variable.
27224
27225 &*Note*&: You cannot use expansion to create multiple strings, because
27226 splitting takes priority and happens first.
27227
27228 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27229 the data, further processing is applied to each string before it is sent. If
27230 there are any single circumflex characters in the string, they are converted to
27231 NULs. Should an actual circumflex be required as data, it must be doubled in
27232 the string.
27233
27234 This is an example of a client configuration that implements the PLAIN
27235 authentication mechanism with a fixed user name and password:
27236 .code
27237 fixed_plain:
27238   driver = plaintext
27239   public_name = PLAIN
27240   client_send = ^username^mysecret
27241 .endd
27242 The lack of colons means that the entire text is sent with the AUTH
27243 command, with the circumflex characters converted to NULs. A similar example
27244 that uses the LOGIN mechanism is:
27245 .code
27246 fixed_login:
27247   driver = plaintext
27248   public_name = LOGIN
27249   client_send = : username : mysecret
27250 .endd
27251 The initial colon means that the first string is empty, so no data is sent with
27252 the AUTH command itself. The remaining strings are sent in response to
27253 prompts.
27254 .ecindex IIDplaiauth1
27255 .ecindex IIDplaiauth2
27256
27257
27258
27259
27260 . ////////////////////////////////////////////////////////////////////////////
27261 . ////////////////////////////////////////////////////////////////////////////
27262
27263 .chapter "The cram_md5 authenticator" "CHID9"
27264 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27265 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27266 .cindex "CRAM-MD5 authentication mechanism"
27267 .cindex authentication CRAM-MD5
27268 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27269 sends a challenge string to the client, and the response consists of a user
27270 name and the CRAM-MD5 digest of the challenge string combined with a secret
27271 string (password) which is known to both server and client. Thus, the secret
27272 is not sent over the network as plain text, which makes this authenticator more
27273 secure than &(plaintext)&. However, the downside is that the secret has to be
27274 available in plain text at either end.
27275
27276
27277 .section "Using cram_md5 as a server" "SECID176"
27278 .cindex "options" "&(cram_md5)& authenticator (server)"
27279 This authenticator has one server option, which must be set to configure the
27280 authenticator as a server:
27281
27282 .option server_secret cram_md5 string&!! unset
27283 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27284 When the server receives the client's response, the user name is placed in
27285 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27286 obtain the password for that user. The server then computes the CRAM-MD5 digest
27287 that the client should have sent, and checks that it received the correct
27288 string. If the expansion of &%server_secret%& is forced to fail, authentication
27289 fails. If the expansion fails for some other reason, a temporary error code is
27290 returned to the client.
27291
27292 For compatibility with previous releases of Exim, the user name is also placed
27293 in &$1$&. However, the use of this variables for this purpose is now
27294 deprecated, as it can lead to confusion in string expansions that also use
27295 numeric variables for other things.
27296
27297 For example, the following authenticator checks that the user name given by the
27298 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27299 user name, authentication fails.
27300 .code
27301 fixed_cram:
27302   driver = cram_md5
27303   public_name = CRAM-MD5
27304   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27305   server_set_id = $auth1
27306 .endd
27307 .vindex "&$authenticated_id$&"
27308 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27309 name in &$authenticated_id$&. A more typical configuration might look up the
27310 secret string in a file, using the user name as the key. For example:
27311 .code
27312 lookup_cram:
27313   driver = cram_md5
27314   public_name = CRAM-MD5
27315   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27316                   {$value}fail}
27317   server_set_id = $auth1
27318 .endd
27319 Note that this expansion explicitly forces failure if the lookup fails
27320 because &$auth1$& contains an unknown user name.
27321
27322 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27323 using the relevant libraries, you need to know the realm to specify in the
27324 lookup and then ask for the &"userPassword"& attribute for that user in that
27325 realm, with:
27326 .code
27327 cyrusless_crammd5:
27328   driver = cram_md5
27329   public_name = CRAM-MD5
27330   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27331                   dbmjz{/etc/sasldb2}{$value}fail}
27332   server_set_id = $auth1
27333 .endd
27334
27335 .section "Using cram_md5 as a client" "SECID177"
27336 .cindex "options" "&(cram_md5)& authenticator (client)"
27337 When used as a client, the &(cram_md5)& authenticator has two options:
27338
27339
27340
27341 .option client_name cram_md5 string&!! "the primary host name"
27342 This string is expanded, and the result used as the user name data when
27343 computing the response to the server's challenge.
27344
27345
27346 .option client_secret cram_md5 string&!! unset
27347 This option must be set for the authenticator to work as a client. Its value is
27348 expanded and the result used as the secret string when computing the response.
27349
27350
27351 .vindex "&$host$&"
27352 .vindex "&$host_address$&"
27353 Different user names and secrets can be used for different servers by referring
27354 to &$host$& or &$host_address$& in the options. Forced failure of either
27355 expansion string is treated as an indication that this authenticator is not
27356 prepared to handle this case. Exim moves on to the next configured client
27357 authenticator. Any other expansion failure causes Exim to give up trying to
27358 send the message to the current server.
27359
27360 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27361 strings, is:
27362 .code
27363 fixed_cram:
27364   driver = cram_md5
27365   public_name = CRAM-MD5
27366   client_name = ph10
27367   client_secret = secret
27368 .endd
27369 .ecindex IIDcramauth1
27370 .ecindex IIDcramauth2
27371
27372
27373
27374 . ////////////////////////////////////////////////////////////////////////////
27375 . ////////////////////////////////////////////////////////////////////////////
27376
27377 .chapter "The cyrus_sasl authenticator" "CHID10"
27378 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27379 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27380 .cindex "Cyrus" "SASL library"
27381 .cindex "Kerberos"
27382 The code for this authenticator was provided by Matthew Byng-Maddick while
27383 at A L Digital Ltd.
27384
27385 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27386 library implementation of the RFC 2222 (&"Simple Authentication and Security
27387 Layer"&). This library supports a number of authentication mechanisms,
27388 including PLAIN and LOGIN, but also several others that Exim does not support
27389 directly. In particular, there is support for Kerberos authentication.
27390
27391 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27392 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27393 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27394 name of the driver to determine which mechanism to support.
27395
27396 Where access to some kind of secret file is required, for example, in GSSAPI
27397 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27398 user, and that the Cyrus SASL library has no way of escalating privileges
27399 by default. You may also find you need to set environment variables,
27400 depending on the driver you are using.
27401
27402 The application name provided by Exim is &"exim"&, so various SASL options may
27403 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27404 Kerberos, note that because of limitations in the GSSAPI interface,
27405 changing the server keytab might need to be communicated down to the Kerberos
27406 layer independently. The mechanism for doing so is dependent upon the Kerberos
27407 implementation.
27408
27409 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27410 may be set to point to an alternative keytab file. Exim will pass this
27411 variable through from its own inherited environment when started as root or the
27412 Exim user. The keytab file needs to be readable by the Exim user.
27413 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27414 environment variable.  In practice, for those releases, the Cyrus authenticator
27415 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27416 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27417
27418
27419 .section "Using cyrus_sasl as a server" "SECID178"
27420 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27421 (on a successful authentication) into &$auth1$&. For compatibility with
27422 previous releases of Exim, the username is also placed in &$1$&. However, the
27423 use of this variable for this purpose is now deprecated, as it can lead to
27424 confusion in string expansions that also use numeric variables for other
27425 things.
27426
27427
27428 .option server_hostname cyrus_sasl string&!! "see below"
27429 This option selects the hostname that is used when communicating with the
27430 library. The default value is &`$primary_hostname`&. It is up to the underlying
27431 SASL plug-in what it does with this data.
27432
27433
27434 .option server_mech cyrus_sasl string "see below"
27435 This option selects the authentication mechanism this driver should use. The
27436 default is the value of the generic &%public_name%& option. This option allows
27437 you to use a different underlying mechanism from the advertised name. For
27438 example:
27439 .code
27440 sasl:
27441   driver = cyrus_sasl
27442   public_name = X-ANYTHING
27443   server_mech = CRAM-MD5
27444   server_set_id = $auth1
27445 .endd
27446
27447 .option server_realm cyrus_sasl string&!! unset
27448 This specifies the SASL realm that the server claims to be in.
27449
27450
27451 .option server_service cyrus_sasl string &`smtp`&
27452 This is the SASL service that the server claims to implement.
27453
27454
27455 For straightforward cases, you do not need to set any of the authenticator's
27456 private options. All you need to do is to specify an appropriate mechanism as
27457 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27458 PLAIN, you could have two authenticators as follows:
27459 .code
27460 sasl_cram_md5:
27461   driver = cyrus_sasl
27462   public_name = CRAM-MD5
27463   server_set_id = $auth1
27464
27465 sasl_plain:
27466   driver = cyrus_sasl
27467   public_name = PLAIN
27468   server_set_id = $auth2
27469 .endd
27470 Cyrus SASL does implement the LOGIN authentication method, even though it is
27471 not a standard method. It is disabled by default in the source distribution,
27472 but it is present in many binary distributions.
27473 .ecindex IIDcyrauth1
27474 .ecindex IIDcyrauth2
27475
27476
27477
27478
27479 . ////////////////////////////////////////////////////////////////////////////
27480 . ////////////////////////////////////////////////////////////////////////////
27481 .chapter "The dovecot authenticator" "CHAPdovecot"
27482 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27483 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27484 This authenticator is an interface to the authentication facility of the
27485 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27486 Note that Dovecot must be configured to use auth-client not auth-userdb.
27487 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27488 to use the same mechanisms for SMTP authentication. This is a server
27489 authenticator only. There is only one option:
27490
27491 .option server_socket dovecot string unset
27492
27493 This option must specify the UNIX socket that is the interface to Dovecot
27494 authentication. The &%public_name%& option must specify an authentication
27495 mechanism that Dovecot is configured to support. You can have several
27496 authenticators for different mechanisms. For example:
27497 .code
27498 dovecot_plain:
27499   driver = dovecot
27500   public_name = PLAIN
27501   server_socket = /var/run/dovecot/auth-client
27502   server_set_id = $auth1
27503
27504 dovecot_ntlm:
27505   driver = dovecot
27506   public_name = NTLM
27507   server_socket = /var/run/dovecot/auth-client
27508   server_set_id = $auth1
27509 .endd
27510 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27511 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27512 option is passed in the Dovecot authentication command. If, for a TLS
27513 connection, a client certificate has been verified, the &"valid-client-cert"&
27514 option is passed. When authentication succeeds, the identity of the user
27515 who authenticated is placed in &$auth1$&.
27516
27517 .new
27518 The Dovecot configuration to match the above wil look
27519 something like:
27520 .code
27521 conf.d/10-master.conf :-
27522
27523 service auth {
27524 ...
27525 #SASL
27526   unix_listener auth-client {
27527     mode = 0660
27528     user = mail
27529   }
27530 ...
27531 }
27532
27533 conf.d/10-auth.conf :-
27534
27535 auth_mechanisms = plain login ntlm
27536 .endd
27537 .wen
27538
27539 .ecindex IIDdcotauth1
27540 .ecindex IIDdcotauth2
27541
27542
27543 . ////////////////////////////////////////////////////////////////////////////
27544 . ////////////////////////////////////////////////////////////////////////////
27545 .chapter "The gsasl authenticator" "CHAPgsasl"
27546 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27547 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27548 .cindex "authentication" "GNU SASL"
27549 .cindex "authentication" "SASL"
27550 .cindex "authentication" "EXTERNAL"
27551 .cindex "authentication" "ANONYMOUS"
27552 .cindex "authentication" "PLAIN"
27553 .cindex "authentication" "LOGIN"
27554 .cindex "authentication" "DIGEST-MD5"
27555 .cindex "authentication" "CRAM-MD5"
27556 .cindex "authentication" "SCRAM family"
27557 The &(gsasl)& authenticator provides integration for the GNU SASL
27558 library and the mechanisms it provides.  This is new as of the 4.80 release
27559 and there are a few areas where the library does not let Exim smoothly
27560 scale to handle future authentication mechanisms, so no guarantee can be
27561 made that any particular new authentication mechanism will be supported
27562 without code changes in Exim.
27563
27564 .new
27565 The library is expected to add support in an upcoming
27566 realease for the SCRAM-SHA-256 method.
27567 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27568 when this happens.
27569
27570
27571 .option client_authz gsasl string&!! unset
27572 This option can be used to supply an &'authorization id'&
27573 which is different to the &'authentication_id'& provided
27574 by &%client_username%& option.
27575 If unset or (after expansion) empty it is not used,
27576 which is the common case.
27577
27578 .option client_channelbinding gsasl boolean false
27579 See &%server_channelbinding%& below.
27580
27581 .option client_password gsasl string&!! unset
27582 This option is exapanded before use, and should result in
27583 the password to be used, in clear.
27584
27585 .option client_username gsasl string&!! unset
27586 This option is exapanded before use, and should result in
27587 the account name to be used.
27588 .wen
27589
27590 .new
27591 .option client_spassword gsasl string&!! unset
27592 If a SCRAM mechanism is being used and this option is set
27593 it is used in preference to &%client_password%&.
27594 The value after expansion should be
27595 a 40 (for SHA-1) or 64 (for SHA-256) character string
27596 with the PBKDF2-prepared password, hex-encoded.
27597 Note that this value will depend on the salt and iteration-count
27598 supplied by the server.
27599 .wen
27600
27601
27602
27603 .option server_channelbinding gsasl boolean false
27604 Do not set this true and rely on the properties
27605 without consulting a cryptographic engineer.
27606
27607 Some authentication mechanisms are able to use external context at both ends
27608 of the session to bind the authentication to that context, and fail the
27609 authentication process if that context differs.  Specifically, some TLS
27610 ciphersuites can provide identifying information about the cryptographic
27611 context.
27612
27613 This should have meant that certificate identity and verification becomes a
27614 non-issue, as a man-in-the-middle attack will cause the correct client and
27615 server to see different identifiers and authentication will fail.
27616
27617 .new
27618 This is
27619 only usable by mechanisms which support "channel binding"; at time of
27620 writing, that's the SCRAM family.
27621 When using this feature the "-PLUS" variants of the method names need to be used.
27622 .wen
27623
27624 This defaults off to ensure smooth upgrade across Exim releases, in case
27625 this option causes some clients to start failing.  Some future release
27626 of Exim might have switched the default to be true.
27627
27628 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27629 Do not plan to rely upon this feature for security, ever, without consulting
27630 with a subject matter expert (a cryptographic engineer).
27631
27632
27633 .option server_hostname gsasl string&!! "see below"
27634 This option selects the hostname that is used when communicating with the
27635 library. The default value is &`$primary_hostname`&.
27636 Some mechanisms will use this data.
27637
27638
27639 .option server_mech gsasl string "see below"
27640 This option selects the authentication mechanism this driver should use. The
27641 default is the value of the generic &%public_name%& option. This option allows
27642 you to use a different underlying mechanism from the advertised name. For
27643 example:
27644 .code
27645 sasl:
27646   driver = gsasl
27647   public_name = X-ANYTHING
27648   server_mech = CRAM-MD5
27649   server_set_id = $auth1
27650 .endd
27651
27652
27653 .option server_password gsasl string&!! unset
27654 Various mechanisms need access to the cleartext password on the server, so
27655 that proof-of-possession can be demonstrated on the wire, without sending
27656 the password itself.
27657
27658 The data available for lookup varies per mechanism.
27659 In all cases, &$auth1$& is set to the &'authentication id'&.
27660 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27661 if available, else the empty string.
27662 The &$auth3$& variable will always be the &'realm'& if available,
27663 else the empty string.
27664
27665 A forced failure will cause authentication to defer.
27666
27667 If using this option, it may make sense to set the &%server_condition%&
27668 option to be simply "true".
27669
27670
27671 .option server_realm gsasl string&!! unset
27672 This specifies the SASL realm that the server claims to be in.
27673 Some mechanisms will use this data.
27674
27675
27676 .option server_scram_iter gsasl string&!! 4096
27677 This option provides data for the SCRAM family of mechanisms.
27678 .new
27679 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27680 when this option is expanded.
27681
27682 The result of expansion should be a decimal number,
27683 and represents both a lower-bound on the security, and
27684 a compute cost factor imposed on the client
27685 (if it does not cache results, or the server changes
27686 either the iteration count or the salt).
27687 A minimum value of 4096 is required by the standards
27688 for all current SCRAM mechanism variants.
27689 .wen
27690
27691 .option server_scram_salt gsasl string&!! unset
27692 This option provides data for the SCRAM family of mechanisms.
27693 .new
27694 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27695 when this option is expanded.
27696 The value should be a base64-encoded string,
27697 of random data typically 4-to-16 bytes long.
27698 If unset or empty after expansion the library will provides a value for the
27699 protocol conversation.
27700 .wen
27701
27702
27703 .new
27704 .option server_key gsasl string&!! unset
27705 .option server_skey gsasl string&!! unset
27706 These options can be used for the SCRAM family of mechanisms
27707 to provide stored information related to a password,
27708 the storage of which is preferable to plaintext.
27709
27710 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
27711 &%server_skey%& is StoredKey.
27712
27713 They are only available for version 1.9.0 (or later) of the gsasl library.
27714 When this is so, the macros
27715 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
27716 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
27717 will be defined.
27718
27719 The &$authN$& variables are available when these options are expanded.
27720
27721 If set, the results of expansion should for each
27722 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
27723 of base64-coded data, and will be used in preference to the
27724 &%server_password%& option.
27725 If unset or not of the right length, &%server_password%& will be used.
27726
27727 The libgsasl library release includes a utility &'gsasl'& which can be used
27728 to generate these values.
27729 .wen
27730
27731
27732 .option server_service gsasl string &`smtp`&
27733 This is the SASL service that the server claims to implement.
27734 Some mechanisms will use this data.
27735
27736
27737 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27738 .vindex "&$auth1$&, &$auth2$&, etc"
27739 These may be set when evaluating specific options, as detailed above.
27740 They will also be set when evaluating &%server_condition%&.
27741
27742 Unless otherwise stated below, the &(gsasl)& integration will use the following
27743 meanings for these variables:
27744
27745 .ilist
27746 .vindex "&$auth1$&"
27747 &$auth1$&: the &'authentication id'&
27748 .next
27749 .vindex "&$auth2$&"
27750 &$auth2$&: the &'authorization id'&
27751 .next
27752 .vindex "&$auth3$&"
27753 &$auth3$&: the &'realm'&
27754 .endlist
27755
27756 On a per-mechanism basis:
27757
27758 .ilist
27759 .cindex "authentication" "EXTERNAL"
27760 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27761 the &%server_condition%& option must be present.
27762 .next
27763 .cindex "authentication" "ANONYMOUS"
27764 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27765 the &%server_condition%& option must be present.
27766 .next
27767 .cindex "authentication" "GSSAPI"
27768 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27769 &$auth2$& will be set to the &'authorization id'&,
27770 the &%server_condition%& option must be present.
27771 .endlist
27772
27773 An &'anonymous token'& is something passed along as an unauthenticated
27774 identifier; this is analogous to FTP anonymous authentication passing an
27775 email address, or software-identifier@, as the "password".
27776
27777
27778 An example showing the password having the realm specified in the callback
27779 and demonstrating a Cyrus SASL to GSASL migration approach is:
27780 .code
27781 gsasl_cyrusless_crammd5:
27782   driver = gsasl
27783   public_name = CRAM-MD5
27784   server_realm = imap.example.org
27785   server_password = ${lookup{$auth1:$auth3:userPassword}\
27786                     dbmjz{/etc/sasldb2}{$value}fail}
27787   server_set_id = ${quote:$auth1}
27788   server_condition = yes
27789 .endd
27790
27791
27792 . ////////////////////////////////////////////////////////////////////////////
27793 . ////////////////////////////////////////////////////////////////////////////
27794
27795 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27796 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27797 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27798 .cindex "authentication" "GSSAPI"
27799 .cindex "authentication" "Kerberos"
27800 The &(heimdal_gssapi)& authenticator provides server integration for the
27801 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27802 reliably.
27803
27804 .option server_hostname heimdal_gssapi string&!! "see below"
27805 This option selects the hostname that is used, with &%server_service%&,
27806 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27807 identifier.  The default value is &`$primary_hostname`&.
27808
27809 .option server_keytab heimdal_gssapi string&!! unset
27810 If set, then Heimdal will not use the system default keytab (typically
27811 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27812 The value should be a pathname, with no &"file:"& prefix.
27813
27814 .option server_service heimdal_gssapi string&!! "smtp"
27815 This option specifies the service identifier used, in conjunction with
27816 &%server_hostname%&, for building the identifier for finding credentials
27817 from the keytab.
27818
27819
27820 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27821 Beware that these variables will typically include a realm, thus will appear
27822 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27823 not verified, so a malicious client can set it to anything.
27824
27825 The &$auth1$& field should be safely trustable as a value from the Key
27826 Distribution Center.  Note that these are not quite email addresses.
27827 Each identifier is for a role, and so the left-hand-side may include a
27828 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27829
27830 .vindex "&$auth1$&, &$auth2$&, etc"
27831 .ilist
27832 .vindex "&$auth1$&"
27833 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27834 .next
27835 .vindex "&$auth2$&"
27836 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27837 authentication.  If that was empty, this will also be set to the
27838 GSS Display Name.
27839 .endlist
27840
27841
27842 . ////////////////////////////////////////////////////////////////////////////
27843 . ////////////////////////////////////////////////////////////////////////////
27844
27845 .chapter "The spa authenticator" "CHAPspa"
27846 .scindex IIDspaauth1 "&(spa)& authenticator"
27847 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27848 .cindex "authentication" "Microsoft Secure Password"
27849 .cindex "authentication" "NTLM"
27850 .cindex "Microsoft Secure Password Authentication"
27851 .cindex "NTLM authentication"
27852 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27853 Password Authentication'& mechanism,
27854 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27855 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27856 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27857 server side was subsequently contributed by Tom Kistner. The mechanism works as
27858 follows:
27859
27860 .ilist
27861 After the AUTH command has been accepted, the client sends an SPA
27862 authentication request based on the user name and optional domain.
27863 .next
27864 The server sends back a challenge.
27865 .next
27866 The client builds a challenge response which makes use of the user's password
27867 and sends it to the server, which then accepts or rejects it.
27868 .endlist
27869
27870 Encryption is used to protect the password in transit.
27871
27872
27873
27874 .section "Using spa as a server" "SECID179"
27875 .cindex "options" "&(spa)& authenticator (server)"
27876 The &(spa)& authenticator has just one server option:
27877
27878 .option server_password spa string&!! unset
27879 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27880 This option is expanded, and the result must be the cleartext password for the
27881 authenticating user, whose name is at this point in &$auth1$&. For
27882 compatibility with previous releases of Exim, the user name is also placed in
27883 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27884 it can lead to confusion in string expansions that also use numeric variables
27885 for other things. For example:
27886 .code
27887 spa:
27888   driver = spa
27889   public_name = NTLM
27890   server_password = \
27891     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27892 .endd
27893 If the expansion is forced to fail, authentication fails. Any other expansion
27894 failure causes a temporary error code to be returned.
27895
27896
27897
27898
27899
27900 .section "Using spa as a client" "SECID180"
27901 .cindex "options" "&(spa)& authenticator (client)"
27902 The &(spa)& authenticator has the following client options:
27903
27904
27905
27906 .option client_domain spa string&!! unset
27907 This option specifies an optional domain for the authentication.
27908
27909
27910 .option client_password spa string&!! unset
27911 This option specifies the user's password, and must be set.
27912
27913
27914 .option client_username spa string&!! unset
27915 This option specifies the user name, and must be set. Here is an example of a
27916 configuration of this authenticator for use with the mail servers at
27917 &'msn.com'&:
27918 .code
27919 msn:
27920   driver = spa
27921   public_name = MSN
27922   client_username = msn/msn_username
27923   client_password = msn_plaintext_password
27924   client_domain = DOMAIN_OR_UNSET
27925 .endd
27926 .ecindex IIDspaauth1
27927 .ecindex IIDspaauth2
27928
27929
27930
27931
27932
27933 . ////////////////////////////////////////////////////////////////////////////
27934 . ////////////////////////////////////////////////////////////////////////////
27935
27936 .chapter "The external authenticator" "CHAPexternauth"
27937 .scindex IIDexternauth1 "&(external)& authenticator"
27938 .scindex IIDexternauth2 "authenticators" "&(external)&"
27939 .cindex "authentication" "Client Certificate"
27940 .cindex "authentication" "X509"
27941 .cindex "Certificate-based authentication"
27942 The &(external)& authenticator provides support for
27943 authentication based on non-SMTP information.
27944 The specification is in RFC 4422 Appendix A
27945 (&url(https://tools.ietf.org/html/rfc4422)).
27946 It is only a transport and negotiation mechanism;
27947 the process of authentication is entirely controlled
27948 by the server configuration.
27949
27950 The client presents an identity in-clear.
27951 It is probably wise for a server to only advertise,
27952 and for clients to only attempt,
27953 this authentication method on a secure (eg. under TLS) connection.
27954
27955 One possible use, compatible with the
27956 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27957 is for using X509 client certificates.
27958
27959 It thus overlaps in function with the TLS authenticator
27960 (see &<<CHAPtlsauth>>&)
27961 but is a full SMTP SASL authenticator
27962 rather than being implicit for TLS-connection carried
27963 client certificates only.
27964
27965 The examples and discussion in this chapter assume that
27966 client-certificate authentication is being done.
27967
27968 The client must present a certificate,
27969 for which it must have been requested via the
27970 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27971 (see &<<CHAPTLS>>&).
27972 For authentication to be effective the certificate should be
27973 verifiable against a trust-anchor certificate known to the server.
27974
27975 .section "External options" "SECTexternsoptions"
27976 .cindex "options" "&(external)& authenticator (server)"
27977 The &(external)& authenticator has two server options:
27978
27979 .option server_param2 external string&!! unset
27980 .option server_param3 external string&!! unset
27981 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27982 These options are expanded before the &%server_condition%& option
27983 and the result are placed in &$auth2$& and &$auth3$& resectively.
27984 If the expansion is forced to fail, authentication fails. Any other expansion
27985 failure causes a temporary error code to be returned.
27986
27987 They can be used to clarify the coding of a complex &%server_condition%&.
27988
27989 .section "Using external in a server" "SECTexternserver"
27990 .cindex "AUTH" "in &(external)& authenticator"
27991 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27992         "in &(external)& authenticator"
27993 .vindex "&$auth1$&, &$auth2$&, etc"
27994 .cindex "base64 encoding" "in &(external)& authenticator"
27995
27996 When running as a server, &(external)& performs the authentication test by
27997 expanding a string. The data sent by the client with the AUTH command, or in
27998 response to subsequent prompts, is base64 encoded, and so may contain any byte
27999 values when decoded. The decoded value is treated as
28000 an identity for authentication and
28001 placed in the expansion variable &$auth1$&.
28002
28003 For compatibility with previous releases of Exim, the value is also placed in
28004 the expansion variable &$1$&. However, the use of this
28005 variable for this purpose is now deprecated, as it can lead to confusion in
28006 string expansions that also use them for other things.
28007
28008 .vindex "&$authenticated_id$&"
28009 Once an identity has been received,
28010 &%server_condition%& is expanded. If the expansion is forced to fail,
28011 authentication fails. Any other expansion failure causes a temporary error code
28012 to be returned. If the result of a successful expansion is an empty string,
28013 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28014 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28015 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28016 For any other result, a temporary error code is returned, with the expanded
28017 string as the error text.
28018
28019 Example:
28020 .code
28021 ext_ccert_san_mail:
28022   driver =            external
28023   public_name =       EXTERNAL
28024
28025   server_advertise_condition = $tls_in_certificate_verified
28026   server_param2 =     ${certextract {subj_altname,mail,>:} \
28027                                     {$tls_in_peercert}}
28028   server_condition =  ${if forany {$auth2} \
28029                             {eq {$item}{$auth1}}}
28030   server_set_id =     $auth1
28031 .endd
28032 This accepts a client certificate that is verifiable against any
28033 of your configured trust-anchors
28034 (which usually means the full set of public CAs)
28035 and which has a mail-SAN matching the claimed identity sent by the client.
28036
28037 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28038 The account name is therefore guessable by an opponent.
28039 TLS 1.3 protects both server and client certificates, and is not vulnerable
28040 in this way.
28041
28042
28043 .section "Using external in a client" "SECTexternclient"
28044 .cindex "options" "&(external)& authenticator (client)"
28045 The &(external)& authenticator has one client option:
28046
28047 .option client_send external string&!! unset
28048 This option is expanded and sent with the AUTH command as the
28049 identity being asserted.
28050
28051 Example:
28052 .code
28053 ext_ccert:
28054   driver =      external
28055   public_name = EXTERNAL
28056
28057   client_condition = ${if !eq{$tls_out_cipher}{}}
28058   client_send = myaccount@smarthost.example.net
28059 .endd
28060
28061
28062 .ecindex IIDexternauth1
28063 .ecindex IIDexternauth2
28064
28065
28066
28067
28068
28069 . ////////////////////////////////////////////////////////////////////////////
28070 . ////////////////////////////////////////////////////////////////////////////
28071
28072 .chapter "The tls authenticator" "CHAPtlsauth"
28073 .scindex IIDtlsauth1 "&(tls)& authenticator"
28074 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28075 .cindex "authentication" "Client Certificate"
28076 .cindex "authentication" "X509"
28077 .cindex "Certificate-based authentication"
28078 The &(tls)& authenticator provides server support for
28079 authentication based on client certificates.
28080
28081 It is not an SMTP authentication mechanism and is not
28082 advertised by the server as part of the SMTP EHLO response.
28083 It is an Exim authenticator in the sense that it affects
28084 the protocol element of the log line, can be tested for
28085 by the &%authenticated%& ACL condition, and can set
28086 the &$authenticated_id$& variable.
28087
28088 The client must present a verifiable certificate,
28089 for which it must have been requested via the
28090 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28091 (see &<<CHAPTLS>>&).
28092
28093 If an authenticator of this type is configured it is
28094 run before any SMTP-level communication is done,
28095 and can authenticate the connection.
28096 If it does, SMTP authentication is not offered.
28097
28098 A maximum of one authenticator of this type may be present.
28099
28100
28101 .cindex "options" "&(tls)& authenticator (server)"
28102 The &(tls)& authenticator has three server options:
28103
28104 .option server_param1 tls string&!! unset
28105 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28106 This option is expanded after the TLS negotiation and
28107 the result is placed in &$auth1$&.
28108 If the expansion is forced to fail, authentication fails. Any other expansion
28109 failure causes a temporary error code to be returned.
28110
28111 .option server_param2 tls string&!! unset
28112 .option server_param3 tls string&!! unset
28113 As above, for &$auth2$& and &$auth3$&.
28114
28115 &%server_param1%& may also be spelled &%server_param%&.
28116
28117
28118 Example:
28119 .code
28120 tls:
28121   driver = tls
28122   server_param1 =     ${certextract {subj_altname,mail,>:} \
28123                                     {$tls_in_peercert}}
28124   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28125                                  {forany {$auth1} \
28126                             {!= {0} \
28127                                 {${lookup ldap{ldap:///\
28128                          mailname=${quote_ldap_dn:${lc:$item}},\
28129                          ou=users,LDAP_DC?mailid} {$value}{0} \
28130                        }    }  } }}}
28131   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28132 .endd
28133 This accepts a client certificate that is verifiable against any
28134 of your configured trust-anchors
28135 (which usually means the full set of public CAs)
28136 and which has a SAN with a good account name.
28137
28138 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28139 The account name is therefore guessable by an opponent.
28140 TLS 1.3 protects both server and client certificates, and is not vulnerable
28141 in this way.
28142 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28143
28144 . An alternative might use
28145 . .code
28146 .   server_param1 = ${sha256:$tls_in_peercert}
28147 . .endd
28148 . to require one of a set of specific certs that define a given account
28149 . (the verification is still required, but mostly irrelevant).
28150 . This would help for per-device use.
28151 .
28152 . However, for the future we really need support for checking a
28153 . user cert in LDAP - which probably wants a base-64 DER.
28154
28155 .ecindex IIDtlsauth1
28156 .ecindex IIDtlsauth2
28157
28158
28159 Note that because authentication is traditionally an SMTP operation,
28160 the &%authenticated%& ACL condition cannot be used in
28161 a connect- or helo-ACL.
28162
28163
28164
28165 . ////////////////////////////////////////////////////////////////////////////
28166 . ////////////////////////////////////////////////////////////////////////////
28167
28168 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28169          "Encrypted SMTP connections"
28170 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28171 .scindex IIDencsmtp2 "SMTP" "encryption"
28172 .cindex "TLS" "on SMTP connection"
28173 .cindex "OpenSSL"
28174 .cindex "GnuTLS"
28175 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28176 Sockets Layer), is implemented by making use of the OpenSSL library or the
28177 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28178 cryptographic code in the Exim distribution itself for implementing TLS. In
28179 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28180 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28181 You also need to understand the basic concepts of encryption at a managerial
28182 level, and in particular, the way that public keys, private keys, and
28183 certificates are used.
28184
28185 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28186 connection is established, the client issues a STARTTLS command. If the
28187 server accepts this, the client and the server negotiate an encryption
28188 mechanism. If the negotiation succeeds, the data that subsequently passes
28189 between them is encrypted.
28190
28191 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28192 and if so, what cipher suite is in use, whether the client supplied a
28193 certificate, and whether or not that certificate was verified. This makes it
28194 possible for an Exim server to deny or accept certain commands based on the
28195 encryption state.
28196
28197 &*Warning*&: Certain types of firewall and certain anti-virus products can
28198 disrupt TLS connections. You need to turn off SMTP scanning for these products
28199 in order to get TLS to work.
28200
28201
28202
28203 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28204          "SECID284"
28205 .cindex "submissions protocol"
28206 .cindex "ssmtp protocol"
28207 .cindex "smtps protocol"
28208 .cindex "SMTP" "submissions protocol"
28209 .cindex "SMTP" "ssmtp protocol"
28210 .cindex "SMTP" "smtps protocol"
28211 The history of port numbers for TLS in SMTP is a little messy and has been
28212 contentious.  As of RFC 8314, the common practice of using the historically
28213 allocated port 465 for "email submission but with TLS immediately upon connect
28214 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28215 by them in preference to STARTTLS.
28216
28217 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28218 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28219 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28220
28221 This approach was, for a while, officially abandoned when encrypted SMTP was
28222 standardized, but many clients kept using it, even as the TCP port number was
28223 reassigned for other use.
28224 Thus you may encounter guidance claiming that you shouldn't enable use of
28225 this port.
28226 In practice, a number of mail-clients have only ever supported submissions,
28227 not submission with STARTTLS upgrade.
28228 Ideally, offer both submission (587) and submissions (465) service.
28229
28230 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28231 global option. Its value must be a list of port numbers;
28232 the most common use is expected to be:
28233 .code
28234 tls_on_connect_ports = 465
28235 .endd
28236 The port numbers specified by this option apply to all SMTP connections, both
28237 via the daemon and via &'inetd'&. You still need to specify all the ports that
28238 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28239 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28240 an extra port &-- rather, it specifies different behaviour on a port that is
28241 defined elsewhere.
28242
28243 There is also a &%-tls-on-connect%& command line option. This overrides
28244 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28245
28246
28247
28248
28249
28250
28251 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28252 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28253 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28254 To build Exim to use OpenSSL you need to set
28255 .code
28256 USE_OPENSSL=yes
28257 .endd
28258 in Local/Makefile.
28259
28260 To build Exim to use GnuTLS, you need to set
28261 .code
28262 USE_GNUTLS=yes
28263 .endd
28264 in Local/Makefile.
28265
28266 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28267 include files and libraries for GnuTLS can be found.
28268
28269 There are some differences in usage when using GnuTLS instead of OpenSSL:
28270
28271 .ilist
28272 The &%tls_verify_certificates%& option
28273 cannot be the path of a directory
28274 for GnuTLS versions before 3.3.6
28275 (for later versions, or OpenSSL, it can be either).
28276 .next
28277 The default value for &%tls_dhparam%& differs for historical reasons.
28278 .next
28279 .vindex "&$tls_in_peerdn$&"
28280 .vindex "&$tls_out_peerdn$&"
28281 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28282 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28283 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28284 .next
28285 OpenSSL identifies cipher suites using hyphens as separators, for example:
28286 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28287 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28288 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28289 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28290 to handle its own older variants) when processing lists of cipher suites in the
28291 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28292 option).
28293 .next
28294 The &%tls_require_ciphers%& options operate differently, as described in the
28295 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28296 .next
28297 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28298 When using OpenSSL, this option is ignored.
28299 (If an API is found to let OpenSSL be configured in this way,
28300 let the Exim Maintainers know and we'll likely use it).
28301 .next
28302 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28303 main option, it must be ordered to match the &%tls_certificate%& list.
28304 .next
28305 Some other recently added features may only be available in one or the other.
28306 This should be documented with the feature.  If the documentation does not
28307 explicitly state that the feature is infeasible in the other TLS
28308 implementation, then patches are welcome.
28309 .endlist
28310
28311
28312 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28313 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28314 an explicit path; if the latter, then the text about generation still applies,
28315 but not the chosen filename.
28316 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28317 See the documentation of &%tls_dhparam%& for more information.
28318
28319 GnuTLS uses D-H parameters that may take a substantial amount of time
28320 to compute. It is unreasonable to re-compute them for every TLS session.
28321 Therefore, Exim keeps this data in a file in its spool directory, called
28322 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28323 of bits requested.
28324 The file is owned by the Exim user and is readable only by
28325 its owner. Every Exim process that start up GnuTLS reads the D-H
28326 parameters from this file. If the file does not exist, the first Exim process
28327 that needs it computes the data and writes it to a temporary file which is
28328 renamed once it is complete. It does not matter if several Exim processes do
28329 this simultaneously (apart from wasting a few resources). Once a file is in
28330 place, new Exim processes immediately start using it.
28331
28332 For maximum security, the parameters that are stored in this file should be
28333 recalculated periodically, the frequency depending on your paranoia level.
28334 If you are avoiding using the fixed D-H primes published in RFCs, then you
28335 are concerned about some advanced attacks and will wish to do this; if you do
28336 not regenerate then you might as well stick to the standard primes.
28337
28338 Arranging this is easy in principle; just delete the file when you want new
28339 values to be computed. However, there may be a problem. The calculation of new
28340 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28341 If the system is not very active, &_/dev/random_& may delay returning data
28342 until enough randomness (entropy) is available. This may cause Exim to hang for
28343 a substantial amount of time, causing timeouts on incoming connections.
28344
28345 The solution is to generate the parameters externally to Exim. They are stored
28346 in &_gnutls-params-N_& in PEM format, which means that they can be
28347 generated externally using the &(certtool)& command that is part of GnuTLS.
28348
28349 To replace the parameters with new ones, instead of deleting the file
28350 and letting Exim re-create it, you can generate new parameters using
28351 &(certtool)& and, when this has been done, replace Exim's cache file by
28352 renaming. The relevant commands are something like this:
28353 .code
28354 # ls
28355 [ look for file; assume gnutls-params-2236 is the most recent ]
28356 # rm -f new-params
28357 # touch new-params
28358 # chown exim:exim new-params
28359 # chmod 0600 new-params
28360 # certtool --generate-dh-params --bits 2236 >>new-params
28361 # openssl dhparam -noout -text -in new-params | head
28362 [ check the first line, make sure it's not more than 2236;
28363   if it is, then go back to the start ("rm") and repeat
28364   until the size generated is at most the size requested ]
28365 # chmod 0400 new-params
28366 # mv new-params gnutls-params-2236
28367 .endd
28368 If Exim never has to generate the parameters itself, the possibility of
28369 stalling is removed.
28370
28371 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28372 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28373 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28374 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28375 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28376 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28377 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28378 which applies to all D-H usage, client or server.  If the value returned by
28379 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28380 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28381 limit, which is still much higher than Exim historically used.
28382
28383 The filename and bits used will change as the GnuTLS maintainers change the
28384 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28385 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28386 2432 bits, while NSS is limited to 2236 bits.
28387
28388 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28389 increase the chance of the generated prime actually being within acceptable
28390 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28391 procedure above.  There is no sane procedure available to Exim to double-check
28392 the size of the generated prime, so it might still be too large.
28393
28394
28395 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28396 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28397 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28398 There is a function in the OpenSSL library that can be passed a list of cipher
28399 suites before the cipher negotiation takes place. This specifies which ciphers
28400 are acceptable for TLS versions prior to 1.3.
28401 The list is colon separated and may contain names like
28402 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28403 directly to this function call.
28404 Many systems will install the OpenSSL manual-pages, so you may have
28405 &'ciphers(1)'& available to you.
28406 The following quotation from the OpenSSL
28407 documentation specifies what forms of item are allowed in the cipher string:
28408
28409 .ilist
28410 It can consist of a single cipher suite such as RC4-SHA.
28411 .next
28412 It can represent a list of cipher suites containing a certain algorithm,
28413 or cipher suites of a certain type. For example SHA1 represents all
28414 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28415 SSL v3 algorithms.
28416 .next
28417 Lists of cipher suites can be combined in a single cipher string using
28418 the + character. This is used as a logical and operation. For example
28419 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28420 algorithms.
28421 .endlist
28422
28423 Each cipher string can be optionally preceded by one of the characters &`!`&,
28424 &`-`& or &`+`&.
28425 .ilist
28426 If &`!`& is used, the ciphers are permanently deleted from the list. The
28427 ciphers deleted can never reappear in the list even if they are explicitly
28428 stated.
28429 .next
28430 If &`-`& is used, the ciphers are deleted from the list, but some or all
28431 of the ciphers can be added again by later options.
28432 .next
28433 If &`+`& is used, the ciphers are moved to the end of the list. This
28434 option does not add any new ciphers; it just moves matching existing ones.
28435 .endlist
28436
28437 If none of these characters is present, the string is interpreted as
28438 a list of ciphers to be appended to the current preference list. If the list
28439 includes any ciphers already present they will be ignored: that is, they will
28440 not be moved to the end of the list.
28441 .endlist
28442
28443 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28444 string:
28445 .code
28446 # note single-quotes to get ! past any shell history expansion
28447 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28448 .endd
28449
28450 This example will let the library defaults be permitted on the MX port, where
28451 there's probably no identity verification anyway, but ups the ante on the
28452 submission ports where the administrator might have some influence on the
28453 choice of clients used:
28454 .code
28455 # OpenSSL variant; see man ciphers(1)
28456 tls_require_ciphers = ${if =={$received_port}{25}\
28457                            {DEFAULT}\
28458                            {HIGH:!MD5:!SHA1}}
28459 .endd
28460
28461 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28462 .code
28463 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28464 .endd
28465
28466 For TLS version 1.3 the control available is less fine-grained
28467 and Exim does not provide access to it at present.
28468 The value of the &%tls_require_ciphers%& option is ignored when
28469 TLS version 1.3 is negotiated.
28470
28471 As of writing the library default cipher suite list for TLSv1.3 is
28472 .code
28473 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28474 .endd
28475
28476
28477 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28478          "SECTreqciphgnu"
28479 .cindex "GnuTLS" "specifying parameters for"
28480 .cindex "TLS" "specifying ciphers (GnuTLS)"
28481 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28482 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28483 .cindex "TLS" "specifying protocols (GnuTLS)"
28484 .cindex "TLS" "specifying priority string (GnuTLS)"
28485 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28486 The GnuTLS library allows the caller to provide a "priority string", documented
28487 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28488 ciphersuite specification in OpenSSL.
28489
28490 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28491 and controls both protocols and ciphers.
28492
28493 The &%tls_require_ciphers%& option is available both as an global option,
28494 controlling how Exim behaves as a server, and also as an option of the
28495 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28496 the value is string expanded.  The resulting string is not an Exim list and
28497 the string is given to the GnuTLS library, so that Exim does not need to be
28498 aware of future feature enhancements of GnuTLS.
28499
28500 Documentation of the strings accepted may be found in the GnuTLS manual, under
28501 "Priority strings".  This is online as
28502 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28503 but beware that this relates to GnuTLS 3, which may be newer than the version
28504 installed on your system.  If you are using GnuTLS 3,
28505 then the example code
28506 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28507 on that site can be used to test a given string.
28508
28509 For example:
28510 .code
28511 # Disable older versions of protocols
28512 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28513 .endd
28514
28515 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28516 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28517 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28518
28519 This example will let the library defaults be permitted on the MX port, where
28520 there's probably no identity verification anyway, and lowers security further
28521 by increasing compatibility; but this ups the ante on the submission ports
28522 where the administrator might have some influence on the choice of clients
28523 used:
28524 .code
28525 # GnuTLS variant
28526 tls_require_ciphers = ${if =={$received_port}{25}\
28527                            {NORMAL:%COMPAT}\
28528                            {SECURE128}}
28529 .endd
28530
28531
28532 .section "Configuring an Exim server to use TLS" "SECID182"
28533 .cindex "TLS" "configuring an Exim server"
28534 When Exim has been built with TLS support, it advertises the availability of
28535 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28536 but not to any others. The default value of this option is *, which means
28537 that STARTTLS is always advertised.  Set it to blank to never advertise;
28538 this is reasonable for systems that want to use TLS only as a client.
28539
28540 If STARTTLS is to be used you
28541 need to set some other options in order to make TLS available.
28542
28543 If a client issues a STARTTLS command and there is some configuration
28544 problem in the server, the command is rejected with a 454 error. If the client
28545 persists in trying to issue SMTP commands, all except QUIT are rejected
28546 with the error
28547 .code
28548 554 Security failure
28549 .endd
28550 If a STARTTLS command is issued within an existing TLS session, it is
28551 rejected with a 554 error code.
28552
28553 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28554 must be set to match some hosts. The default is * which matches all hosts.
28555
28556 If this is all you do, TLS encryption will be enabled but not authentication -
28557 meaning that the peer has no assurance it is actually you he is talking to.
28558 You gain protection from a passive sniffer listening on the wire but not
28559 from someone able to intercept the communication.
28560
28561 Further protection requires some further configuration at the server end.
28562
28563 To make TLS work you need to set, in the server,
28564 .code
28565 tls_certificate = /some/file/name
28566 tls_privatekey = /some/file/name
28567 .endd
28568 These options are, in fact, expanded strings, so you can make them depend on
28569 the identity of the client that is connected if you wish. The first file
28570 contains the server's X509 certificate, and the second contains the private key
28571 that goes with it. These files need to be
28572 PEM format and readable by the Exim user, and must
28573 always be given as full path names.
28574 The key must not be password-protected.
28575 They can be the same file if both the
28576 certificate and the key are contained within it. If &%tls_privatekey%& is not
28577 set, or if its expansion is forced to fail or results in an empty string, this
28578 is assumed to be the case. The certificate file may also contain intermediate
28579 certificates that need to be sent to the client to enable it to authenticate
28580 the server's certificate.
28581
28582 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28583 colon-separated lists of file paths.  Ciphers using given authentication
28584 algorithms require the presence of a suitable certificate to supply the
28585 public-key.  The server selects among the certificates to present to the
28586 client depending on the selected cipher, hence the priority ordering for
28587 ciphers will affect which certificate is used.
28588
28589 If you do not understand about certificates and keys, please try to find a
28590 source of this background information, which is not Exim-specific. (There are a
28591 few comments below in section &<<SECTcerandall>>&.)
28592
28593 &*Note*&: These options do not apply when Exim is operating as a client &--
28594 they apply only in the case of a server. If you need to use a certificate in an
28595 Exim client, you must set the options of the same names in an &(smtp)&
28596 transport.
28597
28598 With just these options, an Exim server will be able to use TLS. It does not
28599 require the client to have a certificate (but see below for how to insist on
28600 this). There is one other option that may be needed in other situations. If
28601 .code
28602 tls_dhparam = /some/file/name
28603 .endd
28604 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28605 with the parameters contained in the file.
28606 Set this to &`none`& to disable use of DH entirely, by making no prime
28607 available:
28608 .code
28609 tls_dhparam = none
28610 .endd
28611 This may also be set to a string identifying a standard prime to be used for
28612 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28613 used is &`ike23`&.  There are a few standard primes available, see the
28614 documentation for &%tls_dhparam%& for the complete list.
28615
28616 See the command
28617 .code
28618 openssl dhparam
28619 .endd
28620 for a way of generating file data.
28621
28622 The strings supplied for these three options are expanded every time a client
28623 host connects. It is therefore possible to use different certificates and keys
28624 for different hosts, if you so wish, by making use of the client's IP address
28625 in &$sender_host_address$& to control the expansion. If a string expansion is
28626 forced to fail, Exim behaves as if the option is not set.
28627
28628 .cindex "cipher" "logging"
28629 .cindex "log" "TLS cipher"
28630 .vindex "&$tls_in_cipher$&"
28631 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28632 an incoming TLS connection. It is included in the &'Received:'& header of an
28633 incoming message (by default &-- you can, of course, change this), and it is
28634 also included in the log line that records a message's arrival, keyed by
28635 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28636 condition can be used to test for specific cipher suites in ACLs.
28637
28638 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28639 can check the name of the cipher suite and vary their actions accordingly. The
28640 cipher suite names vary, depending on which TLS library is being used. For
28641 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28642 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28643 documentation for more details.
28644
28645 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28646 (again depending on the &%tls_cipher%& log selector).
28647
28648
28649 .section "Requesting and verifying client certificates" "SECID183"
28650 .cindex "certificate" "verification of client"
28651 .cindex "TLS" "client certificate verification"
28652 If you want an Exim server to request a certificate when negotiating a TLS
28653 session with a client, you must set either &%tls_verify_hosts%& or
28654 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28655 apply to all TLS connections. For any host that matches one of these options,
28656 Exim requests a certificate as part of the setup of the TLS session. The
28657 contents of the certificate are verified by comparing it with a list of
28658 expected trust-anchors or certificates.
28659 These may be the system default set (depending on library version),
28660 an explicit file or,
28661 depending on library version, a directory, identified by
28662 &%tls_verify_certificates%&.
28663
28664 A file can contain multiple certificates, concatenated end to end. If a
28665 directory is used
28666 (OpenSSL only),
28667 each certificate must be in a separate file, with a name (or a symbolic link)
28668 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28669 certificate. You can compute the relevant hash by running the command
28670 .code
28671 openssl x509 -hash -noout -in /cert/file
28672 .endd
28673 where &_/cert/file_& contains a single certificate.
28674
28675 There is no checking of names of the client against the certificate
28676 Subject Name or Subject Alternate Names.
28677
28678 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28679 what happens if the client does not supply a certificate, or if the certificate
28680 does not match any of the certificates in the collection named by
28681 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28682 attempt to set up a TLS session is aborted, and the incoming connection is
28683 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28684 session continues. ACLs that run for subsequent SMTP commands can detect the
28685 fact that no certificate was verified, and vary their actions accordingly. For
28686 example, you can insist on a certificate before accepting a message for
28687 relaying, but not when the message is destined for local delivery.
28688
28689 .vindex "&$tls_in_peerdn$&"
28690 When a client supplies a certificate (whether it verifies or not), the value of
28691 the Distinguished Name of the certificate is made available in the variable
28692 &$tls_in_peerdn$& during subsequent processing of the message.
28693
28694 .cindex "log" "distinguished name"
28695 Because it is often a long text string, it is not included in the log line or
28696 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28697 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28698 &%received_header_text%& to change the &'Received:'& header. When no
28699 certificate is supplied, &$tls_in_peerdn$& is empty.
28700
28701
28702 .section "Revoked certificates" "SECID184"
28703 .cindex "TLS" "revoked certificates"
28704 .cindex "revocation list"
28705 .cindex "certificate" "revocation list"
28706 .cindex "OCSP" "stapling"
28707 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28708 certificates are revoked. If you have such a list, you can pass it to an Exim
28709 server using the global option called &%tls_crl%& and to an Exim client using
28710 an identically named option for the &(smtp)& transport. In each case, the value
28711 of the option is expanded and must then be the name of a file that contains a
28712 CRL in PEM format.
28713 The downside is that clients have to periodically re-download a potentially huge
28714 file from every certificate authority they know of.
28715
28716 The way with most moving parts at query time is Online Certificate
28717 Status Protocol (OCSP), where the client verifies the certificate
28718 against an OCSP server run by the CA.  This lets the CA track all
28719 usage of the certs.  It requires running software with access to the
28720 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28721 is based on HTTP and can be proxied accordingly.
28722
28723 The only widespread OCSP server implementation (known to this writer)
28724 comes as part of OpenSSL and aborts on an invalid request, such as
28725 connecting to the port and then disconnecting.  This requires
28726 re-entering the passphrase each time some random client does this.
28727
28728 The third way is OCSP Stapling; in this, the server using a certificate
28729 issued by the CA periodically requests an OCSP proof of validity from
28730 the OCSP server, then serves it up inline as part of the TLS
28731 negotiation.   This approach adds no extra round trips, does not let the
28732 CA track users, scales well with number of certs issued by the CA and is
28733 resilient to temporary OCSP server failures, as long as the server
28734 starts retrying to fetch an OCSP proof some time before its current
28735 proof expires.  The downside is that it requires server support.
28736
28737 Unless Exim is built with the support disabled,
28738 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28739 support for OCSP stapling is included.
28740
28741 There is a global option called &%tls_ocsp_file%&.
28742 The file specified therein is expected to be in DER format, and contain
28743 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28744 option will be re-expanded for SNI, if the &%tls_certificate%& option
28745 contains &`tls_in_sni`&, as per other TLS options.
28746
28747 Exim does not at this time implement any support for fetching a new OCSP
28748 proof.  The burden is on the administrator to handle this, outside of
28749 Exim.  The file specified should be replaced atomically, so that the
28750 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28751 on each connection, so a new file will be handled transparently on the
28752 next connection.
28753
28754 When built with OpenSSL Exim will check for a valid next update timestamp
28755 in the OCSP proof; if not present, or if the proof has expired, it will be
28756 ignored.
28757
28758 For the client to be able to verify the stapled OCSP the server must
28759 also supply, in its stapled information, any intermediate
28760 certificates for the chain leading to the OCSP proof from the signer
28761 of the server certificate.  There may be zero or one such. These
28762 intermediate certificates should be added to the server OCSP stapling
28763 file named by &%tls_ocsp_file%&.
28764
28765 Note that the proof only covers the terminal server certificate,
28766 not any of the chain from CA to it.
28767
28768 There is no current way to staple a proof for a client certificate.
28769
28770 .code
28771   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28772   OCSP server is supplied.  The server URL may be included in the
28773   server certificate, if the CA is helpful.
28774
28775   One failure mode seen was the OCSP Signer cert expiring before the end
28776   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28777   noted this as invalid overall, but the re-fetch script did not.
28778 .endd
28779
28780
28781
28782
28783 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28784 .cindex "cipher" "logging"
28785 .cindex "log" "TLS cipher"
28786 .cindex "log" "distinguished name"
28787 .cindex "TLS" "configuring an Exim client"
28788 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28789 deliveries as well as to incoming, the latter one causing logging of the
28790 server certificate's DN. The remaining client configuration for TLS is all
28791 within the &(smtp)& transport.
28792
28793 It is not necessary to set any options to have TLS work in the &(smtp)&
28794 transport. If Exim is built with TLS support, and TLS is advertised by a
28795 server, the &(smtp)& transport always tries to start a TLS session. However,
28796 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28797 transport) to a list of server hosts for which TLS should not be used.
28798
28799 If you do not want Exim to attempt to send messages unencrypted when an attempt
28800 to set up an encrypted connection fails in any way, you can set
28801 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28802 those hosts, delivery is always deferred if an encrypted connection cannot be
28803 set up. If there are any other hosts for the address, they are tried in the
28804 usual way.
28805
28806 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28807 the message unencrypted. It always does this if the response to STARTTLS is
28808 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28809 session after a success response code, what happens is controlled by the
28810 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28811 delivery to this host is deferred, and other hosts (if available) are tried. If
28812 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28813 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28814 negotiation fails, Exim closes the current connection (because it is in an
28815 unknown state), opens a new one to the same host, and then tries the delivery
28816 unencrypted.
28817
28818 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28819 transport provide the client with a certificate, which is passed to the server
28820 if it requests it. If the server is Exim, it will request a certificate only if
28821 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28822
28823 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
28824 for client use (they are usable for server use).
28825 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
28826 in failed connections.
28827
28828 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28829 specifies a collection of expected server certificates.
28830 These may be
28831 the system default set (depending on library version),
28832 a file,
28833 or (depending on library version) a directory.
28834 The client verifies the server's certificate
28835 against this collection, taking into account any revoked certificates that are
28836 in the list defined by &%tls_crl%&.
28837 Failure to verify fails the TLS connection unless either of the
28838 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28839
28840 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28841 certificate verification to the listed servers.  Verification either must
28842 or need not succeed respectively.
28843
28844 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28845 checks are made: that the host name (the one in the DNS A record)
28846 is valid for the certificate.
28847 The option defaults to always checking.
28848
28849 The &(smtp)& transport has two OCSP-related options:
28850 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28851 is requested and required for the connection to proceed.  The default
28852 value is empty.
28853 &%hosts_request_ocsp%&; a host-list for which (additionally)
28854 a Certificate Status is requested (but not necessarily verified).  The default
28855 value is "*" meaning that requests are made unless configured
28856 otherwise.
28857
28858 The host(s) should also be in &%hosts_require_tls%&, and
28859 &%tls_verify_certificates%& configured for the transport,
28860 for OCSP to be relevant.
28861
28862 If
28863 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28864 list of permitted cipher suites. If either of these checks fails, delivery to
28865 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28866 alternative hosts, if any.
28867
28868  &*Note*&:
28869 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28870 is operating as a client. Exim does not assume that a server certificate (set
28871 by the global options of the same name) should also be used when operating as a
28872 client.
28873
28874 .vindex "&$host$&"
28875 .vindex "&$host_address$&"
28876 All the TLS options in the &(smtp)& transport are expanded before use, with
28877 &$host$& and &$host_address$& containing the name and address of the server to
28878 which the client is connected. Forced failure of an expansion causes Exim to
28879 behave as if the relevant option were unset.
28880
28881 .vindex &$tls_out_bits$&
28882 .vindex &$tls_out_cipher$&
28883 .vindex &$tls_out_peerdn$&
28884 .vindex &$tls_out_sni$&
28885 Before an SMTP connection is established, the
28886 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28887 variables are emptied. (Until the first connection, they contain the values
28888 that were set when the message was received.) If STARTTLS is subsequently
28889 successfully obeyed, these variables are set to the relevant values for the
28890 outgoing connection.
28891
28892
28893
28894 .section "Use of TLS Server Name Indication" "SECTtlssni"
28895 .cindex "TLS" "Server Name Indication"
28896 .vindex "&$tls_in_sni$&"
28897 .oindex "&%tls_in_sni%&"
28898 With TLS1.0 or above, there is an extension mechanism by which extra
28899 information can be included at various points in the protocol.  One of these
28900 extensions, documented in RFC 6066 (and before that RFC 4366) is
28901 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28902 client in the initial handshake, so that the server can examine the servername
28903 within and possibly choose to use different certificates and keys (and more)
28904 for this session.
28905
28906 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28907 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28908 address.
28909
28910 With SMTP to MX, there are the same problems here as in choosing the identity
28911 against which to validate a certificate: you can't rely on insecure DNS to
28912 provide the identity which you then cryptographically verify.  So this will
28913 be of limited use in that environment.
28914
28915 With SMTP to Submission, there is a well-defined hostname which clients are
28916 connecting to and can validate certificates against.  Thus clients &*can*&
28917 choose to include this information in the TLS negotiation.  If this becomes
28918 wide-spread, then hosters can choose to present different certificates to
28919 different clients.  Or even negotiate different cipher suites.
28920
28921 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28922 if not empty, will be sent on a TLS session as part of the handshake.  There's
28923 nothing more to it.  Choosing a sensible value not derived insecurely is the
28924 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28925 for the lifetime of the client connection (including during authentication).
28926
28927 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28928 received from a client.
28929 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28930
28931 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28932 option (prior to expansion) then the following options will be re-expanded
28933 during TLS session handshake, to permit alternative values to be chosen:
28934
28935 .ilist
28936 &%tls_certificate%&
28937 .next
28938 &%tls_crl%&
28939 .next
28940 &%tls_privatekey%&
28941 .next
28942 &%tls_verify_certificates%&
28943 .next
28944 &%tls_ocsp_file%&
28945 .endlist
28946
28947 Great care should be taken to deal with matters of case, various injection
28948 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28949 can always be referenced; it is important to remember that &$tls_in_sni$& is
28950 arbitrary unverified data provided prior to authentication.
28951 Further, the initial certificate is loaded before SNI has arrived, so
28952 an expansion for &%tls_certificate%& must have a default which is used
28953 when &$tls_in_sni$& is empty.
28954
28955 The Exim developers are proceeding cautiously and so far no other TLS options
28956 are re-expanded.
28957
28958 When Exim is built against OpenSSL, OpenSSL must have been built with support
28959 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28960 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28961 see &`-servername`& in the output, then OpenSSL has support.
28962
28963 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28964 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28965 built, then you have SNI support).
28966
28967
28968
28969 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28970          "SECTmulmessam"
28971 .cindex "multiple SMTP deliveries with TLS"
28972 .cindex "TLS" "multiple message deliveries"
28973 Exim sends multiple messages down the same TCP/IP connection by starting up
28974 an entirely new delivery process for each message, passing the socket from
28975 one process to the next. This implementation does not fit well with the use
28976 of TLS, because there is quite a lot of state information associated with a TLS
28977 connection, not just a socket identification. Passing all the state information
28978 to a new process is not feasible. Consequently, for sending using TLS Exim
28979 starts an additional proxy process for handling the encryption, piping the
28980 unencrypted data stream from and to the delivery processes.
28981
28982 An older mode of operation can be enabled on a per-host basis by the
28983 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28984 this list the proxy process described above is not used; instead Exim
28985 shuts down an existing TLS session being run by the delivery process
28986 before passing the socket to a new process. The new process may then
28987 try to start a new TLS session, and if successful, may try to re-authenticate
28988 if AUTH is in use, before sending the next message.
28989
28990 The RFC is not clear as to whether or not an SMTP session continues in clear
28991 after TLS has been shut down, or whether TLS may be restarted again later, as
28992 just described. However, if the server is Exim, this shutdown and
28993 reinitialization works. It is not known which (if any) other servers operate
28994 successfully if the client closes a TLS session and continues with unencrypted
28995 SMTP, but there are certainly some that do not work. For such servers, Exim
28996 should not pass the socket to another process, because the failure of the
28997 subsequent attempt to use it would cause Exim to record a temporary host error,
28998 and delay other deliveries to that host.
28999
29000 To test for this case, Exim sends an EHLO command to the server after
29001 closing down the TLS session. If this fails in any way, the connection is
29002 closed instead of being passed to a new delivery process, but no retry
29003 information is recorded.
29004
29005 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29006 &(smtp)& transport to match those hosts for which Exim should not pass
29007 connections to new processes if TLS has been used.
29008
29009
29010
29011
29012 .section "Certificates and all that" "SECTcerandall"
29013 .cindex "certificate" "references to discussion"
29014 In order to understand fully how TLS works, you need to know about
29015 certificates, certificate signing, and certificate authorities.
29016 This is a large topic and an introductory guide is unsuitable for the Exim
29017 reference manual, so instead we provide pointers to existing documentation.
29018
29019 The Apache web-server was for a long time the canonical guide, so their
29020 documentation is a good place to start; their SSL module's Introduction
29021 document is currently at
29022 .display
29023 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29024 .endd
29025 and their FAQ is at
29026 .display
29027 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29028 .endd
29029
29030 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29031 0-201-61598-3) in 2001, contains both introductory and more in-depth
29032 descriptions.
29033 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29034 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29035 Ivan is the author of the popular TLS testing tools at
29036 &url(https://www.ssllabs.com/).
29037
29038
29039 .section "Certificate chains" "SECID186"
29040 The file named by &%tls_certificate%& may contain more than one
29041 certificate. This is useful in the case where the certificate that is being
29042 sent is validated by an intermediate certificate which the other end does
29043 not have. Multiple certificates must be in the correct order in the file.
29044 First the host's certificate itself, then the first intermediate
29045 certificate to validate the issuer of the host certificate, then the next
29046 intermediate certificate to validate the issuer of the first intermediate
29047 certificate, and so on, until finally (optionally) the root certificate.
29048 The root certificate must already be trusted by the recipient for
29049 validation to succeed, of course, but if it's not preinstalled, sending the
29050 root certificate along with the rest makes it available for the user to
29051 install if the receiving end is a client MUA that can interact with a user.
29052
29053 Note that certificates using MD5 are unlikely to work on today's Internet;
29054 even if your libraries allow loading them for use in Exim when acting as a
29055 server, increasingly clients will not accept such certificates.  The error
29056 diagnostics in such a case can be frustratingly vague.
29057
29058
29059
29060 .section "Self-signed certificates" "SECID187"
29061 .cindex "certificate" "self-signed"
29062 You can create a self-signed certificate using the &'req'& command provided
29063 with OpenSSL, like this:
29064 . ==== Do not shorten the duration here without reading and considering
29065 . ==== the text below.  Please leave it at 9999 days.
29066 .code
29067 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29068             -days 9999 -nodes
29069 .endd
29070 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29071 delimited and so can be identified independently. The &%-days%& option
29072 specifies a period for which the certificate is valid. The &%-nodes%& option is
29073 important: if you do not set it, the key is encrypted with a passphrase
29074 that you are prompted for, and any use that is made of the key causes more
29075 prompting for the passphrase. This is not helpful if you are going to use
29076 this certificate and key in an MTA, where prompting is not possible.
29077
29078 . ==== I expect to still be working 26 years from now.  The less technical
29079 . ==== debt I create, in terms of storing up trouble for my later years, the
29080 . ==== happier I will be then.  We really have reached the point where we
29081 . ==== should start, at the very least, provoking thought and making folks
29082 . ==== pause before proceeding, instead of leaving all the fixes until two
29083 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29084 . ==== -pdp, 2012
29085 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29086 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29087 the above command might produce a date in the past.  Think carefully about
29088 the lifetime of the systems you're deploying, and either reduce the duration
29089 of the certificate or reconsider your platform deployment.  (At time of
29090 writing, reducing the duration is the most likely choice, but the inexorable
29091 progression of time takes us steadily towards an era where this will not
29092 be a sensible resolution).
29093
29094 A self-signed certificate made in this way is sufficient for testing, and
29095 may be adequate for all your requirements if you are mainly interested in
29096 encrypting transfers, and not in secure identification.
29097
29098 However, many clients require that the certificate presented by the server be a
29099 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29100 certificate. In this situation, the self-signed certificate described above
29101 must be installed on the client host as a trusted root &'certification
29102 authority'& (CA), and the certificate used by Exim must be a user certificate
29103 signed with that self-signed certificate.
29104
29105 For information on creating self-signed CA certificates and using them to sign
29106 user certificates, see the &'General implementation overview'& chapter of the
29107 Open-source PKI book, available online at
29108 &url(https://sourceforge.net/projects/ospkibook/).
29109 .ecindex IIDencsmtp1
29110 .ecindex IIDencsmtp2
29111
29112
29113
29114 .section DANE "SECDANE"
29115 .cindex DANE
29116 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29117 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29118 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29119 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29120 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29121 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29122
29123 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29124 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29125 by (a) is thought to be smaller than that of the set of root CAs.
29126
29127 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29128 fail to pass on a server's STARTTLS.
29129
29130 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29131 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29132 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29133
29134 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29135 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29136 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29137 DNSSEC.
29138 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29139 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29140
29141 There are no changes to Exim specific to server-side operation of DANE.
29142 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29143 in &_Local/Makefile_&.
29144 If it has been included, the macro "_HAVE_DANE" will be defined.
29145
29146 A TLSA record consist of 4 fields, the "Certificate Usage", the
29147 "Selector", the "Matching type", and the "Certificate Association Data".
29148 For a detailed description of the TLSA record see
29149 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29150
29151 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29152 These are the "Trust Anchor" and "End Entity" variants.
29153 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29154 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29155 this is appropriate for a single system, using a self-signed certificate.
29156 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29157 well-known one.
29158 A private CA at simplest is just a self-signed certificate (with certain
29159 attributes) which is used to sign server certificates, but running one securely
29160 does require careful arrangement.
29161 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29162 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29163 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29164 all of which point to a single TLSA record.
29165 DANE-TA and DANE-EE can both be used together.
29166
29167 Our recommendation is to use DANE with a certificate from a public CA,
29168 because this enables a variety of strategies for remote clients to verify
29169 your certificate.
29170 You can then publish information both via DANE and another technology,
29171 "MTA-STS", described below.
29172
29173 When you use DANE-TA to publish trust anchor information, you ask entities
29174 outside your administrative control to trust the Certificate Authority for
29175 connections to you.
29176 If using a private CA then you should expect others to still apply the
29177 technical criteria they'd use for a public CA to your certificates.
29178 In particular, you should probably try to follow current best practices for CA
29179 operation around hash algorithms and key sizes.
29180 Do not expect other organizations to lower their security expectations just
29181 because a particular profile might be reasonable for your own internal use.
29182
29183 When this text was last updated, this in practice means to avoid use of SHA-1
29184 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29185 than 4096, for interoperability); to use keyUsage fields correctly; to use
29186 random serial numbers.
29187 The list of requirements is subject to change as best practices evolve.
29188 If you're not already using a private CA, or it doesn't meet these
29189 requirements, then we encourage you to avoid all these issues and use a public
29190 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29191
29192 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29193 a "Matching Type" (3rd) field of SHA2-512(2).
29194
29195 For the "Certificate Authority Data" (4th) field, commands like
29196
29197 .code
29198   openssl x509 -pubkey -noout <certificate.pem \
29199   | openssl rsa -outform der -pubin 2>/dev/null \
29200   | openssl sha512 \
29201   | awk '{print $2}'
29202 .endd
29203
29204 are workable to create a hash of the certificate's public key.
29205
29206 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29207
29208 .code
29209   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29210 .endd
29211
29212 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29213 is useful for quickly generating TLSA records.
29214
29215
29216 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29217
29218 The Certificate issued by the CA published in the DANE-TA model should be
29219 issued using a strong hash algorithm.
29220 Exim, and importantly various other MTAs sending to you, will not
29221 re-enable hash algorithms which have been disabled by default in TLS
29222 libraries.
29223 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29224 interoperability (and probably the maximum too, in 2018).
29225
29226 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29227 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29228 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29229
29230 .code
29231   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29232                                  {= {4}{$tls_out_tlsa_usage}} } \
29233                          {*}{}}
29234 .endd
29235
29236 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29237 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29238 found. If the definition of &%hosts_request_ocsp%& includes the
29239 string "tls_out_tlsa_usage", they are re-expanded in time to
29240 control the OCSP request.
29241
29242 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29243 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29244
29245
29246 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29247 and &%dane_require_tls_ciphers%&.
29248 The &"require"& variant will result in failure if the target host is not
29249 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29250 the &%dnssec_request_domains%& router or transport option.
29251
29252 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29253
29254 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29255 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29256 will be required for the host.  If it does not, the host will not
29257 be used; there is no fallback to non-DANE or non-TLS.
29258
29259 If DANE is requested and usable, then the TLS cipher list configuration
29260 prefers to use the option &%dane_require_tls_ciphers%& and falls
29261 back to &%tls_require_ciphers%& only if that is unset.
29262 This lets you configure "decent crypto" for DANE and "better than nothing
29263 crypto" as the default.  Note though that while GnuTLS lets the string control
29264 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29265 limited to ciphersuite constraints.
29266
29267 If DANE is requested and useable (see above) the following transport options are ignored:
29268 .code
29269   hosts_require_tls
29270   tls_verify_hosts
29271   tls_try_verify_hosts
29272   tls_verify_certificates
29273   tls_crl
29274   tls_verify_cert_hostnames
29275 .endd
29276
29277 If DANE is not usable, whether requested or not, and CA-anchored
29278 verification evaluation is wanted, the above variables should be set appropriately.
29279
29280 The router and transport option &%dnssec_request_domains%& must not be
29281 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29282
29283 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29284
29285 There is a new variable &$tls_out_dane$& which will have "yes" if
29286 verification succeeded using DANE and "no" otherwise (only useful
29287 in combination with events; see &<<CHAPevents>>&),
29288 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29289
29290 .cindex DANE reporting
29291 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29292 to achieve DANE-verified connection, if one was either requested and offered, or
29293 required.  This is intended to support TLS-reporting as defined in
29294 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29295 The &$event_data$& will be one of the Result Types defined in
29296 Section 4.3 of that document.
29297
29298 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29299
29300 DANE is specified in published RFCs and decouples certificate authority trust
29301 selection from a "race to the bottom" of "you must trust everything for mail
29302 to get through".  There is an alternative technology called MTA-STS, which
29303 instead publishes MX trust anchor information on an HTTPS website.  At the
29304 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29305 Exim has no support for MTA-STS as a client, but Exim mail server operators
29306 can choose to publish information describing their TLS configuration using
29307 MTA-STS to let those clients who do use that protocol derive trust
29308 information.
29309
29310 The MTA-STS design requires a certificate from a public Certificate Authority
29311 which is recognized by clients sending to you.
29312 That selection of which CAs are trusted by others is outside your control.
29313
29314 The most interoperable course of action is probably to use
29315 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29316 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29317 records for DANE clients (such as Exim and Postfix) and to publish anchor
29318 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29319 domain itself (with caveats around occasionally broken MTA-STS because of
29320 incompatible specification changes prior to reaching RFC status).
29321
29322
29323
29324 . ////////////////////////////////////////////////////////////////////////////
29325 . ////////////////////////////////////////////////////////////////////////////
29326
29327 .chapter "Access control lists" "CHAPACL"
29328 .scindex IIDacl "&ACL;" "description"
29329 .cindex "control of incoming mail"
29330 .cindex "message" "controlling incoming"
29331 .cindex "policy control" "access control lists"
29332 Access Control Lists (ACLs) are defined in a separate section of the runtime
29333 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29334 name, terminated by a colon. Here is a complete ACL section that contains just
29335 one very small ACL:
29336 .code
29337 begin acl
29338 small_acl:
29339   accept   hosts = one.host.only
29340 .endd
29341 You can have as many lists as you like in the ACL section, and the order in
29342 which they appear does not matter. The lists are self-terminating.
29343
29344 The majority of ACLs are used to control Exim's behaviour when it receives
29345 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29346 when a local process submits a message using SMTP by specifying the &%-bs%&
29347 option. The most common use is for controlling which recipients are accepted
29348 in incoming messages. In addition, you can define an ACL that is used to check
29349 local non-SMTP messages. The default configuration file contains an example of
29350 a realistic ACL for checking RCPT commands. This is discussed in chapter
29351 &<<CHAPdefconfil>>&.
29352
29353
29354 .section "Testing ACLs" "SECID188"
29355 The &%-bh%& command line option provides a way of testing your ACL
29356 configuration locally by running a fake SMTP session with which you interact.
29357
29358
29359 .section "Specifying when ACLs are used" "SECID189"
29360 .cindex "&ACL;" "options for specifying"
29361 In order to cause an ACL to be used, you have to name it in one of the relevant
29362 options in the main part of the configuration. These options are:
29363 .cindex "AUTH" "ACL for"
29364 .cindex "DATA" "ACLs for"
29365 .cindex "ETRN" "ACL for"
29366 .cindex "EXPN" "ACL for"
29367 .cindex "HELO" "ACL for"
29368 .cindex "EHLO" "ACL for"
29369 .cindex "DKIM" "ACL for"
29370 .cindex "MAIL" "ACL for"
29371 .cindex "QUIT, ACL for"
29372 .cindex "RCPT" "ACL for"
29373 .cindex "STARTTLS, ACL for"
29374 .cindex "VRFY" "ACL for"
29375 .cindex "SMTP" "connection, ACL for"
29376 .cindex "non-SMTP messages" "ACLs for"
29377 .cindex "MIME content scanning" "ACL for"
29378 .cindex "PRDR" "ACL for"
29379
29380 .table2 140pt
29381 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29382 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29383 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29384 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29385 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29386 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29387 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29388 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29389 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29390 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29391 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29392 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29393 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29394 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29395 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29396 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29397 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29398 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29399 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29400 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29401 .endtable
29402
29403 For example, if you set
29404 .code
29405 acl_smtp_rcpt = small_acl
29406 .endd
29407 the little ACL defined above is used whenever Exim receives a RCPT command
29408 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29409 done when RCPT commands arrive. A rejection of RCPT should cause the
29410 sending MTA to give up on the recipient address contained in the RCPT
29411 command, whereas rejection at other times may cause the client MTA to keep on
29412 trying to deliver the message. It is therefore recommended that you do as much
29413 testing as possible at RCPT time.
29414
29415
29416 .section "The non-SMTP ACLs" "SECID190"
29417 .cindex "non-SMTP messages" "ACLs for"
29418 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29419 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29420 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29421 the state of the SMTP connection such as encryption and authentication) are not
29422 relevant and are forbidden in these ACLs. However, the sender and recipients
29423 are known, so the &%senders%& and &%sender_domains%& conditions and the
29424 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29425 &$authenticated_sender$& are also available. You can specify added header lines
29426 in any of these ACLs.
29427
29428 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29429 non-SMTP message, before any of the message has been read. (This is the
29430 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29431 batched SMTP input, it runs after the DATA command has been reached. The
29432 result of this ACL is ignored; it cannot be used to reject a message. If you
29433 really need to, you could set a value in an ACL variable here and reject based
29434 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29435 controls, and in particular, it can be used to set
29436 .code
29437 control = suppress_local_fixups
29438 .endd
29439 This cannot be used in the other non-SMTP ACLs because by the time they are
29440 run, it is too late.
29441
29442 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29443 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29444
29445 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29446 kind of rejection is treated as permanent, because there is no way of sending a
29447 temporary error for these kinds of message.
29448
29449
29450 .section "The SMTP connect ACL" "SECID191"
29451 .cindex "SMTP" "connection, ACL for"
29452 .oindex &%smtp_banner%&
29453 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29454 session, after the test specified by &%host_reject_connection%& (which is now
29455 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29456 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29457 the message override the banner message that is otherwise specified by the
29458 &%smtp_banner%& option.
29459
29460
29461 .section "The EHLO/HELO ACL" "SECID192"
29462 .cindex "EHLO" "ACL for"
29463 .cindex "HELO" "ACL for"
29464 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29465 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29466 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29467 Note that a client may issue more than one EHLO or HELO command in an SMTP
29468 session, and indeed is required to issue a new EHLO or HELO after successfully
29469 setting up encryption following a STARTTLS command.
29470
29471 Note also that a deny neither forces the client to go away nor means that
29472 mail will be refused on the connection.  Consider checking for
29473 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29474
29475 If the command is accepted by an &%accept%& verb that has a &%message%&
29476 modifier, the message may not contain more than one line (it will be truncated
29477 at the first newline and a panic logged if it does). Such a message cannot
29478 affect the EHLO options that are listed on the second and subsequent lines of
29479 an EHLO response.
29480
29481
29482 .section "The DATA ACLs" "SECID193"
29483 .cindex "DATA" "ACLs for"
29484 Two ACLs are associated with the DATA command, because it is two-stage
29485 command, with two responses being sent to the client.
29486 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29487 is obeyed. This gives you control after all the RCPT commands, but before
29488 the message itself is received. It offers the opportunity to give a negative
29489 response to the DATA command before the data is transmitted. Header lines
29490 added by MAIL or RCPT ACLs are not visible at this time, but any that
29491 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29492
29493 You cannot test the contents of the message, for example, to verify addresses
29494 in the headers, at RCPT time or when the DATA command is received. Such
29495 tests have to appear in the ACL that is run after the message itself has been
29496 received, before the final response to the DATA command is sent. This is
29497 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29498 associated with the DATA command.
29499
29500 .cindex CHUNKING "BDAT command"
29501 .cindex BDAT "SMTP command"
29502 .cindex "RFC 3030" CHUNKING
29503 If CHUNKING was advertised and a BDAT command sequence is received,
29504 the &%acl_smtp_predata%& ACL is not run.
29505 . XXX why not?  It should be possible, for the first BDAT.
29506 The &%acl_smtp_data%& is run after the last BDAT command and all of
29507 the data specified is received.
29508
29509 For both of these ACLs, it is not possible to reject individual recipients. An
29510 error response rejects the entire message. Unfortunately, it is known that some
29511 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29512 before or after the data) correctly &-- they keep the message on their queues
29513 and try again later, but that is their problem, though it does waste some of
29514 your resources.
29515
29516 The &%acl_smtp_data%& ACL is run after
29517 the &%acl_smtp_data_prdr%&,
29518 the &%acl_smtp_dkim%&
29519 and the &%acl_smtp_mime%& ACLs.
29520
29521 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29522 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29523 enabled (which is the default).
29524
29525 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29526 received, and is executed for each DKIM signature found in a message.  If not
29527 otherwise specified, the default action is to accept.
29528
29529 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29530
29531 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29532
29533
29534 .section "The SMTP MIME ACL" "SECID194"
29535 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29536 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29537
29538 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29539
29540
29541 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29542 .cindex "PRDR" "ACL for"
29543 .oindex "&%prdr_enable%&"
29544 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29545 with PRDR support enabled (which is the default).
29546 It becomes active only when the PRDR feature is negotiated between
29547 client and server for a message, and more than one recipient
29548 has been accepted.
29549
29550 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29551 has been received, and is executed once for each recipient of the message
29552 with &$local_part$& and &$domain$& valid.
29553 The test may accept, defer or deny for individual recipients.
29554 The &%acl_smtp_data%& will still be called after this ACL and
29555 can reject the message overall, even if this ACL has accepted it
29556 for some or all recipients.
29557
29558 PRDR may be used to support per-user content filtering.  Without it
29559 one must defer any recipient after the first that has a different
29560 content-filter configuration.  With PRDR, the RCPT-time check
29561 .cindex "PRDR" "variable for"
29562 for this can be disabled when the variable &$prdr_requested$&
29563 is &"yes"&.
29564 Any required difference in behaviour of the main DATA-time
29565 ACL should however depend on the PRDR-time ACL having run, as Exim
29566 will avoid doing so in some situations (e.g. single-recipient mails).
29567
29568 See also the &%prdr_enable%& global option
29569 and the &%hosts_try_prdr%& smtp transport option.
29570
29571 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29572 If the ACL is not defined, processing completes as if
29573 the feature was not requested by the client.
29574
29575 .section "The QUIT ACL" "SECTQUITACL"
29576 .cindex "QUIT, ACL for"
29577 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29578 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29579 does not in fact control any access.
29580 For this reason, it may only accept
29581 or warn as its final result.
29582
29583 This ACL can be used for tasks such as custom logging at the end of an SMTP
29584 session. For example, you can use ACL variables in other ACLs to count
29585 messages, recipients, etc., and log the totals at QUIT time using one or
29586 more &%logwrite%& modifiers on a &%warn%& verb.
29587
29588 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29589 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29590
29591 You do not need to have a final &%accept%&, but if you do, you can use a
29592 &%message%& modifier to specify custom text that is sent as part of the 221
29593 response to QUIT.
29594
29595 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29596 failure (for example, failure to open a log file, or when Exim is bombing out
29597 because it has detected an unrecoverable error), all SMTP commands from the
29598 client are given temporary error responses until QUIT is received or the
29599 connection is closed. In these special cases, the QUIT ACL does not run.
29600
29601
29602 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29603 .vindex &$acl_smtp_notquit$&
29604 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29605 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29606 trouble, such as being unable to write to its log files, this ACL is not run,
29607 because it might try to do things (such as write to log files) that make the
29608 situation even worse.
29609
29610 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29611 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29612 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29613 and &%warn%&.
29614
29615 .vindex &$smtp_notquit_reason$&
29616 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29617 to a string that indicates the reason for the termination of the SMTP
29618 connection. The possible values are:
29619 .table2
29620 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29621 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29622 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29623 .irow &`connection-lost`&          "The SMTP connection has been lost"
29624 .irow &`data-timeout`&             "Timeout while reading message data"
29625 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29626 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29627 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29628 .irow &`synchronization-error`&    "SMTP synchronization error"
29629 .irow &`tls-failed`&               "TLS failed to start"
29630 .endtable
29631 In most cases when an SMTP connection is closed without having received QUIT,
29632 Exim sends an SMTP response message before actually closing the connection.
29633 With the exception of the &`acl-drop`& case, the default message can be
29634 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29635 &%drop%& verb in another ACL, it is the message from the other ACL that is
29636 used.
29637
29638
29639 .section "Finding an ACL to use" "SECID195"
29640 .cindex "&ACL;" "finding which to use"
29641 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29642 you can use different ACLs in different circumstances. For example,
29643 .code
29644 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29645                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29646 .endd
29647 In the default configuration file there are some example settings for
29648 providing an RFC 4409 message &"submission"& service on port 587 and
29649 an RFC 8314 &"submissions"& service on port 465. You can use a string
29650 expansion like this to choose an ACL for MUAs on these ports which is
29651 more appropriate for this purpose than the default ACL on port 25.
29652
29653 The expanded string does not have to be the name of an ACL in the
29654 configuration file; there are other possibilities. Having expanded the
29655 string, Exim searches for an ACL as follows:
29656
29657 .ilist
29658 If the string begins with a slash, Exim uses it as a filename, and reads its
29659 contents as an ACL. The lines are processed in the same way as lines in the
29660 Exim configuration file. In particular, continuation lines are supported, blank
29661 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29662 If the file does not exist or cannot be read, an error occurs (typically
29663 causing a temporary failure of whatever caused the ACL to be run). For example:
29664 .code
29665 acl_smtp_data = /etc/acls/\
29666   ${lookup{$sender_host_address}lsearch\
29667   {/etc/acllist}{$value}{default}}
29668 .endd
29669 This looks up an ACL file to use on the basis of the host's IP address, falling
29670 back to a default if the lookup fails. If an ACL is successfully read from a
29671 file, it is retained in memory for the duration of the Exim process, so that it
29672 can be re-used without having to re-read the file.
29673 .next
29674 If the string does not start with a slash, and does not contain any spaces,
29675 Exim searches the ACL section of the configuration for an ACL whose name
29676 matches the string.
29677 .next
29678 If no named ACL is found, or if the string contains spaces, Exim parses
29679 the string as an inline ACL. This can save typing in cases where you just
29680 want to have something like
29681 .code
29682 acl_smtp_vrfy = accept
29683 .endd
29684 in order to allow free use of the VRFY command. Such a string may contain
29685 newlines; it is processed in the same way as an ACL that is read from a file.
29686 .endlist
29687
29688
29689
29690
29691 .section "ACL return codes" "SECID196"
29692 .cindex "&ACL;" "return codes"
29693 Except for the QUIT ACL, which does not affect the SMTP return code (see
29694 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29695 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29696 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29697 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29698 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29699 This also causes a 4&'xx'& return code.
29700
29701 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29702 &"deny"&, because there is no mechanism for passing temporary errors to the
29703 submitters of non-SMTP messages.
29704
29705
29706 ACLs that are relevant to message reception may also return &"discard"&. This
29707 has the effect of &"accept"&, but causes either the entire message or an
29708 individual recipient address to be discarded. In other words, it is a
29709 blackholing facility. Use it with care.
29710
29711 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29712 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29713 RCPT ACL is to discard just the one recipient address. If there are no
29714 recipients left when the message's data is received, the DATA ACL is not
29715 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29716 remaining recipients. The &"discard"& return is not permitted for the
29717 &%acl_smtp_predata%& ACL.
29718
29719 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29720 is done on the address and the result determines the SMTP response.
29721
29722
29723 .cindex "&[local_scan()]& function" "when all recipients discarded"
29724 The &[local_scan()]& function is always run, even if there are no remaining
29725 recipients; it may create new recipients.
29726
29727
29728
29729 .section "Unset ACL options" "SECID197"
29730 .cindex "&ACL;" "unset options"
29731 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29732 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29733 not defined at all. For any defined ACL, the default action when control
29734 reaches the end of the ACL statements is &"deny"&.
29735
29736 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29737 these two are ACLs that are used only for their side effects. They cannot be
29738 used to accept or reject anything.
29739
29740 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29741 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29742 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29743 when the ACL is not defined is &"accept"&.
29744
29745 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29746 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29747 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29748 messages over an SMTP connection. For an example, see the ACL in the default
29749 configuration file.
29750
29751
29752
29753
29754 .section "Data for message ACLs" "SECID198"
29755 .cindex "&ACL;" "data for message ACL"
29756 .vindex &$domain$&
29757 .vindex &$local_part$&
29758 .vindex &$sender_address$&
29759 .vindex &$sender_host_address$&
29760 .vindex &$smtp_command$&
29761 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29762 that contain information about the host and the message's sender (for example,
29763 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29764 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29765 &$local_part$& are set from the argument address. The entire SMTP command
29766 is available in &$smtp_command$&.
29767
29768 When an ACL for the AUTH parameter of MAIL is running, the variables that
29769 contain information about the host are set, but &$sender_address$& is not yet
29770 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29771 how it is used.
29772
29773 .vindex "&$message_size$&"
29774 The &$message_size$& variable is set to the value of the SIZE parameter on
29775 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29776 that parameter is not given. The value is updated to the true message size by
29777 the time the final DATA ACL is run (after the message data has been
29778 received).
29779
29780 .vindex "&$rcpt_count$&"
29781 .vindex "&$recipients_count$&"
29782 The &$rcpt_count$& variable increases by one for each RCPT command received.
29783 The &$recipients_count$& variable increases by one each time a RCPT command is
29784 accepted, so while an ACL for RCPT is being processed, it contains the number
29785 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29786 &$rcpt_count$& contains the total number of RCPT commands, and
29787 &$recipients_count$& contains the total number of accepted recipients.
29788
29789
29790
29791
29792
29793 .section "Data for non-message ACLs" "SECTdatfornon"
29794 .cindex "&ACL;" "data for non-message ACL"
29795 .vindex &$smtp_command_argument$&
29796 .vindex &$smtp_command$&
29797 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29798 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29799 and the entire SMTP command is available in &$smtp_command$&.
29800 These variables can be tested using a &%condition%& condition. For example,
29801 here is an ACL for use with AUTH, which insists that either the session is
29802 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29803 does not permit authentication methods that use cleartext passwords on
29804 unencrypted connections.
29805 .code
29806 acl_check_auth:
29807   accept encrypted = *
29808   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29809                      {CRAM-MD5}}
29810   deny   message   = TLS encryption or CRAM-MD5 required
29811 .endd
29812 (Another way of applying this restriction is to arrange for the authenticators
29813 that use cleartext passwords not to be advertised when the connection is not
29814 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29815 option to do this.)
29816
29817
29818
29819 .section "Format of an ACL" "SECID199"
29820 .cindex "&ACL;" "format of"
29821 .cindex "&ACL;" "verbs, definition of"
29822 An individual ACL consists of a number of statements. Each statement starts
29823 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29824 Modifiers can change the way the verb operates, define error and log messages,
29825 set variables, insert delays, and vary the processing of accepted messages.
29826
29827 If all the conditions are met, the verb is obeyed. The same condition may be
29828 used (with different arguments) more than once in the same statement. This
29829 provides a means of specifying an &"and"& conjunction between conditions. For
29830 example:
29831 .code
29832 deny  dnslists = list1.example
29833       dnslists = list2.example
29834 .endd
29835 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29836 the conditions and modifiers when it reaches a condition that fails. What
29837 happens then depends on the verb (and in one case, on a special modifier). Not
29838 all the conditions make sense at every testing point. For example, you cannot
29839 test a sender address in the ACL that is run for a VRFY command.
29840
29841
29842 .section "ACL verbs" "SECID200"
29843 The ACL verbs are as follows:
29844
29845 .ilist
29846 .cindex "&%accept%& ACL verb"
29847 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29848 of the conditions are not met, what happens depends on whether &%endpass%&
29849 appears among the conditions (for syntax see below). If the failing condition
29850 is before &%endpass%&, control is passed to the next ACL statement; if it is
29851 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29852 check a RCPT command:
29853 .code
29854 accept domains = +local_domains
29855        endpass
29856        verify = recipient
29857 .endd
29858 If the recipient domain does not match the &%domains%& condition, control
29859 passes to the next statement. If it does match, the recipient is verified, and
29860 the command is accepted if verification succeeds. However, if verification
29861 fails, the ACL yields &"deny"&, because the failing condition is after
29862 &%endpass%&.
29863
29864 The &%endpass%& feature has turned out to be confusing to many people, so its
29865 use is not recommended nowadays. It is always possible to rewrite an ACL so
29866 that &%endpass%& is not needed, and it is no longer used in the default
29867 configuration.
29868
29869 .cindex "&%message%& ACL modifier" "with &%accept%&"
29870 If a &%message%& modifier appears on an &%accept%& statement, its action
29871 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29872 (when an &%accept%& verb either accepts or passes control to the next
29873 statement), &%message%& can be used to vary the message that is sent when an
29874 SMTP command is accepted. For example, in a RCPT ACL you could have:
29875 .display
29876 &`accept  `&<&'some conditions'&>
29877 &`        message = OK, I will allow you through today`&
29878 .endd
29879 You can specify an SMTP response code, optionally followed by an &"extended
29880 response code"& at the start of the message, but the first digit must be the
29881 same as would be sent by default, which is 2 for an &%accept%& verb.
29882
29883 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29884 an error message that is used when access is denied. This behaviour is retained
29885 for backward compatibility, but current &"best practice"& is to avoid the use
29886 of &%endpass%&.
29887
29888
29889 .next
29890 .cindex "&%defer%& ACL verb"
29891 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29892 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29893 &%defer%& is the same as &%deny%&, because there is no way of sending a
29894 temporary error. For a RCPT command, &%defer%& is much the same as using a
29895 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29896 be used in any ACL, and even for a recipient it might be a simpler approach.
29897
29898
29899 .next
29900 .cindex "&%deny%& ACL verb"
29901 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29902 the conditions are not met, control is passed to the next ACL statement. For
29903 example,
29904 .code
29905 deny dnslists = blackholes.mail-abuse.org
29906 .endd
29907 rejects commands from hosts that are on a DNS black list.
29908
29909
29910 .next
29911 .cindex "&%discard%& ACL verb"
29912 &%discard%&: This verb behaves like &%accept%&, except that it returns
29913 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29914 that are concerned with receiving messages. When all the conditions are true,
29915 the sending entity receives a &"success"& response. However, &%discard%& causes
29916 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29917 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29918 message's recipients are discarded. Recipients that are discarded before DATA
29919 do not appear in the log line when the &%received_recipients%& log selector is set.
29920
29921 If the &%log_message%& modifier is set when &%discard%& operates,
29922 its contents are added to the line that is automatically written to the log.
29923 The &%message%& modifier operates exactly as it does for &%accept%&.
29924
29925
29926 .next
29927 .cindex "&%drop%& ACL verb"
29928 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29929 forcibly closed after the 5&'xx'& error message has been sent. For example:
29930 .code
29931 drop   message   = I don't take more than 20 RCPTs
29932        condition = ${if > {$rcpt_count}{20}}
29933 .endd
29934 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29935 The connection is always dropped after sending a 550 response.
29936
29937 .next
29938 .cindex "&%require%& ACL verb"
29939 &%require%&: If all the conditions are met, control is passed to the next ACL
29940 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29941 example, when checking a RCPT command,
29942 .code
29943 require message = Sender did not verify
29944         verify  = sender
29945 .endd
29946 passes control to subsequent statements only if the message's sender can be
29947 verified. Otherwise, it rejects the command. Note the positioning of the
29948 &%message%& modifier, before the &%verify%& condition. The reason for this is
29949 discussed in section &<<SECTcondmodproc>>&.
29950
29951 .next
29952 .cindex "&%warn%& ACL verb"
29953 &%warn%&: If all the conditions are true, a line specified by the
29954 &%log_message%& modifier is written to Exim's main log. Control always passes
29955 to the next ACL statement. If any condition is false, the log line is not
29956 written. If an identical log line is requested several times in the same
29957 message, only one copy is actually written to the log. If you want to force
29958 duplicates to be written, use the &%logwrite%& modifier instead.
29959
29960 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29961 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29962 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29963 first failing condition. There is more about adding header lines in section
29964 &<<SECTaddheadacl>>&.
29965
29966 If any condition on a &%warn%& statement cannot be completed (that is, there is
29967 some sort of defer), the log line specified by &%log_message%& is not written.
29968 This does not include the case of a forced failure from a lookup, which
29969 is considered to be a successful completion. After a defer, no further
29970 conditions or modifiers in the &%warn%& statement are processed. The incident
29971 is logged, and the ACL continues to be processed, from the next statement
29972 onwards.
29973
29974
29975 .vindex "&$acl_verify_message$&"
29976 When one of the &%warn%& conditions is an address verification that fails, the
29977 text of the verification failure message is in &$acl_verify_message$&. If you
29978 want this logged, you must set it up explicitly. For example:
29979 .code
29980 warn   !verify = sender
29981        log_message = sender verify failed: $acl_verify_message
29982 .endd
29983 .endlist
29984
29985 At the end of each ACL there is an implicit unconditional &%deny%&.
29986
29987 As you can see from the examples above, the conditions and modifiers are
29988 written one to a line, with the first one on the same line as the verb, and
29989 subsequent ones on following lines. If you have a very long condition, you can
29990 continue it onto several physical lines by the usual backslash continuation
29991 mechanism. It is conventional to align the conditions vertically.
29992
29993
29994
29995 .section "ACL variables" "SECTaclvariables"
29996 .cindex "&ACL;" "variables"
29997 There are some special variables that can be set during ACL processing. They
29998 can be used to pass information between different ACLs, different invocations
29999 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30000 transports, and filters that are used to deliver a message. The names of these
30001 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30002 an underscore, but the remainder of the name can be any sequence of
30003 alphanumeric characters and underscores that you choose. There is no limit on
30004 the number of ACL variables. The two sets act as follows:
30005 .ilist
30006 The values of those variables whose names begin with &$acl_c$& persist
30007 throughout an SMTP connection. They are never reset. Thus, a value that is set
30008 while receiving one message is still available when receiving the next message
30009 on the same SMTP connection.
30010 .next
30011 The values of those variables whose names begin with &$acl_m$& persist only
30012 while a message is being received. They are reset afterwards. They are also
30013 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30014 .endlist
30015
30016 When a message is accepted, the current values of all the ACL variables are
30017 preserved with the message and are subsequently made available at delivery
30018 time. The ACL variables are set by a modifier called &%set%&. For example:
30019 .code
30020 accept hosts = whatever
30021        set acl_m4 = some value
30022 accept authenticated = *
30023        set acl_c_auth = yes
30024 .endd
30025 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30026 be set. If you want to set a variable without taking any action, you can use a
30027 &%warn%& verb without any other modifiers or conditions.
30028
30029 .oindex &%strict_acl_vars%&
30030 What happens if a syntactically valid but undefined ACL variable is
30031 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30032 false (the default), an empty string is substituted; if it is true, an
30033 error is generated.
30034
30035 Versions of Exim before 4.64 have a limited set of numbered variables, but
30036 their names are compatible, so there is no problem with upgrading.
30037
30038
30039 .section "Condition and modifier processing" "SECTcondmodproc"
30040 .cindex "&ACL;" "conditions; processing"
30041 .cindex "&ACL;" "modifiers; processing"
30042 An exclamation mark preceding a condition negates its result. For example:
30043 .code
30044 deny   domains = *.dom.example
30045       !verify  = recipient
30046 .endd
30047 causes the ACL to return &"deny"& if the recipient domain ends in
30048 &'dom.example'& and the recipient address cannot be verified. Sometimes
30049 negation can be used on the right-hand side of a condition. For example, these
30050 two statements are equivalent:
30051 .code
30052 deny  hosts = !192.168.3.4
30053 deny !hosts =  192.168.3.4
30054 .endd
30055 However, for many conditions (&%verify%& being a good example), only left-hand
30056 side negation of the whole condition is possible.
30057
30058 The arguments of conditions and modifiers are expanded. A forced failure
30059 of an expansion causes a condition to be ignored, that is, it behaves as if the
30060 condition is true. Consider these two statements:
30061 .code
30062 accept  senders = ${lookup{$host_name}lsearch\
30063                   {/some/file}{$value}fail}
30064 accept  senders = ${lookup{$host_name}lsearch\
30065                   {/some/file}{$value}{}}
30066 .endd
30067 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30068 the returned list is searched, but if the lookup fails the behaviour is
30069 different in the two cases. The &%fail%& in the first statement causes the
30070 condition to be ignored, leaving no further conditions. The &%accept%& verb
30071 therefore succeeds. The second statement, however, generates an empty list when
30072 the lookup fails. No sender can match an empty list, so the condition fails,
30073 and therefore the &%accept%& also fails.
30074
30075 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30076 specify actions that are taken as the conditions for a statement are checked;
30077 others specify text for messages that are used when access is denied or a
30078 warning is generated. The &%control%& modifier affects the way an incoming
30079 message is handled.
30080
30081 The positioning of the modifiers in an ACL statement is important, because the
30082 processing of a verb ceases as soon as its outcome is known. Only those
30083 modifiers that have already been encountered will take effect. For example,
30084 consider this use of the &%message%& modifier:
30085 .code
30086 require message = Can't verify sender
30087         verify  = sender
30088         message = Can't verify recipient
30089         verify  = recipient
30090         message = This message cannot be used
30091 .endd
30092 If sender verification fails, Exim knows that the result of the statement is
30093 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30094 so its text is used as the error message. If sender verification succeeds, but
30095 recipient verification fails, the second message is used. If recipient
30096 verification succeeds, the third message becomes &"current"&, but is never used
30097 because there are no more conditions to cause failure.
30098
30099 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30100 modifier that is used, because all the conditions must be true for rejection to
30101 happen. Specifying more than one &%message%& modifier does not make sense, and
30102 the message can even be specified after all the conditions. For example:
30103 .code
30104 deny   hosts = ...
30105       !senders = *@my.domain.example
30106        message = Invalid sender from client host
30107 .endd
30108 The &"deny"& result does not happen until the end of the statement is reached,
30109 by which time Exim has set up the message.
30110
30111
30112
30113 .section "ACL modifiers" "SECTACLmodi"
30114 .cindex "&ACL;" "modifiers; list of"
30115 The ACL modifiers are as follows:
30116
30117 .vlist
30118 .vitem &*add_header*&&~=&~<&'text'&>
30119 This modifier specifies one or more header lines that are to be added to an
30120 incoming message, assuming, of course, that the message is ultimately
30121 accepted. For details, see section &<<SECTaddheadacl>>&.
30122
30123 .vitem &*continue*&&~=&~<&'text'&>
30124 .cindex "&%continue%& ACL modifier"
30125 .cindex "database" "updating in ACL"
30126 This modifier does nothing of itself, and processing of the ACL always
30127 continues with the next condition or modifier. The value of &%continue%& is in
30128 the side effects of expanding its argument. Typically this could be used to
30129 update a database. It is really just a syntactic tidiness, to avoid having to
30130 write rather ugly lines like this:
30131 .display
30132 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30133 .endd
30134 Instead, all you need is
30135 .display
30136 &`continue = `&<&'some expansion'&>
30137 .endd
30138
30139 .vitem &*control*&&~=&~<&'text'&>
30140 .cindex "&%control%& ACL modifier"
30141 This modifier affects the subsequent processing of the SMTP connection or of an
30142 incoming message that is accepted. The effect of the first type of control
30143 lasts for the duration of the connection, whereas the effect of the second type
30144 lasts only until the current message has been received. The message-specific
30145 controls always apply to the whole message, not to individual recipients,
30146 even if the &%control%& modifier appears in a RCPT ACL.
30147
30148 As there are now quite a few controls that can be applied, they are described
30149 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30150 in several different ways. For example:
30151
30152 . ==== As this is a nested list, any displays it contains must be indented
30153 . ==== as otherwise they are too far to the left. That comment applies only
30154 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30155 . ==== way.
30156
30157 .ilist
30158 It can be at the end of an &%accept%& statement:
30159 .code
30160     accept  ...some conditions
30161             control = queue
30162 .endd
30163 In this case, the control is applied when this statement yields &"accept"&, in
30164 other words, when the conditions are all true.
30165
30166 .next
30167 It can be in the middle of an &%accept%& statement:
30168 .code
30169     accept  ...some conditions...
30170             control = queue
30171             ...some more conditions...
30172 .endd
30173 If the first set of conditions are true, the control is applied, even if the
30174 statement does not accept because one of the second set of conditions is false.
30175 In this case, some subsequent statement must yield &"accept"& for the control
30176 to be relevant.
30177
30178 .next
30179 It can be used with &%warn%& to apply the control, leaving the
30180 decision about accepting or denying to a subsequent verb. For
30181 example:
30182 .code
30183     warn    ...some conditions...
30184             control = freeze
30185     accept  ...
30186 .endd
30187 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30188 &%logwrite%&, so it does not add anything to the message and does not write a
30189 log entry.
30190
30191 .next
30192 If you want to apply a control unconditionally, you can use it with a
30193 &%require%& verb. For example:
30194 .code
30195     require  control = no_multiline_responses
30196 .endd
30197 .endlist
30198
30199 .vitem &*delay*&&~=&~<&'time'&>
30200 .cindex "&%delay%& ACL modifier"
30201 .oindex "&%-bh%&"
30202 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30203 the time interval before proceeding. However, when testing Exim using the
30204 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30205 output instead). The time is given in the usual Exim notation, and the delay
30206 happens as soon as the modifier is processed. In an SMTP session, pending
30207 output is flushed before the delay is imposed.
30208
30209 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30210 example:
30211 .code
30212 deny    ...some conditions...
30213         delay = 30s
30214 .endd
30215 The delay happens if all the conditions are true, before the statement returns
30216 &"deny"&. Compare this with:
30217 .code
30218 deny    delay = 30s
30219         ...some conditions...
30220 .endd
30221 which waits for 30s before processing the conditions. The &%delay%& modifier
30222 can also be used with &%warn%& and together with &%control%&:
30223 .code
30224 warn    ...some conditions...
30225         delay = 2m
30226         control = freeze
30227 accept  ...
30228 .endd
30229
30230 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30231 responses to several commands are no longer buffered and sent in one packet (as
30232 they would normally be) because all output is flushed before imposing the
30233 delay. This optimization is disabled so that a number of small delays do not
30234 appear to the client as one large aggregated delay that might provoke an
30235 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30236 using a &%control%& modifier to set &%no_delay_flush%&.
30237
30238
30239 .vitem &*endpass*&
30240 .cindex "&%endpass%& ACL modifier"
30241 This modifier, which has no argument, is recognized only in &%accept%& and
30242 &%discard%& statements. It marks the boundary between the conditions whose
30243 failure causes control to pass to the next statement, and the conditions whose
30244 failure causes the ACL to return &"deny"&. This concept has proved to be
30245 confusing to some people, so the use of &%endpass%& is no longer recommended as
30246 &"best practice"&. See the description of &%accept%& above for more details.
30247
30248
30249 .vitem &*log_message*&&~=&~<&'text'&>
30250 .cindex "&%log_message%& ACL modifier"
30251 This modifier sets up a message that is used as part of the log message if the
30252 ACL denies access or a &%warn%& statement's conditions are true. For example:
30253 .code
30254 require log_message = wrong cipher suite $tls_in_cipher
30255         encrypted   = DES-CBC3-SHA
30256 .endd
30257 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30258 example:
30259 .display
30260 &`discard `&<&'some conditions'&>
30261 &`        log_message = Discarded $local_part@$domain because...`&
30262 .endd
30263 When access is denied, &%log_message%& adds to any underlying error message
30264 that may exist because of a condition failure. For example, while verifying a
30265 recipient address, a &':fail:'& redirection might have already set up a
30266 message.
30267
30268 The message may be defined before the conditions to which it applies, because
30269 the string expansion does not happen until Exim decides that access is to be
30270 denied. This means that any variables that are set by the condition are
30271 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30272 variables are set after a DNS black list lookup succeeds. If the expansion of
30273 &%log_message%& fails, or if the result is an empty string, the modifier is
30274 ignored.
30275
30276 .vindex "&$acl_verify_message$&"
30277 If you want to use a &%warn%& statement to log the result of an address
30278 verification, you can use &$acl_verify_message$& to include the verification
30279 error message.
30280
30281 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30282 the start of the logged message. If the same warning log message is requested
30283 more than once while receiving  a single email message, only one copy is
30284 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30285 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30286 is logged for a successful &%warn%& statement.
30287
30288 If &%log_message%& is not present and there is no underlying error message (for
30289 example, from the failure of address verification), but &%message%& is present,
30290 the &%message%& text is used for logging rejections. However, if any text for
30291 logging contains newlines, only the first line is logged. In the absence of
30292 both &%log_message%& and &%message%&, a default built-in message is used for
30293 logging rejections.
30294
30295
30296 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30297 .cindex "&%log_reject_target%& ACL modifier"
30298 .cindex "logging in ACL" "specifying which log"
30299 This modifier makes it possible to specify which logs are used for messages
30300 about ACL rejections. Its argument is a colon-separated list of words that can
30301 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30302 may be empty, in which case a rejection is not logged at all. For example, this
30303 ACL fragment writes no logging information when access is denied:
30304 .display
30305 &`deny `&<&'some conditions'&>
30306 &`     log_reject_target =`&
30307 .endd
30308 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30309 permanent and temporary rejections. Its effect lasts for the rest of the
30310 current ACL.
30311
30312
30313 .vitem &*logwrite*&&~=&~<&'text'&>
30314 .cindex "&%logwrite%& ACL modifier"
30315 .cindex "logging in ACL" "immediate"
30316 This modifier writes a message to a log file as soon as it is encountered when
30317 processing an ACL. (Compare &%log_message%&, which, except in the case of
30318 &%warn%& and &%discard%&, is used only if the ACL statement denies
30319 access.) The &%logwrite%& modifier can be used to log special incidents in
30320 ACLs. For example:
30321 .display
30322 &`accept `&<&'some special conditions'&>
30323 &`       control  = freeze`&
30324 &`       logwrite = froze message because ...`&
30325 .endd
30326 By default, the message is written to the main log. However, it may begin
30327 with a colon, followed by a comma-separated list of log names, and then
30328 another colon, to specify exactly which logs are to be written. For
30329 example:
30330 .code
30331 logwrite = :main,reject: text for main and reject logs
30332 logwrite = :panic: text for panic log only
30333 .endd
30334
30335
30336 .vitem &*message*&&~=&~<&'text'&>
30337 .cindex "&%message%& ACL modifier"
30338 This modifier sets up a text string that is expanded and used as a response
30339 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30340 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30341 there is some complication if &%endpass%& is involved; see the description of
30342 &%accept%& for details.)
30343
30344 The expansion of the message happens at the time Exim decides that the ACL is
30345 to end, not at the time it processes &%message%&. If the expansion fails, or
30346 generates an empty string, the modifier is ignored. Here is an example where
30347 &%message%& must be specified first, because the ACL ends with a rejection if
30348 the &%hosts%& condition fails:
30349 .code
30350 require  message = Host not recognized
30351          hosts = 10.0.0.0/8
30352 .endd
30353 (Once a condition has failed, no further conditions or modifiers are
30354 processed.)
30355
30356 .cindex "SMTP" "error codes"
30357 .oindex "&%smtp_banner%&
30358 For ACLs that are triggered by SMTP commands, the message is returned as part
30359 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30360 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30361 is accepted. In the case of the connect ACL, accepting with a message modifier
30362 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30363 accept message may not contain more than one line (otherwise it will be
30364 truncated at the first newline and a panic logged), and it cannot affect the
30365 EHLO options.
30366
30367 When SMTP is involved, the message may begin with an overriding response code,
30368 consisting of three digits optionally followed by an &"extended response code"&
30369 of the form &'n.n.n'&, each code being followed by a space. For example:
30370 .code
30371 deny  message = 599 1.2.3 Host not welcome
30372       hosts = 192.168.34.0/24
30373 .endd
30374 The first digit of the supplied response code must be the same as would be sent
30375 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30376 access, but for the predata ACL, note that the default success code is 354, not
30377 2&'xx'&.
30378
30379 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30380 the message modifier cannot override the 221 response code.
30381
30382 The text in a &%message%& modifier is literal; any quotes are taken as
30383 literals, but because the string is expanded, backslash escapes are processed
30384 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30385 response.
30386
30387 .vindex "&$acl_verify_message$&"
30388 For ACLs that are called by an &%acl =%& ACL condition, the message is
30389 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30390
30391 If &%message%& is used on a statement that verifies an address, the message
30392 specified overrides any message that is generated by the verification process.
30393 However, the original message is available in the variable
30394 &$acl_verify_message$&, so you can incorporate it into your message if you
30395 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30396 routers to be passed back as part of the SMTP response, you should either not
30397 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30398
30399 For compatibility with previous releases of Exim, a &%message%& modifier that
30400 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30401 modifier, but this usage is now deprecated. However, &%message%& acts only when
30402 all the conditions are true, wherever it appears in an ACL command, whereas
30403 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30404 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30405 effect.
30406
30407
30408 .vitem &*queue*&&~=&~<&'text'&>
30409 .cindex "&%queue%& ACL modifier"
30410 .cindex "named queues" "selecting in ACL"
30411 This modifier specifies the use of a named queue for spool files
30412 for the message.
30413 It can only be used before the message is received (i.e. not in
30414 the DATA ACL).
30415 This could be used, for example, for known high-volume burst sources
30416 of traffic, or for quarantine of messages.
30417 Separate queue-runner processes will be needed for named queues.
30418 If the text after expansion is empty, the default queue is used.
30419
30420
30421 .vitem &*remove_header*&&~=&~<&'text'&>
30422 This modifier specifies one or more header names in a colon-separated list
30423  that are to be removed from an incoming message, assuming, of course, that
30424 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30425
30426
30427 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30428 .cindex "&%set%& ACL modifier"
30429 This modifier puts a value into one of the ACL variables (see section
30430 &<<SECTaclvariables>>&).
30431
30432
30433 .vitem &*udpsend*&&~=&~<&'parameters'&>
30434 .cindex "UDP communications"
30435 This modifier sends a UDP packet, for purposes such as statistics
30436 collection or behaviour monitoring. The parameters are expanded, and
30437 the result of the expansion must be a colon-separated list consisting
30438 of a destination server, port number, and the packet contents. The
30439 server can be specified as a host name or IPv4 or IPv6 address. The
30440 separator can be changed with the usual angle bracket syntax. For
30441 example, you might want to collect information on which hosts connect
30442 when:
30443 .code
30444 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30445              $tod_zulu $sender_host_address
30446 .endd
30447 .endlist
30448
30449
30450
30451
30452 .section "Use of the control modifier" "SECTcontrols"
30453 .cindex "&%control%& ACL modifier"
30454 The &%control%& modifier supports the following settings:
30455
30456 .vlist
30457 .vitem &*control&~=&~allow_auth_unadvertised*&
30458 This modifier allows a client host to use the SMTP AUTH command even when it
30459 has not been advertised in response to EHLO. Furthermore, because there are
30460 apparently some really broken clients that do this, Exim will accept AUTH after
30461 HELO (rather than EHLO) when this control is set. It should be used only if you
30462 really need it, and you should limit its use to those broken clients that do
30463 not work without it. For example:
30464 .code
30465 warn hosts   = 192.168.34.25
30466      control = allow_auth_unadvertised
30467 .endd
30468 Normally, when an Exim server receives an AUTH command, it checks the name of
30469 the authentication mechanism that is given in the command to ensure that it
30470 matches an advertised mechanism. When this control is set, the check that a
30471 mechanism has been advertised is bypassed. Any configured mechanism can be used
30472 by the client. This control is permitted only in the connection and HELO ACLs.
30473
30474
30475 .vitem &*control&~=&~caseful_local_part*& &&&
30476        &*control&~=&~caselower_local_part*&
30477 .cindex "&ACL;" "case of local part in"
30478 .cindex "case of local parts"
30479 .vindex "&$local_part$&"
30480 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30481 (that is, during RCPT processing). By default, the contents of &$local_part$&
30482 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30483 any uppercase letters in the original local part are restored in &$local_part$&
30484 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30485 is encountered.
30486
30487 These controls affect only the current recipient. Moreover, they apply only to
30488 local part handling that takes place directly in the ACL (for example, as a key
30489 in lookups). If a test to verify the recipient is obeyed, the case-related
30490 handling of the local part during the verification is controlled by the router
30491 configuration (see the &%caseful_local_part%& generic router option).
30492
30493 This facility could be used, for example, to add a spam score to local parts
30494 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30495 spam score:
30496 .code
30497 warn  control = caseful_local_part
30498       set acl_m4 = ${eval:\
30499                      $acl_m4 + \
30500                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30501                     }
30502       control = caselower_local_part
30503 .endd
30504 Notice that we put back the lower cased version afterwards, assuming that
30505 is what is wanted for subsequent tests.
30506
30507
30508 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30509 .cindex "&ACL;" "cutthrough routing"
30510 .cindex "cutthrough" "requesting"
30511 This option requests delivery be attempted while the item is being received.
30512
30513 The option is usable in the RCPT ACL.
30514 If enabled for a message received via smtp and routed to an smtp transport,
30515 and only one transport, interface, destination host and port combination
30516 is used for all recipients of the message,
30517 then the delivery connection is made while the receiving connection is open
30518 and data is copied from one to the other.
30519
30520 An attempt to set this option for any recipient but the first
30521 for a mail will be quietly ignored.
30522 If a recipient-verify callout
30523 (with use_sender)
30524 connection is subsequently
30525 requested in the same ACL it is held open and used for
30526 any subsequent recipients and the data,
30527 otherwise one is made after the initial RCPT ACL completes.
30528
30529 Note that routers are used in verify mode,
30530 and cannot depend on content of received headers.
30531 Note also that headers cannot be
30532 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30533 Headers may be modified by routers (subject to the above) and transports.
30534 The &'Received-By:'& header is generated as soon as the body reception starts,
30535 rather than the traditional time after the full message is received;
30536 this will affect the timestamp.
30537
30538 All the usual ACLs are called; if one results in the message being
30539 rejected, all effort spent in delivery (including the costs on
30540 the ultimate destination) will be wasted.
30541 Note that in the case of data-time ACLs this includes the entire
30542 message body.
30543
30544 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30545 of outgoing messages is done, because it sends data to the ultimate destination
30546 before the entire message has been received from the source.
30547 It is not supported for messages received with the SMTP PRDR
30548 or CHUNKING
30549 options in use.
30550
30551 Should the ultimate destination system positively accept or reject the mail,
30552 a corresponding indication is given to the source system and nothing is queued.
30553 If the item is successfully delivered in cutthrough mode
30554 the delivery log lines are tagged with ">>" rather than "=>" and appear
30555 before the acceptance "<=" line.
30556
30557 If there is a temporary error the item is queued for later delivery in the
30558 usual fashion.
30559 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30560 to the control; the default value is &"spool"& and the alternate value
30561 &"pass"& copies an SMTP defer response from the target back to the initiator
30562 and does not queue the message.
30563 Note that this is independent of any recipient verify conditions in the ACL.
30564
30565 Delivery in this mode avoids the generation of a bounce mail to a
30566 (possibly faked)
30567 sender when the destination system is doing content-scan based rejection.
30568
30569
30570 .vitem &*control&~=&~debug/*&<&'options'&>
30571 .cindex "&ACL;" "enabling debug logging"
30572 .cindex "debugging" "enabling from an ACL"
30573 This control turns on debug logging, almost as though Exim had been invoked
30574 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30575 by default called &'debuglog'&.
30576 The filename can be adjusted with the &'tag'& option, which
30577 may access any variables already defined.  The logging may be adjusted with
30578 the &'opts'& option, which takes the same values as the &`-d`& command-line
30579 option.
30580 Logging started this way may be stopped, and the file removed,
30581 with the &'kill'& option.
30582 Some examples (which depend on variables that don't exist in all
30583 contexts):
30584 .code
30585       control = debug
30586       control = debug/tag=.$sender_host_address
30587       control = debug/opts=+expand+acl
30588       control = debug/tag=.$message_exim_id/opts=+expand
30589       control = debug/kill
30590 .endd
30591
30592
30593 .vitem &*control&~=&~dkim_disable_verify*&
30594 .cindex "disable DKIM verify"
30595 .cindex "DKIM" "disable verify"
30596 This control turns off DKIM verification processing entirely.  For details on
30597 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30598
30599
30600 .vitem &*control&~=&~dmarc_disable_verify*&
30601 .cindex "disable DMARC verify"
30602 .cindex "DMARC" "disable verify"
30603 This control turns off DMARC verification processing entirely.  For details on
30604 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30605
30606
30607 .vitem &*control&~=&~dscp/*&<&'value'&>
30608 .cindex "&ACL;" "setting DSCP value"
30609 .cindex "DSCP" "inbound"
30610 This option causes the DSCP value associated with the socket for the inbound
30611 connection to be adjusted to a given value, given as one of a number of fixed
30612 strings or to numeric value.
30613 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30614 Common values include &`throughput`&, &`mincost`&, and on newer systems
30615 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30616
30617 The outbound packets from Exim will be marked with this value in the header
30618 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30619 that these values will have any effect, not be stripped by networking
30620 equipment, or do much of anything without cooperation with your Network
30621 Engineer and those of all network operators between the source and destination.
30622
30623
30624 .vitem &*control&~=&~enforce_sync*& &&&
30625        &*control&~=&~no_enforce_sync*&
30626 .cindex "SMTP" "synchronization checking"
30627 .cindex "synchronization checking in SMTP"
30628 These controls make it possible to be selective about when SMTP synchronization
30629 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30630 state of the switch (it is true by default). See the description of this option
30631 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30632
30633 The effect of these two controls lasts for the remainder of the SMTP
30634 connection. They can appear in any ACL except the one for the non-SMTP
30635 messages. The most straightforward place to put them is in the ACL defined by
30636 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30637 before the first synchronization check. The expected use is to turn off the
30638 synchronization checks for badly-behaved hosts that you nevertheless need to
30639 work with.
30640
30641
30642 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30643 .cindex "fake defer"
30644 .cindex "defer, fake"
30645 This control works in exactly the same way as &%fakereject%& (described below)
30646 except that it causes an SMTP 450 response after the message data instead of a
30647 550 response. You must take care when using &%fakedefer%& because it causes the
30648 messages to be duplicated when the sender retries. Therefore, you should not
30649 use &%fakedefer%& if the message is to be delivered normally.
30650
30651 .vitem &*control&~=&~fakereject/*&<&'message'&>
30652 .cindex "fake rejection"
30653 .cindex "rejection, fake"
30654 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30655 words, only when an SMTP message is being received. If Exim accepts the
30656 message, instead the final 250 response, a 550 rejection message is sent.
30657 However, Exim proceeds to deliver the message as normal. The control applies
30658 only to the current message, not to any subsequent ones that may be received in
30659 the same SMTP connection.
30660
30661 The text for the 550 response is taken from the &%control%& modifier. If no
30662 message is supplied, the following is used:
30663 .code
30664 550-Your message has been rejected but is being
30665 550-kept for evaluation.
30666 550-If it was a legitimate message, it may still be
30667 550 delivered to the target recipient(s).
30668 .endd
30669 This facility should be used with extreme caution.
30670
30671 .vitem &*control&~=&~freeze*&
30672 .cindex "frozen messages" "forcing in ACL"
30673 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30674 other words, only when a message is being received. If the message is accepted,
30675 it is placed on Exim's queue and frozen. The control applies only to the
30676 current message, not to any subsequent ones that may be received in the same
30677 SMTP connection.
30678
30679 This modifier can optionally be followed by &`/no_tell`&. If the global option
30680 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30681 is told about the freezing), provided all the &*control=freeze*& modifiers that
30682 are obeyed for the current message have the &`/no_tell`& option.
30683
30684 .vitem &*control&~=&~no_delay_flush*&
30685 .cindex "SMTP" "output flushing, disabling for delay"
30686 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30687 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30688 use. This control, as long as it is encountered before the &%delay%& modifier,
30689 disables such output flushing.
30690
30691 .vitem &*control&~=&~no_callout_flush*&
30692 .cindex "SMTP" "output flushing, disabling for callout"
30693 Exim normally flushes SMTP output before performing a callout in an ACL, to
30694 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30695 use. This control, as long as it is encountered before the &%verify%& condition
30696 that causes the callout, disables such output flushing.
30697
30698 .vitem &*control&~=&~no_mbox_unspool*&
30699 This control is available when Exim is compiled with the content scanning
30700 extension. Content scanning may require a copy of the current message, or parts
30701 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30702 or spam scanner. Normally, such copies are deleted when they are no longer
30703 needed. If this control is set, the copies are not deleted. The control applies
30704 only to the current message, not to any subsequent ones that may be received in
30705 the same SMTP connection. It is provided for debugging purposes and is unlikely
30706 to be useful in production.
30707
30708 .vitem &*control&~=&~no_multiline_responses*&
30709 .cindex "multiline responses, suppressing"
30710 This control is permitted for any ACL except the one for non-SMTP messages.
30711 It seems that there are broken clients in use that cannot handle multiline
30712 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30713
30714 If this control is set, multiline SMTP responses from ACL rejections are
30715 suppressed. One way of doing this would have been to put out these responses as
30716 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30717 (&"use multiline responses for more"& it says &-- ha!), and some of the
30718 responses might get close to that. So this facility, which is after all only a
30719 sop to broken clients, is implemented by doing two very easy things:
30720
30721 .ilist
30722 Extra information that is normally output as part of a rejection caused by
30723 sender verification failure is omitted. Only the final line (typically &"sender
30724 verification failed"&) is sent.
30725 .next
30726 If a &%message%& modifier supplies a multiline response, only the first
30727 line is output.
30728 .endlist
30729
30730 The setting of the switch can, of course, be made conditional on the
30731 calling host. Its effect lasts until the end of the SMTP connection.
30732
30733 .vitem &*control&~=&~no_pipelining*&
30734 .cindex "PIPELINING" "suppressing advertising"
30735 This control turns off the advertising of the PIPELINING extension to SMTP in
30736 the current session. To be useful, it must be obeyed before Exim sends its
30737 response to an EHLO command. Therefore, it should normally appear in an ACL
30738 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30739 &%pipelining_advertise_hosts%&.
30740
30741 .new
30742 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
30743        &*control&~=&~queue_only*&
30744 .oindex "&%queue%&"
30745 .oindex "&%queue_only%&"
30746 .cindex "queueing incoming messages"
30747 .cindex queueing "forcing in ACL"
30748 .cindex "first pass routing"
30749 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30750 other words, only when a message is being received. If the message is accepted,
30751 it is placed on Exim's queue and left there for delivery by a subsequent queue
30752 runner.
30753 If used with no options set,
30754 no immediate delivery process is started. In other words, it has the
30755 effect as the &%queue_only%& global option or &'-odq'& command-line option.
30756
30757 If the &'first_pass_route'& option is given then
30758 the behaviour is like the command-line &'-oqds'& option;
30759 a delivery process is started which stops short of making
30760 any SMTP delivery.  The benefit is that the hints database will be updated for
30761 the message being waiting for a specific host, and a later queue run will be
30762 able to send all such messages on a single connection.
30763
30764 The control only applies to the current message, not to any subsequent ones that
30765  may be received in the same SMTP connection.
30766 .wen
30767
30768 .vitem &*control&~=&~submission/*&<&'options'&>
30769 .cindex "message" "submission"
30770 .cindex "submission mode"
30771 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30772 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30773 the current message is a submission from a local MUA. In this case, Exim
30774 operates in &"submission mode"&, and applies certain fixups to the message if
30775 necessary. For example, it adds a &'Date:'& header line if one is not present.
30776 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30777 late (the message has already been created).
30778
30779 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30780 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30781 submission mode; the available options for this control are described there.
30782 The control applies only to the current message, not to any subsequent ones
30783 that may be received in the same SMTP connection.
30784
30785 .vitem &*control&~=&~suppress_local_fixups*&
30786 .cindex "submission fixups, suppressing"
30787 This control applies to locally submitted (non TCP/IP) messages, and is the
30788 complement of &`control = submission`&. It disables the fixups that are
30789 normally applied to locally-submitted messages. Specifically:
30790
30791 .ilist
30792 Any &'Sender:'& header line is left alone (in this respect, it is a
30793 dynamic version of &%local_sender_retain%&).
30794 .next
30795 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30796 .next
30797 There is no check that &'From:'& corresponds to the actual sender.
30798 .endlist ilist
30799
30800 This control may be useful when a remotely-originated message is accepted,
30801 passed to some scanning program, and then re-submitted for delivery. It can be
30802 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30803 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30804 data is read.
30805
30806 &*Note:*& This control applies only to the current message, not to any others
30807 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30808
30809 .vitem &*control&~=&~utf8_downconvert*&
30810 This control enables conversion of UTF-8 in message addresses
30811 to a-label form.
30812 For details see section &<<SECTi18nMTA>>&.
30813 .endlist vlist
30814
30815
30816 .section "Summary of message fixup control" "SECTsummesfix"
30817 All four possibilities for message fixups can be specified:
30818
30819 .ilist
30820 Locally submitted, fixups applied: the default.
30821 .next
30822 Locally submitted, no fixups applied: use
30823 &`control = suppress_local_fixups`&.
30824 .next
30825 Remotely submitted, no fixups applied: the default.
30826 .next
30827 Remotely submitted, fixups applied: use &`control = submission`&.
30828 .endlist
30829
30830
30831
30832 .section "Adding header lines in ACLs" "SECTaddheadacl"
30833 .cindex "header lines" "adding in an ACL"
30834 .cindex "header lines" "position of added lines"
30835 .cindex "&%add_header%& ACL modifier"
30836 The &%add_header%& modifier can be used to add one or more extra header lines
30837 to an incoming message, as in this example:
30838 .code
30839 warn dnslists = sbl.spamhaus.org : \
30840                 dialup.mail-abuse.org
30841      add_header = X-blacklisted-at: $dnslist_domain
30842 .endd
30843 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30844 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30845 receiving a message). The message must ultimately be accepted for
30846 &%add_header%& to have any significant effect. You can use &%add_header%& with
30847 any ACL verb, including &%deny%& (though this is potentially useful only in a
30848 RCPT ACL).
30849
30850 Headers will not be added to the message if the modifier is used in
30851 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30852
30853 Leading and trailing newlines are removed from
30854 the data for the &%add_header%& modifier; if it then
30855 contains one or more newlines that
30856 are not followed by a space or a tab, it is assumed to contain multiple header
30857 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30858 front of any line that is not a valid header line.
30859
30860 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30861 They are added to the message before processing the DATA and MIME ACLs.
30862 However, if an identical header line is requested more than once, only one copy
30863 is actually added to the message. Further header lines may be accumulated
30864 during the DATA and MIME ACLs, after which they are added to the message, again
30865 with duplicates suppressed. Thus, it is possible to add two identical header
30866 lines to an SMTP message, but only if one is added before DATA and one after.
30867 In the case of non-SMTP messages, new headers are accumulated during the
30868 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30869 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30870 are included in the entry that is written to the reject log.
30871
30872 .cindex "header lines" "added; visibility of"
30873 Header lines are not visible in string expansions
30874 of message headers
30875 until they are added to the
30876 message. It follows that header lines defined in the MAIL, RCPT, and predata
30877 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30878 header lines that are added by the DATA or MIME ACLs are not visible in those
30879 ACLs. Because of this restriction, you cannot use header lines as a way of
30880 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30881 this, you can use ACL variables, as described in section
30882 &<<SECTaclvariables>>&.
30883
30884 The list of headers yet to be added is given by the &%$headers_added%& variable.
30885
30886 The &%add_header%& modifier acts immediately as it is encountered during the
30887 processing of an ACL. Notice the difference between these two cases:
30888 .display
30889 &`accept add_header = ADDED: some text`&
30890 &`       `&<&'some condition'&>
30891
30892 &`accept `&<&'some condition'&>
30893 &`       add_header = ADDED: some text`&
30894 .endd
30895 In the first case, the header line is always added, whether or not the
30896 condition is true. In the second case, the header line is added only if the
30897 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30898 ACL statement. All those that are encountered before a condition fails are
30899 honoured.
30900
30901 .cindex "&%warn%& ACL verb"
30902 For compatibility with previous versions of Exim, a &%message%& modifier for a
30903 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30904 effect only if all the conditions are true, even if it appears before some of
30905 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30906 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30907 are present on a &%warn%& verb, both are processed according to their
30908 specifications.
30909
30910 By default, new header lines are added to a message at the end of the existing
30911 header lines. However, you can specify that any particular header line should
30912 be added right at the start (before all the &'Received:'& lines), immediately
30913 after the first block of &'Received:'& lines, or immediately before any line
30914 that is not a &'Received:'& or &'Resent-something:'& header.
30915
30916 This is done by specifying &":at_start:"&, &":after_received:"&, or
30917 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30918 header line, respectively. (Header text cannot start with a colon, as there has
30919 to be a header name first.) For example:
30920 .code
30921 warn add_header = \
30922        :after_received:X-My-Header: something or other...
30923 .endd
30924 If more than one header line is supplied in a single &%add_header%& modifier,
30925 each one is treated independently and can therefore be placed differently. If
30926 you add more than one line at the start, or after the Received: block, they end
30927 up in reverse order.
30928
30929 &*Warning*&: This facility currently applies only to header lines that are
30930 added in an ACL. It does NOT work for header lines that are added in a
30931 system filter or in a router or transport.
30932
30933
30934
30935 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30936 .cindex "header lines" "removing in an ACL"
30937 .cindex "header lines" "position of removed lines"
30938 .cindex "&%remove_header%& ACL modifier"
30939 The &%remove_header%& modifier can be used to remove one or more header lines
30940 from an incoming message, as in this example:
30941 .code
30942 warn   message        = Remove internal headers
30943        remove_header  = x-route-mail1 : x-route-mail2
30944 .endd
30945 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30946 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30947 receiving a message). The message must ultimately be accepted for
30948 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30949 with any ACL verb, including &%deny%&, though this is really not useful for
30950 any verb that doesn't result in a delivered message.
30951
30952 Headers will not be removed from the message if the modifier is used in
30953 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30954
30955 More than one header can be removed at the same time by using a colon separated
30956 list of header names. The header matching is case insensitive. Wildcards are
30957 not permitted, nor is list expansion performed, so you cannot use hostlists to
30958 create a list of headers, however both connection and message variable expansion
30959 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30960 .code
30961 warn   hosts           = +internal_hosts
30962        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30963 warn   message         = Remove internal headers
30964        remove_header   = $acl_c_ihdrs
30965 .endd
30966 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30967 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30968 If multiple header lines match, all are removed.
30969 There is no harm in attempting to remove the same header twice nor in removing
30970 a non-existent header. Further header lines to be removed may be accumulated
30971 during the DATA and MIME ACLs, after which they are removed from the message,
30972 if present. In the case of non-SMTP messages, headers to be removed are
30973 accumulated during the non-SMTP ACLs, and are removed from the message after
30974 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30975 ACL, there really is no effect because there is no logging of what headers
30976 would have been removed.
30977
30978 .cindex "header lines" "removed; visibility of"
30979 Header lines are not visible in string expansions until the DATA phase when it
30980 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30981 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30982 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30983 this restriction, you cannot use header lines as a way of controlling data
30984 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30985 you should instead use ACL variables, as described in section
30986 &<<SECTaclvariables>>&.
30987
30988 The &%remove_header%& modifier acts immediately as it is encountered during the
30989 processing of an ACL. Notice the difference between these two cases:
30990 .display
30991 &`accept remove_header = X-Internal`&
30992 &`       `&<&'some condition'&>
30993
30994 &`accept `&<&'some condition'&>
30995 &`       remove_header = X-Internal`&
30996 .endd
30997 In the first case, the header line is always removed, whether or not the
30998 condition is true. In the second case, the header line is removed only if the
30999 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31000 same ACL statement. All those that are encountered before a condition fails
31001 are honoured.
31002
31003 &*Warning*&: This facility currently applies only to header lines that are
31004 present during ACL processing. It does NOT remove header lines that are added
31005 in a system filter or in a router or transport.
31006
31007
31008
31009
31010 .section "ACL conditions" "SECTaclconditions"
31011 .cindex "&ACL;" "conditions; list of"
31012 Some of the conditions listed in this section are available only when Exim is
31013 compiled with the content-scanning extension. They are included here briefly
31014 for completeness. More detailed descriptions can be found in the discussion on
31015 content scanning in chapter &<<CHAPexiscan>>&.
31016
31017 Not all conditions are relevant in all circumstances. For example, testing
31018 senders and recipients does not make sense in an ACL that is being run as the
31019 result of the arrival of an ETRN command, and checks on message headers can be
31020 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31021 can use the same condition (with different parameters) more than once in the
31022 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31023 The conditions are as follows:
31024
31025
31026 .vlist
31027 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31028 .cindex "&ACL;" "nested"
31029 .cindex "&ACL;" "indirect"
31030 .cindex "&ACL;" "arguments"
31031 .cindex "&%acl%& ACL condition"
31032 The possible values of the argument are the same as for the
31033 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31034 &"accept"& the condition is true; if it returns &"deny"& the condition is
31035 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31036 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31037 condition false. This means that further processing of the &%warn%& verb
31038 ceases, but processing of the ACL continues.
31039
31040 If the argument is a named ACL, up to nine space-separated optional values
31041 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31042 and $acl_narg is set to the count of values.
31043 Previous values of these variables are restored after the call returns.
31044 The name and values are expanded separately.
31045 Note that spaces in complex expansions which are used as arguments
31046 will act as argument separators.
31047
31048 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31049 the connection is dropped. If it returns &"discard"&, the verb must be
31050 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31051 conditions are tested.
31052
31053 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31054 loops. This condition allows you to use different ACLs in different
31055 circumstances. For example, different ACLs can be used to handle RCPT commands
31056 for different local users or different local domains.
31057
31058 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31059 .cindex "&%authenticated%& ACL condition"
31060 .cindex "authentication" "ACL checking"
31061 .cindex "&ACL;" "testing for authentication"
31062 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31063 the name of the authenticator is tested against the list. To test for
31064 authentication by any authenticator, you can set
31065 .code
31066 authenticated = *
31067 .endd
31068
31069 .vitem &*condition&~=&~*&<&'string'&>
31070 .cindex "&%condition%& ACL condition"
31071 .cindex "customizing" "ACL condition"
31072 .cindex "&ACL;" "customized test"
31073 .cindex "&ACL;" "testing, customized"
31074 This feature allows you to make up custom conditions. If the result of
31075 expanding the string is an empty string, the number zero, or one of the strings
31076 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31077 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31078 any other value, some error is assumed to have occurred, and the ACL returns
31079 &"defer"&. However, if the expansion is forced to fail, the condition is
31080 ignored. The effect is to treat it as true, whether it is positive or
31081 negative.
31082
31083 .vitem &*decode&~=&~*&<&'location'&>
31084 .cindex "&%decode%& ACL condition"
31085 This condition is available only when Exim is compiled with the
31086 content-scanning extension, and it is allowed only in the ACL defined by
31087 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31088 If all goes well, the condition is true. It is false only if there are
31089 problems such as a syntax error or a memory shortage. For more details, see
31090 chapter &<<CHAPexiscan>>&.
31091
31092 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31093 .cindex "&%dnslists%& ACL condition"
31094 .cindex "DNS list" "in ACL"
31095 .cindex "black list (DNS)"
31096 .cindex "&ACL;" "testing a DNS list"
31097 This condition checks for entries in DNS black lists. These are also known as
31098 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31099 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31100 different variants of this condition to describe briefly here. See sections
31101 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31102
31103 .vitem &*domains&~=&~*&<&'domain&~list'&>
31104 .cindex "&%domains%& ACL condition"
31105 .cindex "domain" "ACL checking"
31106 .cindex "&ACL;" "testing a recipient domain"
31107 .vindex "&$domain_data$&"
31108 This condition is relevant only after a RCPT command. It checks that the domain
31109 of the recipient address is in the domain list. If percent-hack processing is
31110 enabled, it is done before this test is done. If the check succeeds with a
31111 lookup, the result of the lookup is placed in &$domain_data$& until the next
31112 &%domains%& test.
31113
31114 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31115 use &%domains%& in a DATA ACL.
31116
31117
31118 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31119 .cindex "&%encrypted%& ACL condition"
31120 .cindex "encryption" "checking in an ACL"
31121 .cindex "&ACL;" "testing for encryption"
31122 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31123 name of the cipher suite in use is tested against the list. To test for
31124 encryption without testing for any specific cipher suite(s), set
31125 .code
31126 encrypted = *
31127 .endd
31128
31129
31130 .vitem &*hosts&~=&~*&<&'host&~list'&>
31131 .cindex "&%hosts%& ACL condition"
31132 .cindex "host" "ACL checking"
31133 .cindex "&ACL;" "testing the client host"
31134 This condition tests that the calling host matches the host list. If you have
31135 name lookups or wildcarded host names and IP addresses in the same host list,
31136 you should normally put the IP addresses first. For example, you could have:
31137 .code
31138 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31139 .endd
31140 The lookup in this example uses the host name for its key. This is implied by
31141 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31142 and it wouldn't matter which way round you had these two items.)
31143
31144 The reason for the problem with host names lies in the left-to-right way that
31145 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31146 but when it reaches an item that requires a host name, it fails if it cannot
31147 find a host name to compare with the pattern. If the above list is given in the
31148 opposite order, the &%accept%& statement fails for a host whose name cannot be
31149 found, even if its IP address is 10.9.8.7.
31150
31151 If you really do want to do the name check first, and still recognize the IP
31152 address even if the name lookup fails, you can rewrite the ACL like this:
31153 .code
31154 accept hosts = dbm;/etc/friendly/hosts
31155 accept hosts = 10.9.8.7
31156 .endd
31157 The default action on failing to find the host name is to assume that the host
31158 is not in the list, so the first &%accept%& statement fails. The second
31159 statement can then check the IP address.
31160
31161 .vindex "&$host_data$&"
31162 If a &%hosts%& condition is satisfied by means of a lookup, the result
31163 of the lookup is made available in the &$host_data$& variable. This
31164 allows you, for example, to set up a statement like this:
31165 .code
31166 deny  hosts = net-lsearch;/some/file
31167 message = $host_data
31168 .endd
31169 which gives a custom error message for each denied host.
31170
31171 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31172 .cindex "&%local_parts%& ACL condition"
31173 .cindex "local part" "ACL checking"
31174 .cindex "&ACL;" "testing a local part"
31175 .vindex "&$local_part_data$&"
31176 This condition is relevant only after a RCPT command. It checks that the local
31177 part of the recipient address is in the list. If percent-hack processing is
31178 enabled, it is done before this test. If the check succeeds with a lookup, the
31179 result of the lookup is placed in &$local_part_data$&, which remains set until
31180 the next &%local_parts%& test.
31181
31182 .vitem &*malware&~=&~*&<&'option'&>
31183 .cindex "&%malware%& ACL condition"
31184 .cindex "&ACL;" "virus scanning"
31185 .cindex "&ACL;" "scanning for viruses"
31186 This condition is available only when Exim is compiled with the
31187 content-scanning extension
31188 and only after a DATA command.
31189 It causes the incoming message to be scanned for
31190 viruses. For details, see chapter &<<CHAPexiscan>>&.
31191
31192 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31193 .cindex "&%mime_regex%& ACL condition"
31194 .cindex "&ACL;" "testing by regex matching"
31195 This condition is available only when Exim is compiled with the
31196 content-scanning extension, and it is allowed only in the ACL defined by
31197 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31198 with any of the regular expressions. For details, see chapter
31199 &<<CHAPexiscan>>&.
31200
31201 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31202 .cindex "rate limiting"
31203 This condition can be used to limit the rate at which a user or host submits
31204 messages. Details are given in section &<<SECTratelimiting>>&.
31205
31206 .vitem &*recipients&~=&~*&<&'address&~list'&>
31207 .cindex "&%recipients%& ACL condition"
31208 .cindex "recipient" "ACL checking"
31209 .cindex "&ACL;" "testing a recipient"
31210 This condition is relevant only after a RCPT command. It checks the entire
31211 recipient address against a list of recipients.
31212
31213 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31214 .cindex "&%regex%& ACL condition"
31215 .cindex "&ACL;" "testing by regex matching"
31216 This condition is available only when Exim is compiled with the
31217 content-scanning extension, and is available only in the DATA, MIME, and
31218 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31219 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31220
31221 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31222 .cindex "&%sender_domains%& ACL condition"
31223 .cindex "sender" "ACL checking"
31224 .cindex "&ACL;" "testing a sender domain"
31225 .vindex "&$domain$&"
31226 .vindex "&$sender_address_domain$&"
31227 This condition tests the domain of the sender of the message against the given
31228 domain list. &*Note*&: The domain of the sender address is in
31229 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31230 of this condition. This is an exception to the general rule for testing domain
31231 lists. It is done this way so that, if this condition is used in an ACL for a
31232 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31233 influence the sender checking.
31234
31235 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31236 relaying, because sender addresses are easily, and commonly, forged.
31237
31238 .vitem &*senders&~=&~*&<&'address&~list'&>
31239 .cindex "&%senders%& ACL condition"
31240 .cindex "sender" "ACL checking"
31241 .cindex "&ACL;" "testing a sender"
31242 This condition tests the sender of the message against the given list. To test
31243 for a bounce message, which has an empty sender, set
31244 .code
31245 senders = :
31246 .endd
31247 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31248 relaying, because sender addresses are easily, and commonly, forged.
31249
31250 .vitem &*spam&~=&~*&<&'username'&>
31251 .cindex "&%spam%& ACL condition"
31252 .cindex "&ACL;" "scanning for spam"
31253 This condition is available only when Exim is compiled with the
31254 content-scanning extension. It causes the incoming message to be scanned by
31255 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31256
31257 .vitem &*verify&~=&~certificate*&
31258 .cindex "&%verify%& ACL condition"
31259 .cindex "TLS" "client certificate verification"
31260 .cindex "certificate" "verification of client"
31261 .cindex "&ACL;" "certificate verification"
31262 .cindex "&ACL;" "testing a TLS certificate"
31263 This condition is true in an SMTP session if the session is encrypted, and a
31264 certificate was received from the client, and the certificate was verified. The
31265 server requests a certificate only if the client matches &%tls_verify_hosts%&
31266 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31267
31268 .vitem &*verify&~=&~csa*&
31269 .cindex "CSA verification"
31270 This condition checks whether the sending host (the client) is authorized to
31271 send email. Details of how this works are given in section
31272 &<<SECTverifyCSA>>&.
31273
31274 .vitem &*verify&~=&~header_names_ascii*&
31275 .cindex "&%verify%& ACL condition"
31276 .cindex "&ACL;" "verifying header names only ASCII"
31277 .cindex "header lines" "verifying header names only ASCII"
31278 .cindex "verifying" "header names only ASCII"
31279 This condition is relevant only in an ACL that is run after a message has been
31280 received, that is, in an ACL specified by &%acl_smtp_data%& or
31281 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31282 there are no non-ASCII characters, also excluding control characters.  The
31283 allowable characters are decimal ASCII values 33 through 126.
31284
31285 Exim itself will handle headers with non-ASCII characters, but it can cause
31286 problems for downstream applications, so this option will allow their
31287 detection and rejection in the DATA ACL's.
31288
31289 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31290 .cindex "&%verify%& ACL condition"
31291 .cindex "&ACL;" "verifying sender in the header"
31292 .cindex "header lines" "verifying the sender in"
31293 .cindex "sender" "verifying in header"
31294 .cindex "verifying" "sender in header"
31295 This condition is relevant only in an ACL that is run after a message has been
31296 received, that is, in an ACL specified by &%acl_smtp_data%& or
31297 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31298 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31299 is loosely thought of as a &"sender"& address (hence the name of the test).
31300 However, an address that appears in one of these headers need not be an address
31301 that accepts bounce messages; only sender addresses in envelopes are required
31302 to accept bounces. Therefore, if you use the callout option on this check, you
31303 might want to arrange for a non-empty address in the MAIL command.
31304
31305 Details of address verification and the options are given later, starting at
31306 section &<<SECTaddressverification>>& (callouts are described in section
31307 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31308 condition to restrict it to bounce messages only:
31309 .code
31310 deny    senders = :
31311         message = A valid sender header is required for bounces
31312        !verify  = header_sender
31313 .endd
31314
31315 .vitem &*verify&~=&~header_syntax*&
31316 .cindex "&%verify%& ACL condition"
31317 .cindex "&ACL;" "verifying header syntax"
31318 .cindex "header lines" "verifying syntax"
31319 .cindex "verifying" "header syntax"
31320 This condition is relevant only in an ACL that is run after a message has been
31321 received, that is, in an ACL specified by &%acl_smtp_data%& or
31322 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31323 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31324 and &'Bcc:'&), returning true if there are no problems.
31325 Unqualified addresses (local parts without domains) are
31326 permitted only in locally generated messages and from hosts that match
31327 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31328 appropriate.
31329
31330 Note that this condition is a syntax check only. However, a common spamming
31331 ploy used to be to send syntactically invalid headers such as
31332 .code
31333 To: @
31334 .endd
31335 and this condition can be used to reject such messages, though they are not as
31336 common as they used to be.
31337
31338 .vitem &*verify&~=&~helo*&
31339 .cindex "&%verify%& ACL condition"
31340 .cindex "&ACL;" "verifying HELO/EHLO"
31341 .cindex "HELO" "verifying"
31342 .cindex "EHLO" "verifying"
31343 .cindex "verifying" "EHLO"
31344 .cindex "verifying" "HELO"
31345 This condition is true if a HELO or EHLO command has been received from the
31346 client host, and its contents have been verified. If there has been no previous
31347 attempt to verify the HELO/EHLO contents, it is carried out when this
31348 condition is encountered. See the description of the &%helo_verify_hosts%& and
31349 &%helo_try_verify_hosts%& options for details of how to request verification
31350 independently of this condition, and for detail of the verification.
31351
31352 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31353 option), this condition is always true.
31354
31355
31356 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31357 .cindex "verifying" "not blind"
31358 .cindex "bcc recipients, verifying none"
31359 This condition checks that there are no blind (bcc) recipients in the message.
31360 Every envelope recipient must appear either in a &'To:'& header line or in a
31361 &'Cc:'& header line for this condition to be true. Local parts are checked
31362 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31363 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31364 used only in a DATA or non-SMTP ACL.
31365
31366 There is one possible option, &`case_insensitive`&.  If this is present then
31367 local parts are checked case-insensitively.
31368
31369 There are, of course, many legitimate messages that make use of blind (bcc)
31370 recipients. This check should not be used on its own for blocking messages.
31371
31372
31373 .vitem &*verify&~=&~recipient/*&<&'options'&>
31374 .cindex "&%verify%& ACL condition"
31375 .cindex "&ACL;" "verifying recipient"
31376 .cindex "recipient" "verifying"
31377 .cindex "verifying" "recipient"
31378 .vindex "&$address_data$&"
31379 This condition is relevant only after a RCPT command. It verifies the current
31380 recipient. Details of address verification are given later, starting at section
31381 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31382 of &$address_data$& is the last value that was set while routing the address.
31383 This applies even if the verification fails. When an address that is being
31384 verified is redirected to a single address, verification continues with the new
31385 address, and in that case, the subsequent value of &$address_data$& is the
31386 value for the child address.
31387
31388 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31389 .cindex "&%verify%& ACL condition"
31390 .cindex "&ACL;" "verifying host reverse lookup"
31391 .cindex "host" "verifying reverse lookup"
31392 This condition ensures that a verified host name has been looked up from the IP
31393 address of the client host. (This may have happened already if the host name
31394 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31395 Verification ensures that the host name obtained from a reverse DNS lookup, or
31396 one of its aliases, does, when it is itself looked up in the DNS, yield the
31397 original IP address.
31398
31399 There is one possible option, &`defer_ok`&.  If this is present and a
31400 DNS operation returns a temporary error, the verify condition succeeds.
31401
31402 If this condition is used for a locally generated message (that is, when there
31403 is no client host involved), it always succeeds.
31404
31405 .vitem &*verify&~=&~sender/*&<&'options'&>
31406 .cindex "&%verify%& ACL condition"
31407 .cindex "&ACL;" "verifying sender"
31408 .cindex "sender" "verifying"
31409 .cindex "verifying" "sender"
31410 This condition is relevant only after a MAIL or RCPT command, or after a
31411 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31412 the message's sender is empty (that is, this is a bounce message), the
31413 condition is true. Otherwise, the sender address is verified.
31414
31415 .vindex "&$address_data$&"
31416 .vindex "&$sender_address_data$&"
31417 If there is data in the &$address_data$& variable at the end of routing, its
31418 value is placed in &$sender_address_data$& at the end of verification. This
31419 value can be used in subsequent conditions and modifiers in the same ACL
31420 statement. It does not persist after the end of the current statement. If you
31421 want to preserve the value for longer, you can save it in an ACL variable.
31422
31423 Details of verification are given later, starting at section
31424 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31425 to avoid doing it more than once per message.
31426
31427 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31428 .cindex "&%verify%& ACL condition"
31429 This is a variation of the previous option, in which a modified address is
31430 verified as a sender.
31431
31432 Note that '/' is legal in local-parts; if the address may have such
31433 (eg. is generated from the received message)
31434 they must be protected from the options parsing by doubling:
31435 .code
31436 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31437 .endd
31438 .endlist
31439
31440
31441
31442 .section "Using DNS lists" "SECTmorednslists"
31443 .cindex "DNS list" "in ACL"
31444 .cindex "black list (DNS)"
31445 .cindex "&ACL;" "testing a DNS list"
31446 In its simplest form, the &%dnslists%& condition tests whether the calling host
31447 is on at least one of a number of DNS lists by looking up the inverted IP
31448 address in one or more DNS domains. (Note that DNS list domains are not mail
31449 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31450 special options instead.) For example, if the calling host's IP
31451 address is 192.168.62.43, and the ACL statement is
31452 .code
31453 deny dnslists = blackholes.mail-abuse.org : \
31454                 dialups.mail-abuse.org
31455 .endd
31456 the following records are looked up:
31457 .code
31458 43.62.168.192.blackholes.mail-abuse.org
31459 43.62.168.192.dialups.mail-abuse.org
31460 .endd
31461 As soon as Exim finds an existing DNS record, processing of the list stops.
31462 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31463 to test that a host is on more than one list (an &"and"& conjunction), you can
31464 use two separate conditions:
31465 .code
31466 deny dnslists = blackholes.mail-abuse.org
31467      dnslists = dialups.mail-abuse.org
31468 .endd
31469 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31470 behaves as if the host does not match the list item, that is, as if the DNS
31471 record does not exist. If there are further items in the DNS list, they are
31472 processed.
31473
31474 This is usually the required action when &%dnslists%& is used with &%deny%&
31475 (which is the most common usage), because it prevents a DNS failure from
31476 blocking mail. However, you can change this behaviour by putting one of the
31477 following special items in the list:
31478 .display
31479 &`+include_unknown `&   behave as if the item is on the list
31480 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31481 &`+defer_unknown   `&   give a temporary error
31482 .endd
31483 .cindex "&`+include_unknown`&"
31484 .cindex "&`+exclude_unknown`&"
31485 .cindex "&`+defer_unknown`&"
31486 Each of these applies to any subsequent items on the list. For example:
31487 .code
31488 deny dnslists = +defer_unknown : foo.bar.example
31489 .endd
31490 Testing the list of domains stops as soon as a match is found. If you want to
31491 warn for one list and block for another, you can use two different statements:
31492 .code
31493 deny  dnslists = blackholes.mail-abuse.org
31494 warn  message  = X-Warn: sending host is on dialups list
31495       dnslists = dialups.mail-abuse.org
31496 .endd
31497 .cindex caching "of dns lookup"
31498 .cindex DNS TTL
31499 DNS list lookups are cached by Exim for the duration of the SMTP session
31500 (but limited by the DNS return TTL value),
31501 so a lookup based on the IP address is done at most once for any incoming
31502 connection (assuming long-enough TTL).
31503 Exim does not share information between multiple incoming
31504 connections (but your local name server cache should be active).
31505
31506 There are a number of DNS lists to choose from, some commercial, some free,
31507 or free for small deployments.  An overview can be found at
31508 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31509
31510
31511
31512 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31513 .cindex "DNS list" "keyed by explicit IP address"
31514 By default, the IP address that is used in a DNS list lookup is the IP address
31515 of the calling host. However, you can specify another IP address by listing it
31516 after the domain name, introduced by a slash. For example:
31517 .code
31518 deny dnslists = black.list.tld/192.168.1.2
31519 .endd
31520 This feature is not very helpful with explicit IP addresses; it is intended for
31521 use with IP addresses that are looked up, for example, the IP addresses of the
31522 MX hosts or nameservers of an email sender address. For an example, see section
31523 &<<SECTmulkeyfor>>& below.
31524
31525
31526
31527
31528 .section "DNS lists keyed on domain names" "SECID202"
31529 .cindex "DNS list" "keyed by domain name"
31530 There are some lists that are keyed on domain names rather than inverted IP
31531 addresses (see, e.g., the &'domain based zones'& link at
31532 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31533 with these lists. You can change the name that is looked up in a DNS list by
31534 listing it after the domain name, introduced by a slash. For example,
31535 .code
31536 deny  message  = Sender's domain is listed at $dnslist_domain
31537       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31538 .endd
31539 This particular example is useful only in ACLs that are obeyed after the
31540 RCPT or DATA commands, when a sender address is available. If (for
31541 example) the message's sender is &'user@tld.example'& the name that is looked
31542 up by this example is
31543 .code
31544 tld.example.dsn.rfc-ignorant.org
31545 .endd
31546 A single &%dnslists%& condition can contain entries for both names and IP
31547 addresses. For example:
31548 .code
31549 deny dnslists = sbl.spamhaus.org : \
31550                 dsn.rfc-ignorant.org/$sender_address_domain
31551 .endd
31552 The first item checks the sending host's IP address; the second checks a domain
31553 name. The whole condition is true if either of the DNS lookups succeeds.
31554
31555
31556
31557
31558 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31559 .cindex "DNS list" "multiple keys for"
31560 The syntax described above for looking up explicitly-defined values (either
31561 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31562 name for the DNS list, what follows the slash can in fact be a list of items.
31563 As with all lists in Exim, the default separator is a colon. However, because
31564 this is a sublist within the list of DNS blacklist domains, it is necessary
31565 either to double the separators like this:
31566 .code
31567 dnslists = black.list.tld/name.1::name.2
31568 .endd
31569 or to change the separator character, like this:
31570 .code
31571 dnslists = black.list.tld/<;name.1;name.2
31572 .endd
31573 If an item in the list is an IP address, it is inverted before the DNS
31574 blacklist domain is appended. If it is not an IP address, no inversion
31575 occurs. Consider this condition:
31576 .code
31577 dnslists = black.list.tld/<;192.168.1.2;a.domain
31578 .endd
31579 The DNS lookups that occur are:
31580 .code
31581 2.1.168.192.black.list.tld
31582 a.domain.black.list.tld
31583 .endd
31584 Once a DNS record has been found (that matches a specific IP return
31585 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31586 are done. If there is a temporary DNS error, the rest of the sublist of domains
31587 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31588 only if no other DNS lookup in this sublist succeeds. In other words, a
31589 successful lookup for any of the items in the sublist overrides a temporary
31590 error for a previous item.
31591
31592 The ability to supply a list of items after the slash is in some sense just a
31593 syntactic convenience. These two examples have the same effect:
31594 .code
31595 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31596 dnslists = black.list.tld/a.domain::b.domain
31597 .endd
31598 However, when the data for the list is obtained from a lookup, the second form
31599 is usually much more convenient. Consider this example:
31600 .code
31601 deny message  = The mail servers for the domain \
31602                 $sender_address_domain \
31603                 are listed at $dnslist_domain ($dnslist_value); \
31604                 see $dnslist_text.
31605      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31606                                    ${lookup dnsdb {>|mxh=\
31607                                    $sender_address_domain} }} }
31608 .endd
31609 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31610 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31611 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31612 of expanding the condition might be something like this:
31613 .code
31614 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31615 .endd
31616 Thus, this example checks whether or not the IP addresses of the sender
31617 domain's mail servers are on the Spamhaus black list.
31618
31619 The key that was used for a successful DNS list lookup is put into the variable
31620 &$dnslist_matched$& (see section &<<SECID204>>&).
31621
31622
31623
31624
31625 .section "Data returned by DNS lists" "SECID203"
31626 .cindex "DNS list" "data returned from"
31627 DNS lists are constructed using address records in the DNS. The original RBL
31628 just used the address 127.0.0.1 on the right hand side of each record, but the
31629 RBL+ list and some other lists use a number of values with different meanings.
31630 The values used on the RBL+ list are:
31631 .display
31632 127.1.0.1  RBL
31633 127.1.0.2  DUL
31634 127.1.0.3  DUL and RBL
31635 127.1.0.4  RSS
31636 127.1.0.5  RSS and RBL
31637 127.1.0.6  RSS and DUL
31638 127.1.0.7  RSS and DUL and RBL
31639 .endd
31640 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31641 different values. Some DNS lists may return more than one address record;
31642 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31643
31644
31645 .section "Variables set from DNS lists" "SECID204"
31646 .cindex "expansion" "variables, set from DNS list"
31647 .cindex "DNS list" "variables set from"
31648 .vindex "&$dnslist_domain$&"
31649 .vindex "&$dnslist_matched$&"
31650 .vindex "&$dnslist_text$&"
31651 .vindex "&$dnslist_value$&"
31652 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31653 the name of the overall domain that matched (for example,
31654 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31655 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31656 the DNS record. When the key is an IP address, it is not reversed in
31657 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31658 cases, for example:
31659 .code
31660 deny dnslists = spamhaus.example
31661 .endd
31662 the key is also available in another variable (in this case,
31663 &$sender_host_address$&). In more complicated cases, however, this is not true.
31664 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31665 might generate a dnslists lookup like this:
31666 .code
31667 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31668 .endd
31669 If this condition succeeds, the value in &$dnslist_matched$& might be
31670 &`192.168.6.7`& (for example).
31671
31672 If more than one address record is returned by the DNS lookup, all the IP
31673 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31674 The variable &$dnslist_text$& contains the contents of any associated TXT
31675 record. For lists such as RBL+ the TXT record for a merged entry is often not
31676 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31677 information.
31678
31679 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31680 &-- although these appear before the condition in the ACL, they are not
31681 expanded until after it has failed. For example:
31682 .code
31683 deny    hosts = !+local_networks
31684         message = $sender_host_address is listed \
31685                   at $dnslist_domain
31686         dnslists = rbl-plus.mail-abuse.example
31687 .endd
31688
31689
31690
31691 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31692 .cindex "DNS list" "matching specific returned data"
31693 You can add an equals sign and an IP address after a &%dnslists%& domain name
31694 in order to restrict its action to DNS records with a matching right hand side.
31695 For example,
31696 .code
31697 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31698 .endd
31699 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31700 any address record is considered to be a match. For the moment, we assume
31701 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31702 describes how multiple records are handled.
31703
31704 More than one IP address may be given for checking, using a comma as a
31705 separator. These are alternatives &-- if any one of them matches, the
31706 &%dnslists%& condition is true. For example:
31707 .code
31708 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31709 .endd
31710 If you want to specify a constraining address list and also specify names or IP
31711 addresses to be looked up, the constraining address list must be specified
31712 first. For example:
31713 .code
31714 deny dnslists = dsn.rfc-ignorant.org\
31715                 =127.0.0.2/$sender_address_domain
31716 .endd
31717
31718 If the character &`&&`& is used instead of &`=`&, the comparison for each
31719 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31720 In other words, the listed addresses are used as bit masks. The comparison is
31721 true if all the bits in the mask are present in the address that is being
31722 tested. For example:
31723 .code
31724 dnslists = a.b.c&0.0.0.3
31725 .endd
31726 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31727 want to test whether one bit or another bit is present (as opposed to both
31728 being present), you must use multiple values. For example:
31729 .code
31730 dnslists = a.b.c&0.0.0.1,0.0.0.2
31731 .endd
31732 matches if the final component of the address is an odd number or two times
31733 an odd number.
31734
31735
31736
31737 .section "Negated DNS matching conditions" "SECID205"
31738 You can supply a negative list of IP addresses as part of a &%dnslists%&
31739 condition. Whereas
31740 .code
31741 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31742 .endd
31743 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31744 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31745 .code
31746 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31747 .endd
31748 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31749 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31750 words, the result of the test is inverted if an exclamation mark appears before
31751 the &`=`& (or the &`&&`&) sign.
31752
31753 &*Note*&: This kind of negation is not the same as negation in a domain,
31754 host, or address list (which is why the syntax is different).
31755
31756 If you are using just one list, the negation syntax does not gain you much. The
31757 previous example is precisely equivalent to
31758 .code
31759 deny  dnslists = a.b.c
31760      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31761 .endd
31762 However, if you are using multiple lists, the negation syntax is clearer.
31763 Consider this example:
31764 .code
31765 deny  dnslists = sbl.spamhaus.org : \
31766                  list.dsbl.org : \
31767                  dnsbl.njabl.org!=127.0.0.3 : \
31768                  relays.ordb.org
31769 .endd
31770 Using only positive lists, this would have to be:
31771 .code
31772 deny  dnslists = sbl.spamhaus.org : \
31773                  list.dsbl.org
31774 deny  dnslists = dnsbl.njabl.org
31775      !dnslists = dnsbl.njabl.org=127.0.0.3
31776 deny  dnslists = relays.ordb.org
31777 .endd
31778 which is less clear, and harder to maintain.
31779
31780
31781
31782
31783 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31784 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31785 thereby providing more than one IP address. When an item in a &%dnslists%& list
31786 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31787 the match to specific results from the DNS lookup, there are two ways in which
31788 the checking can be handled. For example, consider the condition:
31789 .code
31790 dnslists = a.b.c=127.0.0.1
31791 .endd
31792 What happens if the DNS lookup for the incoming IP address yields both
31793 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31794 condition true because at least one given value was found, or is it false
31795 because at least one of the found values was not listed? And how does this
31796 affect negated conditions? Both possibilities are provided for with the help of
31797 additional separators &`==`& and &`=&&`&.
31798
31799 .ilist
31800 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31801 IP addresses matches one of the listed addresses. For the example above, the
31802 condition is true because 127.0.0.1 matches.
31803 .next
31804 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31805 looked up IP addresses matches one of the listed addresses. If the condition is
31806 changed to:
31807 .code
31808 dnslists = a.b.c==127.0.0.1
31809 .endd
31810 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31811 false because 127.0.0.2 is not listed. You would need to have:
31812 .code
31813 dnslists = a.b.c==127.0.0.1,127.0.0.2
31814 .endd
31815 for the condition to be true.
31816 .endlist
31817
31818 When &`!`& is used to negate IP address matching, it inverts the result, giving
31819 the precise opposite of the behaviour above. Thus:
31820 .ilist
31821 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31822 addresses matches one of the listed addresses. Consider:
31823 .code
31824 dnslists = a.b.c!&0.0.0.1
31825 .endd
31826 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31827 false because 127.0.0.1 matches.
31828 .next
31829 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31830 looked up IP address that does not match. Consider:
31831 .code
31832 dnslists = a.b.c!=&0.0.0.1
31833 .endd
31834 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31835 true, because 127.0.0.2 does not match. You would need to have:
31836 .code
31837 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31838 .endd
31839 for the condition to be false.
31840 .endlist
31841 When the DNS lookup yields only a single IP address, there is no difference
31842 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31843
31844
31845
31846
31847 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31848 .cindex "DNS list" "information from merged"
31849 When the facility for restricting the matching IP values in a DNS list is used,
31850 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31851 the true reason for rejection. This happens when lists are merged and the IP
31852 address in the A record is used to distinguish them; unfortunately there is
31853 only one TXT record. One way round this is not to use merged lists, but that
31854 can be inefficient because it requires multiple DNS lookups where one would do
31855 in the vast majority of cases when the host of interest is not on any of the
31856 lists.
31857
31858 A less inefficient way of solving this problem is available. If
31859 two domain names, comma-separated, are given, the second is used first to
31860 do an initial check, making use of any IP value restrictions that are set.
31861 If there is a match, the first domain is used, without any IP value
31862 restrictions, to get the TXT record. As a byproduct of this, there is also
31863 a check that the IP being tested is indeed on the first list. The first
31864 domain is the one that is put in &$dnslist_domain$&. For example:
31865 .code
31866 deny message  = \
31867          rejected because $sender_host_address is blacklisted \
31868          at $dnslist_domain\n$dnslist_text
31869        dnslists = \
31870          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31871          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31872 .endd
31873 For the first blacklist item, this starts by doing a lookup in
31874 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31875 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31876 value, and as long as something is found, it looks for the corresponding TXT
31877 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31878 The second blacklist item is processed similarly.
31879
31880 If you are interested in more than one merged list, the same list must be
31881 given several times, but because the results of the DNS lookups are cached,
31882 the DNS calls themselves are not repeated. For example:
31883 .code
31884 deny dnslists = \
31885          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31886          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31887          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31888          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31889 .endd
31890 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31891 values matches (or if no record is found), this is the only lookup that is
31892 done. Only if there is a match is one of the more specific lists consulted.
31893
31894
31895
31896 .section "DNS lists and IPv6" "SECTmorednslistslast"
31897 .cindex "IPv6" "DNS black lists"
31898 .cindex "DNS list" "IPv6 usage"
31899 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31900 nibble by nibble. For example, if the calling host's IP address is
31901 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31902 .code
31903 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31904   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31905 .endd
31906 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31907 lists contain wildcard records, intended for IPv4, that interact badly with
31908 IPv6. For example, the DNS entry
31909 .code
31910 *.3.some.list.example.    A    127.0.0.1
31911 .endd
31912 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31913 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31914
31915 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31916 &%condition%& condition, as in this example:
31917 .code
31918 deny   condition = ${if isip4{$sender_host_address}}
31919        dnslists  = some.list.example
31920 .endd
31921
31922 If an explicit key is being used for a DNS lookup and it may be an IPv6
31923 address you should specify alternate list separators for both the outer
31924 (DNS list name) list and inner (lookup keys) list:
31925 .code
31926        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31927 .endd
31928
31929 .section "Rate limiting incoming messages" "SECTratelimiting"
31930 .cindex "rate limiting" "client sending"
31931 .cindex "limiting client sending rates"
31932 .oindex "&%smtp_ratelimit_*%&"
31933 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31934 which clients can send email. This is more powerful than the
31935 &%smtp_ratelimit_*%& options, because those options control the rate of
31936 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31937 works across all connections (concurrent and sequential) from the same client
31938 host. The syntax of the &%ratelimit%& condition is:
31939 .display
31940 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31941 .endd
31942 If the average client sending rate is less than &'m'& messages per time
31943 period &'p'& then the condition is false; otherwise it is true.
31944
31945 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31946 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31947 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31948 of &'p'&.
31949
31950 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31951 time interval, for example, &`8h`& for eight hours. A larger time constant
31952 means that it takes Exim longer to forget a client's past behaviour. The
31953 parameter &'m'& is the maximum number of messages that a client is permitted to
31954 send in each time interval. It also specifies the number of messages permitted
31955 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31956 constant, you can allow a client to send more messages in a burst without
31957 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31958 both small, messages must be sent at an even rate.
31959
31960 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31961 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31962 when deploying the &%ratelimit%& ACL condition. The script prints usage
31963 instructions when it is run with no arguments.
31964
31965 The key is used to look up the data for calculating the client's average
31966 sending rate. This data is stored in Exim's spool directory, alongside the
31967 retry and other hints databases. The default key is &$sender_host_address$&,
31968 which means Exim computes the sending rate of each client host IP address.
31969 By changing the key you can change how Exim identifies clients for the purpose
31970 of ratelimiting. For example, to limit the sending rate of each authenticated
31971 user, independent of the computer they are sending from, set the key to
31972 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31973 example, &$authenticated_id$& is only meaningful if the client has
31974 authenticated (which you can check with the &%authenticated%& ACL condition).
31975
31976 The lookup key does not have to identify clients: If you want to limit the
31977 rate at which a recipient receives messages, you can use the key
31978 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31979 ACL.
31980
31981 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31982 specifies what Exim measures the rate of, for example, messages or recipients
31983 or bytes. You can adjust the measurement using the &%unique=%& and/or
31984 &%count=%& options. You can also control when Exim updates the recorded rate
31985 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31986 separated by a slash, like the other parameters. They may appear in any order.
31987
31988 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31989 any options that alter the meaning of the stored data. The limit &'m'& is not
31990 stored, so you can alter the configured maximum rate and Exim will still
31991 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31992 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31993 behaviour. The lookup key is not affected by changes to the update mode and
31994 the &%count=%& option.
31995
31996
31997 .section "Ratelimit options for what is being measured" "ratoptmea"
31998 .cindex "rate limiting" "per_* options"
31999 The &%per_conn%& option limits the client's connection rate. It is not
32000 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32001 &%acl_not_smtp_start%& ACLs.
32002
32003 The &%per_mail%& option limits the client's rate of sending messages. This is
32004 the default if none of the &%per_*%& options is specified. It can be used in
32005 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32006 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32007
32008 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32009 the same ACLs as the &%per_mail%& option, though it is best to use this option
32010 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32011 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32012 in its MAIL command, which may be inaccurate or completely missing. You can
32013 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32014 in kilobytes, megabytes, or gigabytes, respectively.
32015
32016 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32017 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32018 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32019 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32020 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32021 in either case the rate limiting engine will see a message with many
32022 recipients as a large high-speed burst.
32023
32024 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32025 number of different recipients that the client has sent messages to in the
32026 last time period. That is, if the client repeatedly sends messages to the same
32027 recipient, its measured rate is not increased. This option can only be used in
32028 &%acl_smtp_rcpt%&.
32029
32030 The &%per_cmd%& option causes Exim to recompute the rate every time the
32031 condition is processed. This can be used to limit the rate of any SMTP
32032 command. If it is used in multiple ACLs it can limit the aggregate rate of
32033 multiple different commands.
32034
32035 The &%count=%& option can be used to alter how much Exim adds to the client's
32036 measured rate. For example, the &%per_byte%& option is equivalent to
32037 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32038 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32039 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32040
32041 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32042
32043
32044 .section "Ratelimit update modes" "ratoptupd"
32045 .cindex "rate limiting" "reading data without updating"
32046 You can specify one of three options with the &%ratelimit%& condition to
32047 control when its database is updated. This section describes the &%readonly%&
32048 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32049
32050 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32051 previously-computed rate to check against the limit.
32052
32053 For example, you can test the client's sending rate and deny it access (when
32054 it is too fast) in the connect ACL. If the client passes this check then it
32055 can go on to send a message, in which case its recorded rate will be updated
32056 in the MAIL ACL. Subsequent connections from the same client will check this
32057 new rate.
32058 .code
32059 acl_check_connect:
32060  deny ratelimit = 100 / 5m / readonly
32061     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32062                   (max $sender_rate_limit)
32063 # ...
32064 acl_check_mail:
32065  warn ratelimit = 100 / 5m / strict
32066     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32067                   (max $sender_rate_limit)
32068 .endd
32069
32070 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32071 processing a message then it may increase the client's measured rate more than
32072 it should. For example, this will happen if you check the &%per_rcpt%& option
32073 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32074 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32075 multiple update problems by using the &%readonly%& option on later ratelimit
32076 checks.
32077
32078 The &%per_*%& options described above do not make sense in some ACLs. If you
32079 use a &%per_*%& option in an ACL where it is not normally permitted then the
32080 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32081 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32082 next section) so you must specify the &%readonly%& option explicitly.
32083
32084
32085 .section "Ratelimit options for handling fast clients" "ratoptfast"
32086 .cindex "rate limiting" "strict and leaky modes"
32087 If a client's average rate is greater than the maximum, the rate limiting
32088 engine can react in two possible ways, depending on the presence of the
32089 &%strict%& or &%leaky%& update modes. This is independent of the other
32090 counter-measures (such as rejecting the message) that may be specified by the
32091 rest of the ACL.
32092
32093 The &%leaky%& (default) option means that the client's recorded rate is not
32094 updated if it is above the limit. The effect of this is that Exim measures the
32095 client's average rate of successfully sent email,
32096 up to the given limit.
32097 This is appropriate if the countermeasure when the condition is true
32098 consists of refusing the message, and
32099 is generally the better choice if you have clients that retry automatically.
32100 If the action when true is anything more complex then this option is
32101 likely not what is wanted.
32102
32103 The &%strict%& option means that the client's recorded rate is always
32104 updated. The effect of this is that Exim measures the client's average rate
32105 of attempts to send email, which can be much higher than the maximum it is
32106 actually allowed. If the client is over the limit it may be subjected to
32107 counter-measures by the ACL. It must slow down and allow sufficient time to
32108 pass that its computed rate falls below the maximum before it can send email
32109 again. The time (the number of smoothing periods) it must wait and not
32110 attempt to send mail can be calculated with this formula:
32111 .code
32112         ln(peakrate/maxrate)
32113 .endd
32114
32115
32116 .section "Limiting the rate of different events" "ratoptuniq"
32117 .cindex "rate limiting" "counting unique events"
32118 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32119 rate of different events. For example, the &%per_addr%& option uses this
32120 mechanism to count the number of different recipients that the client has
32121 sent messages to in the last time period; it is equivalent to
32122 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32123 measure the rate that a client uses different sender addresses with the
32124 options &`per_mail/unique=$sender_address`&.
32125
32126 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32127 has seen for that key. The whole set is thrown away when it is older than the
32128 rate smoothing period &'p'&, so each different event is counted at most once
32129 per period. In the &%leaky%& update mode, an event that causes the client to
32130 go over the limit is not added to the set, in the same way that the client's
32131 recorded rate is not updated in the same situation.
32132
32133 When you combine the &%unique=%& and &%readonly%& options, the specific
32134 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32135 rate.
32136
32137 The &%unique=%& mechanism needs more space in the ratelimit database than the
32138 other &%ratelimit%& options in order to store the event set. The number of
32139 unique values is potentially as large as the rate limit, so the extra space
32140 required increases with larger limits.
32141
32142 The uniqueification is not perfect: there is a small probability that Exim
32143 will think a new event has happened before. If the sender's rate is less than
32144 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32145 the measured rate can go above the limit, in which case Exim may under-count
32146 events by a significant margin. Fortunately, if the rate is high enough (2.7
32147 times the limit) that the false positive rate goes above 9%, then Exim will
32148 throw away the over-full event set before the measured rate falls below the
32149 limit. Therefore the only harm should be that exceptionally high sending rates
32150 are logged incorrectly; any countermeasures you configure will be as effective
32151 as intended.
32152
32153
32154 .section "Using rate limiting" "useratlim"
32155 Exim's other ACL facilities are used to define what counter-measures are taken
32156 when the rate limit is exceeded. This might be anything from logging a warning
32157 (for example, while measuring existing sending rates in order to define
32158 policy), through time delays to slow down fast senders, up to rejecting the
32159 message. For example:
32160 .code
32161 # Log all senders' rates
32162 warn ratelimit = 0 / 1h / strict
32163      log_message = Sender rate $sender_rate / $sender_rate_period
32164
32165 # Slow down fast senders; note the need to truncate $sender_rate
32166 # at the decimal point.
32167 warn ratelimit = 100 / 1h / per_rcpt / strict
32168      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32169                    $sender_rate_limit }s
32170
32171 # Keep authenticated users under control
32172 deny authenticated = *
32173      ratelimit = 100 / 1d / strict / $authenticated_id
32174
32175 # System-wide rate limit
32176 defer message = Sorry, too busy. Try again later.
32177      ratelimit = 10 / 1s / $primary_hostname
32178
32179 # Restrict incoming rate from each host, with a default
32180 # set using a macro and special cases looked up in a table.
32181 defer message = Sender rate exceeds $sender_rate_limit \
32182                messages per $sender_rate_period
32183      ratelimit = ${lookup {$sender_host_address} \
32184                    cdb {DB/ratelimits.cdb} \
32185                    {$value} {RATELIMIT} }
32186 .endd
32187 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32188 especially with the &%per_rcpt%& option, you may suffer from a performance
32189 bottleneck caused by locking on the ratelimit hints database. Apart from
32190 making your ACLs less complicated, you can reduce the problem by using a
32191 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32192 this means that Exim will lose its hints data after a reboot (including retry
32193 hints, the callout cache, and ratelimit data).
32194
32195
32196
32197 .section "Address verification" "SECTaddressverification"
32198 .cindex "verifying address" "options for"
32199 .cindex "policy control" "address verification"
32200 Several of the &%verify%& conditions described in section
32201 &<<SECTaclconditions>>& cause addresses to be verified. Section
32202 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32203 The verification conditions can be followed by options that modify the
32204 verification process. The options are separated from the keyword and from each
32205 other by slashes, and some of them contain parameters. For example:
32206 .code
32207 verify = sender/callout
32208 verify = recipient/defer_ok/callout=10s,defer_ok
32209 .endd
32210 The first stage of address verification, which always happens, is to run the
32211 address through the routers, in &"verify mode"&. Routers can detect the
32212 difference between verification and routing for delivery, and their actions can
32213 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32214 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32215 The available options are as follows:
32216
32217 .ilist
32218 If the &%callout%& option is specified, successful routing to one or more
32219 remote hosts is followed by a &"callout"& to those hosts as an additional
32220 check. Callouts and their sub-options are discussed in the next section.
32221 .next
32222 If there is a defer error while doing verification routing, the ACL
32223 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32224 options, the condition is forced to be true instead. Note that this is a main
32225 verification option as well as a suboption for callouts.
32226 .next
32227 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32228 discusses the reporting of sender address verification failures.
32229 .next
32230 The &%success_on_redirect%& option causes verification always to succeed
32231 immediately after a successful redirection. By default, if a redirection
32232 generates just one address, that address is also verified. See further
32233 discussion in section &<<SECTredirwhilveri>>&.
32234 .endlist
32235
32236 .cindex "verifying address" "differentiating failures"
32237 .vindex "&$recipient_verify_failure$&"
32238 .vindex "&$sender_verify_failure$&"
32239 .vindex "&$acl_verify_message$&"
32240 After an address verification failure, &$acl_verify_message$& contains the
32241 error message that is associated with the failure. It can be preserved by
32242 coding like this:
32243 .code
32244 warn  !verify = sender
32245        set acl_m0 = $acl_verify_message
32246 .endd
32247 If you are writing your own custom rejection message or log message when
32248 denying access, you can use this variable to include information about the
32249 verification failure.
32250
32251 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32252 appropriate) contains one of the following words:
32253
32254 .ilist
32255 &%qualify%&: The address was unqualified (no domain), and the message
32256 was neither local nor came from an exempted host.
32257 .next
32258 &%route%&: Routing failed.
32259 .next
32260 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32261 occurred at or before the MAIL command (that is, on initial
32262 connection, HELO, or MAIL).
32263 .next
32264 &%recipient%&: The RCPT command in a callout was rejected.
32265 .next
32266 &%postmaster%&: The postmaster check in a callout was rejected.
32267 .endlist
32268
32269 The main use of these variables is expected to be to distinguish between
32270 rejections of MAIL and rejections of RCPT in callouts.
32271
32272 The above variables may also be set after a &*successful*&
32273 address verification to:
32274
32275 .ilist
32276 &%random%&: A random local-part callout succeeded
32277 .endlist
32278
32279
32280
32281
32282 .section "Callout verification" "SECTcallver"
32283 .cindex "verifying address" "by callout"
32284 .cindex "callout" "verification"
32285 .cindex "SMTP" "callout verification"
32286 For non-local addresses, routing verifies the domain, but is unable to do any
32287 checking of the local part. There are situations where some means of verifying
32288 the local part is desirable. One way this can be done is to make an SMTP
32289 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32290 a subsequent host for a recipient address, to see if the host accepts the
32291 address. We use the term &'callout'& to cover both cases. Note that for a
32292 sender address, the callback is not to the client host that is trying to
32293 deliver the message, but to one of the hosts that accepts incoming mail for the
32294 sender's domain.
32295
32296 Exim does not do callouts by default. If you want them to happen, you must
32297 request them by setting appropriate options on the &%verify%& condition, as
32298 described below. This facility should be used with care, because it can add a
32299 lot of resource usage to the cost of verifying an address. However, Exim does
32300 cache the results of callouts, which helps to reduce the cost. Details of
32301 caching are in section &<<SECTcallvercache>>&.
32302
32303 Recipient callouts are usually used only between hosts that are controlled by
32304 the same administration. For example, a corporate gateway host could use
32305 callouts to check for valid recipients on an internal mailserver. A successful
32306 callout does not guarantee that a real delivery to the address would succeed;
32307 on the other hand, a failing callout does guarantee that a delivery would fail.
32308
32309 If the &%callout%& option is present on a condition that verifies an address, a
32310 second stage of verification occurs if the address is successfully routed to
32311 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32312 &(manualroute)& router, where the router specifies the hosts. However, if a
32313 router that does not set up hosts routes to an &(smtp)& transport with a
32314 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32315 &%hosts_override%& set, its hosts are always used, whether or not the router
32316 supplies a host list.
32317 Callouts are only supported on &(smtp)& transports.
32318
32319 The port that is used is taken from the transport, if it is specified and is a
32320 remote transport. (For routers that do verification only, no transport need be
32321 specified.) Otherwise, the default SMTP port is used. If a remote transport
32322 specifies an outgoing interface, this is used; otherwise the interface is not
32323 specified. Likewise, the text that is used for the HELO command is taken from
32324 the transport's &%helo_data%& option; if there is no transport, the value of
32325 &$smtp_active_hostname$& is used.
32326
32327 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32328 test whether a bounce message could be delivered to the sender address. The
32329 following SMTP commands are sent:
32330 .display
32331 &`HELO `&<&'local host name'&>
32332 &`MAIL FROM:<>`&
32333 &`RCPT TO:`&<&'the address to be tested'&>
32334 &`QUIT`&
32335 .endd
32336 LHLO is used instead of HELO if the transport's &%protocol%& option is
32337 set to &"lmtp"&.
32338
32339 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32340 settings.
32341
32342 A recipient callout check is similar. By default, it also uses an empty address
32343 for the sender. This default is chosen because most hosts do not make use of
32344 the sender address when verifying a recipient. Using the same address means
32345 that a single cache entry can be used for each recipient. Some sites, however,
32346 do make use of the sender address when verifying. These are catered for by the
32347 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32348
32349 If the response to the RCPT command is a 2&'xx'& code, the verification
32350 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32351 Exim tries the next host, if any. If there is a problem with all the remote
32352 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32353 &%callout%& option is given, in which case the condition is forced to succeed.
32354
32355 .cindex "SMTP" "output flushing, disabling for callout"
32356 A callout may take a little time. For this reason, Exim normally flushes SMTP
32357 output before performing a callout in an ACL, to avoid unexpected timeouts in
32358 clients when the SMTP PIPELINING extension is in use. The flushing can be
32359 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32360
32361
32362
32363
32364 .section "Additional parameters for callouts" "CALLaddparcall"
32365 .cindex "callout" "additional parameters for"
32366 The &%callout%& option can be followed by an equals sign and a number of
32367 optional parameters, separated by commas. For example:
32368 .code
32369 verify = recipient/callout=10s,defer_ok
32370 .endd
32371 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32372 separate verify options, is retained for backwards compatibility, but is now
32373 deprecated. The additional parameters for &%callout%& are as follows:
32374
32375
32376 .vlist
32377 .vitem <&'a&~time&~interval'&>
32378 .cindex "callout" "timeout, specifying"
32379 This specifies the timeout that applies for the callout attempt to each host.
32380 For example:
32381 .code
32382 verify = sender/callout=5s
32383 .endd
32384 The default is 30 seconds. The timeout is used for each response from the
32385 remote host. It is also used for the initial connection, unless overridden by
32386 the &%connect%& parameter.
32387
32388
32389 .vitem &*connect&~=&~*&<&'time&~interval'&>
32390 .cindex "callout" "connection timeout, specifying"
32391 This parameter makes it possible to set a different (usually smaller) timeout
32392 for making the SMTP connection. For example:
32393 .code
32394 verify = sender/callout=5s,connect=1s
32395 .endd
32396 If not specified, this timeout defaults to the general timeout value.
32397
32398 .vitem &*defer_ok*&
32399 .cindex "callout" "defer, action on"
32400 When this parameter is present, failure to contact any host, or any other kind
32401 of temporary error, is treated as success by the ACL. However, the cache is not
32402 updated in this circumstance.
32403
32404 .vitem &*fullpostmaster*&
32405 .cindex "callout" "full postmaster check"
32406 This operates like the &%postmaster%& option (see below), but if the check for
32407 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32408 accordance with the specification in RFC 2821. The RFC states that the
32409 unqualified address &'postmaster'& should be accepted.
32410
32411
32412 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32413 .cindex "callout" "sender when verifying header"
32414 When verifying addresses in header lines using the &%header_sender%&
32415 verification option, Exim behaves by default as if the addresses are envelope
32416 sender addresses from a message. Callout verification therefore tests to see
32417 whether a bounce message could be delivered, by using an empty address in the
32418 MAIL command. However, it is arguable that these addresses might never be used
32419 as envelope senders, and could therefore justifiably reject bounce messages
32420 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32421 address to use in the MAIL command. For example:
32422 .code
32423 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32424 .endd
32425 This parameter is available only for the &%header_sender%& verification option.
32426
32427
32428 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32429 .cindex "callout" "overall timeout, specifying"
32430 This parameter sets an overall timeout for performing a callout verification.
32431 For example:
32432 .code
32433 verify = sender/callout=5s,maxwait=30s
32434 .endd
32435 This timeout defaults to four times the callout timeout for individual SMTP
32436 commands. The overall timeout applies when there is more than one host that can
32437 be tried. The timeout is checked before trying the next host. This prevents
32438 very long delays if there are a large number of hosts and all are timing out
32439 (for example, when network connections are timing out).
32440
32441
32442 .vitem &*no_cache*&
32443 .cindex "callout" "cache, suppressing"
32444 .cindex "caching callout, suppressing"
32445 When this parameter is given, the callout cache is neither read nor updated.
32446
32447 .vitem &*postmaster*&
32448 .cindex "callout" "postmaster; checking"
32449 When this parameter is set, a successful callout check is followed by a similar
32450 check for the local part &'postmaster'& at the same domain. If this address is
32451 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32452 the postmaster check is recorded in a cache record; if it is a failure, this is
32453 used to fail subsequent callouts for the domain without a connection being
32454 made, until the cache record expires.
32455
32456 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32457 The postmaster check uses an empty sender in the MAIL command by default.
32458 You can use this parameter to do a postmaster check using a different address.
32459 For example:
32460 .code
32461 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32462 .endd
32463 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32464 one overrides. The &%postmaster%& parameter is equivalent to this example:
32465 .code
32466 require  verify = sender/callout=postmaster_mailfrom=
32467 .endd
32468 &*Warning*&: The caching arrangements for postmaster checking do not take
32469 account of the sender address. It is assumed that either the empty address or
32470 a fixed non-empty address will be used. All that Exim remembers is that the
32471 postmaster check for the domain succeeded or failed.
32472
32473
32474 .vitem &*random*&
32475 .cindex "callout" "&""random""& check"
32476 When this parameter is set, before doing the normal callout check, Exim does a
32477 check for a &"random"& local part at the same domain. The local part is not
32478 really random &-- it is defined by the expansion of the option
32479 &%callout_random_local_part%&, which defaults to
32480 .code
32481 $primary_hostname-$tod_epoch-testing
32482 .endd
32483 The idea here is to try to determine whether the remote host accepts all local
32484 parts without checking. If it does, there is no point in doing callouts for
32485 specific local parts. If the &"random"& check succeeds, the result is saved in
32486 a cache record, and used to force the current and subsequent callout checks to
32487 succeed without a connection being made, until the cache record expires.
32488
32489 .vitem &*use_postmaster*&
32490 .cindex "callout" "sender for recipient check"
32491 This parameter applies to recipient callouts only. For example:
32492 .code
32493 deny  !verify = recipient/callout=use_postmaster
32494 .endd
32495 .vindex "&$qualify_domain$&"
32496 It causes a non-empty postmaster address to be used in the MAIL command when
32497 performing the callout for the recipient, and also for a &"random"& check if
32498 that is configured. The local part of the address is &`postmaster`& and the
32499 domain is the contents of &$qualify_domain$&.
32500
32501 .vitem &*use_sender*&
32502 This option applies to recipient callouts only. For example:
32503 .code
32504 require  verify = recipient/callout=use_sender
32505 .endd
32506 It causes the message's actual sender address to be used in the MAIL
32507 command when performing the callout, instead of an empty address. There is no
32508 need to use this option unless you know that the called hosts make use of the
32509 sender when checking recipients. If used indiscriminately, it reduces the
32510 usefulness of callout caching.
32511
32512 .vitem &*hold*&
32513 This option applies to recipient callouts only. For example:
32514 .code
32515 require  verify = recipient/callout=use_sender,hold
32516 .endd
32517 It causes the connection to be held open and used for any further recipients
32518 and for eventual delivery (should that be done quickly).
32519 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32520 when that is used for the connections.
32521 The advantage is only gained if there are no callout cache hits
32522 (which could be enforced by the no_cache option),
32523 if the use_sender option is used,
32524 if neither the random nor the use_postmaster option is used,
32525 and if no other callouts intervene.
32526 .endlist
32527
32528 If you use any of the parameters that set a non-empty sender for the MAIL
32529 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32530 &%use_sender%&), you should think about possible loops. Recipient checking is
32531 usually done between two hosts that are under the same management, and the host
32532 that receives the callouts is not normally configured to do callouts itself.
32533 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32534 these circumstances.
32535
32536 However, if you use a non-empty sender address for a callout to an arbitrary
32537 host, there is the likelihood that the remote host will itself initiate a
32538 callout check back to your host. As it is checking what appears to be a message
32539 sender, it is likely to use an empty address in MAIL, thus avoiding a
32540 callout loop. However, to be on the safe side it would be best to set up your
32541 own ACLs so that they do not do sender verification checks when the recipient
32542 is the address you use for header sender or postmaster callout checking.
32543
32544 Another issue to think about when using non-empty senders for callouts is
32545 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32546 by the sender/recipient combination; thus, for any given recipient, many more
32547 actual callouts are performed than when an empty sender or postmaster is used.
32548
32549
32550
32551
32552 .section "Callout caching" "SECTcallvercache"
32553 .cindex "hints database" "callout cache"
32554 .cindex "callout" "cache, description of"
32555 .cindex "caching" "callout"
32556 Exim caches the results of callouts in order to reduce the amount of resources
32557 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32558 option. A hints database called &"callout"& is used for the cache. Two
32559 different record types are used: one records the result of a callout check for
32560 a specific address, and the other records information that applies to the
32561 entire domain (for example, that it accepts the local part &'postmaster'&).
32562
32563 When an original callout fails, a detailed SMTP error message is given about
32564 the failure. However, for subsequent failures use the cache data, this message
32565 is not available.
32566
32567 The expiry times for negative and positive address cache records are
32568 independent, and can be set by the global options &%callout_negative_expire%&
32569 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32570
32571 If a host gives a negative response to an SMTP connection, or rejects any
32572 commands up to and including
32573 .code
32574 MAIL FROM:<>
32575 .endd
32576 (but not including the MAIL command with a non-empty address),
32577 any callout attempt is bound to fail. Exim remembers such failures in a
32578 domain cache record, which it uses to fail callouts for the domain without
32579 making new connections, until the domain record times out. There are two
32580 separate expiry times for domain cache records:
32581 &%callout_domain_negative_expire%& (default 3h) and
32582 &%callout_domain_positive_expire%& (default 7d).
32583
32584 Domain records expire when the negative expiry time is reached if callouts
32585 cannot be made for the domain, or if the postmaster check failed.
32586 Otherwise, they expire when the positive expiry time is reached. This
32587 ensures that, for example, a host that stops accepting &"random"& local parts
32588 will eventually be noticed.
32589
32590 The callout caching mechanism is based on the domain of the address that is
32591 being tested. If the domain routes to several hosts, it is assumed that their
32592 behaviour will be the same.
32593
32594
32595
32596 .section "Sender address verification reporting" "SECTsenaddver"
32597 .cindex "verifying" "suppressing error details"
32598 See section &<<SECTaddressverification>>& for a general discussion of
32599 verification. When sender verification fails in an ACL, the details of the
32600 failure are given as additional output lines before the 550 response to the
32601 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32602 you might see:
32603 .code
32604 MAIL FROM:<xyz@abc.example>
32605 250 OK
32606 RCPT TO:<pqr@def.example>
32607 550-Verification failed for <xyz@abc.example>
32608 550-Called:   192.168.34.43
32609 550-Sent:     RCPT TO:<xyz@abc.example>
32610 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32611 550 Sender verification failed
32612 .endd
32613 If more than one RCPT command fails in the same way, the details are given
32614 only for the first of them. However, some administrators do not want to send
32615 out this much information. You can suppress the details by adding
32616 &`/no_details`& to the ACL statement that requests sender verification. For
32617 example:
32618 .code
32619 verify = sender/no_details
32620 .endd
32621
32622 .section "Redirection while verifying" "SECTredirwhilveri"
32623 .cindex "verifying" "redirection while"
32624 .cindex "address redirection" "while verifying"
32625 A dilemma arises when a local address is redirected by aliasing or forwarding
32626 during verification: should the generated addresses themselves be verified,
32627 or should the successful expansion of the original address be enough to verify
32628 it? By default, Exim takes the following pragmatic approach:
32629
32630 .ilist
32631 When an incoming address is redirected to just one child address, verification
32632 continues with the child address, and if that fails to verify, the original
32633 verification also fails.
32634 .next
32635 When an incoming address is redirected to more than one child address,
32636 verification does not continue. A success result is returned.
32637 .endlist
32638
32639 This seems the most reasonable behaviour for the common use of aliasing as a
32640 way of redirecting different local parts to the same mailbox. It means, for
32641 example, that a pair of alias entries of the form
32642 .code
32643 A.Wol:   aw123
32644 aw123:   :fail: Gone away, no forwarding address
32645 .endd
32646 work as expected, with both local parts causing verification failure. When a
32647 redirection generates more than one address, the behaviour is more like a
32648 mailing list, where the existence of the alias itself is sufficient for
32649 verification to succeed.
32650
32651 It is possible, however, to change the default behaviour so that all successful
32652 redirections count as successful verifications, however many new addresses are
32653 generated. This is specified by the &%success_on_redirect%& verification
32654 option. For example:
32655 .code
32656 require verify = recipient/success_on_redirect/callout=10s
32657 .endd
32658 In this example, verification succeeds if a router generates a new address, and
32659 the callout does not occur, because no address was routed to a remote host.
32660
32661 When verification is being tested via the &%-bv%& option, the treatment of
32662 redirections is as just described, unless the &%-v%& or any debugging option is
32663 also specified. In that case, full verification is done for every generated
32664 address and a report is output for each of them.
32665
32666
32667
32668 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32669 .cindex "CSA" "verifying"
32670 Client SMTP Authorization is a system that allows a site to advertise
32671 which machines are and are not permitted to send email. This is done by placing
32672 special SRV records in the DNS; these are looked up using the client's HELO
32673 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32674 Authorization checks in Exim are performed by the ACL condition:
32675 .code
32676 verify = csa
32677 .endd
32678 This fails if the client is not authorized. If there is a DNS problem, or if no
32679 valid CSA SRV record is found, or if the client is authorized, the condition
32680 succeeds. These three cases can be distinguished using the expansion variable
32681 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32682 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32683 be likely to cause problems for legitimate email.
32684
32685 The error messages produced by the CSA code include slightly more
32686 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32687 looking up the CSA SRV record, or problems looking up the CSA target
32688 address record. There are four reasons for &$csa_status$& being &"fail"&:
32689
32690 .ilist
32691 The client's host name is explicitly not authorized.
32692 .next
32693 The client's IP address does not match any of the CSA target IP addresses.
32694 .next
32695 The client's host name is authorized but it has no valid target IP addresses
32696 (for example, the target's addresses are IPv6 and the client is using IPv4).
32697 .next
32698 The client's host name has no CSA SRV record but a parent domain has asserted
32699 that all subdomains must be explicitly authorized.
32700 .endlist
32701
32702 The &%csa%& verification condition can take an argument which is the domain to
32703 use for the DNS query. The default is:
32704 .code
32705 verify = csa/$sender_helo_name
32706 .endd
32707 This implementation includes an extension to CSA. If the query domain
32708 is an address literal such as [192.0.2.95], or if it is a bare IP
32709 address, Exim searches for CSA SRV records in the reverse DNS as if
32710 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32711 meaningful to say:
32712 .code
32713 verify = csa/$sender_host_address
32714 .endd
32715 In fact, this is the check that Exim performs if the client does not say HELO.
32716 This extension can be turned off by setting the main configuration option
32717 &%dns_csa_use_reverse%& to be false.
32718
32719 If a CSA SRV record is not found for the domain itself, a search
32720 is performed through its parent domains for a record which might be
32721 making assertions about subdomains. The maximum depth of this search is limited
32722 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32723 default. Exim does not look for CSA SRV records in a top level domain, so the
32724 default settings handle HELO domains as long as seven
32725 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32726 of legitimate HELO domains.
32727
32728 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32729 direct SRV lookups, this is not sufficient because of the extra parent domain
32730 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32731 addresses into lookups in the reverse DNS space. The result of a successful
32732 lookup such as:
32733 .code
32734 ${lookup dnsdb {csa=$sender_helo_name}}
32735 .endd
32736 has two space-separated fields: an authorization code and a target host name.
32737 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32738 authorization required but absent, or &"?"& for unknown.
32739
32740
32741
32742
32743 .section "Bounce address tag validation" "SECTverifyPRVS"
32744 .cindex "BATV, verifying"
32745 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32746 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32747 Genuine incoming bounce messages should therefore always be addressed to
32748 recipients that have a valid tag. This scheme is a way of detecting unwanted
32749 bounce messages caused by sender address forgeries (often called &"collateral
32750 spam"&), because the recipients of such messages do not include valid tags.
32751
32752 There are two expansion items to help with the implementation of the BATV
32753 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32754 the original envelope sender address by using a simple key to add a hash of the
32755 address and some time-based randomizing information. The &%prvs%& expansion
32756 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32757 The syntax of these expansion items is described in section
32758 &<<SECTexpansionitems>>&.
32759 The validity period on signed addresses is seven days.
32760
32761 As an example, suppose the secret per-address keys are stored in an MySQL
32762 database. A query to look up the key for an address could be defined as a macro
32763 like this:
32764 .code
32765 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32766                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32767                 }{$value}}
32768 .endd
32769 Suppose also that the senders who make use of BATV are defined by an address
32770 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32771 use this:
32772 .code
32773 # Bounces: drop unsigned addresses for BATV senders
32774 deny message = This address does not send an unsigned reverse path
32775      senders = :
32776      recipients = +batv_senders
32777
32778 # Bounces: In case of prvs-signed address, check signature.
32779 deny message = Invalid reverse path signature.
32780      senders = :
32781      condition  = ${prvscheck {$local_part@$domain}\
32782                   {PRVSCHECK_SQL}{1}}
32783      !condition = $prvscheck_result
32784 .endd
32785 The first statement rejects recipients for bounce messages that are addressed
32786 to plain BATV sender addresses, because it is known that BATV senders do not
32787 send out messages with plain sender addresses. The second statement rejects
32788 recipients that are prvs-signed, but with invalid signatures (either because
32789 the key is wrong, or the signature has timed out).
32790
32791 A non-prvs-signed address is not rejected by the second statement, because the
32792 &%prvscheck%& expansion yields an empty string if its first argument is not a
32793 prvs-signed address, thus causing the &%condition%& condition to be false. If
32794 the first argument is a syntactically valid prvs-signed address, the yield is
32795 the third string (in this case &"1"&), whether or not the cryptographic and
32796 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32797 of the checks (empty for failure, &"1"& for success).
32798
32799 There is one more issue you must consider when implementing prvs-signing:
32800 you have to ensure that the routers accept prvs-signed addresses and
32801 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32802 router to remove the signature with a configuration along these lines:
32803 .code
32804 batv_redirect:
32805   driver = redirect
32806   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32807 .endd
32808 This works because, if the third argument of &%prvscheck%& is empty, the result
32809 of the expansion of a prvs-signed address is the decoded value of the original
32810 address. This router should probably be the first of your routers that handles
32811 local addresses.
32812
32813 To create BATV-signed addresses in the first place, a transport of this form
32814 can be used:
32815 .code
32816 external_smtp_batv:
32817   driver = smtp
32818   return_path = ${prvs {$return_path} \
32819                        {${lookup mysql{SELECT \
32820                        secret FROM batv_prvs WHERE \
32821                        sender='${quote_mysql:$sender_address}'} \
32822                        {$value}fail}}}
32823 .endd
32824 If no key can be found for the existing return path, no signing takes place.
32825
32826
32827
32828 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32829 .cindex "&ACL;" "relay control"
32830 .cindex "relaying" "control by ACL"
32831 .cindex "policy control" "relay control"
32832 An MTA is said to &'relay'& a message if it receives it from some host and
32833 delivers it directly to another host as a result of a remote address contained
32834 within it. Redirecting a local address via an alias or forward file and then
32835 passing the message on to another host is not relaying,
32836 .cindex "&""percent hack""&"
32837 but a redirection as a result of the &"percent hack"& is.
32838
32839 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32840 A host which is acting as a gateway or an MX backup is concerned with incoming
32841 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32842 a host which is acting as a smart host for a number of clients is concerned
32843 with outgoing relaying from those clients to the Internet at large. Often the
32844 same host is fulfilling both functions,
32845 . ///
32846 . as illustrated in the diagram below,
32847 . ///
32848 but in principle these two kinds of relaying are entirely independent. What is
32849 not wanted is the transmission of mail from arbitrary remote hosts through your
32850 system to arbitrary domains.
32851
32852
32853 You can implement relay control by means of suitable statements in the ACL that
32854 runs for each RCPT command. For convenience, it is often easiest to use
32855 Exim's named list facility to define the domains and hosts involved. For
32856 example, suppose you want to do the following:
32857
32858 .ilist
32859 Deliver a number of domains to mailboxes on the local host (or process them
32860 locally in some other way). Let's say these are &'my.dom1.example'& and
32861 &'my.dom2.example'&.
32862 .next
32863 Relay mail for a number of other domains for which you are the secondary MX.
32864 These might be &'friend1.example'& and &'friend2.example'&.
32865 .next
32866 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32867 Suppose your LAN is 192.168.45.0/24.
32868 .endlist
32869
32870
32871 In the main part of the configuration, you put the following definitions:
32872 .code
32873 domainlist local_domains    = my.dom1.example : my.dom2.example
32874 domainlist relay_to_domains = friend1.example : friend2.example
32875 hostlist   relay_from_hosts = 192.168.45.0/24
32876 .endd
32877 Now you can use these definitions in the ACL that is run for every RCPT
32878 command:
32879 .code
32880 acl_check_rcpt:
32881   accept domains = +local_domains : +relay_to_domains
32882   accept hosts   = +relay_from_hosts
32883 .endd
32884 The first statement accepts any RCPT command that contains an address in
32885 the local or relay domains. For any other domain, control passes to the second
32886 statement, which accepts the command only if it comes from one of the relay
32887 hosts. In practice, you will probably want to make your ACL more sophisticated
32888 than this, for example, by including sender and recipient verification. The
32889 default configuration includes a more comprehensive example, which is described
32890 in chapter &<<CHAPdefconfil>>&.
32891
32892
32893
32894 .section "Checking a relay configuration" "SECTcheralcon"
32895 .cindex "relaying" "checking control of"
32896 You can check the relay characteristics of your configuration in the same way
32897 that you can test any ACL behaviour for an incoming SMTP connection, by using
32898 the &%-bh%& option to run a fake SMTP session with which you interact.
32899 .ecindex IIDacl
32900
32901
32902
32903 . ////////////////////////////////////////////////////////////////////////////
32904 . ////////////////////////////////////////////////////////////////////////////
32905
32906 .chapter "Content scanning at ACL time" "CHAPexiscan"
32907 .scindex IIDcosca "content scanning" "at ACL time"
32908 The extension of Exim to include content scanning at ACL time, formerly known
32909 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32910 was integrated into the main source for Exim release 4.50, and Tom continues to
32911 maintain it. Most of the wording of this chapter is taken from Tom's
32912 specification.
32913
32914 It is also possible to scan the content of messages at other times. The
32915 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32916 scanning after all the ACLs have run. A transport filter can be used to scan
32917 messages at delivery time (see the &%transport_filter%& option, described in
32918 chapter &<<CHAPtransportgeneric>>&).
32919
32920 If you want to include the ACL-time content-scanning features when you compile
32921 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32922 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32923
32924 .ilist
32925 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32926 for all MIME parts for SMTP and non-SMTP messages, respectively.
32927 .next
32928 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32929 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32930 run at the end of message reception (the &%acl_smtp_data%& ACL).
32931 .next
32932 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32933 of messages, or parts of messages, for debugging purposes.
32934 .next
32935 Additional expansion variables that are set in the new ACL and by the new
32936 conditions.
32937 .next
32938 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32939 .endlist
32940
32941 Content-scanning is continually evolving, and new features are still being
32942 added. While such features are still unstable and liable to incompatible
32943 changes, they are made available in Exim by setting options whose names begin
32944 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32945 this manual. You can find out about them by reading the file called
32946 &_doc/experimental.txt_&.
32947
32948 All the content-scanning facilities work on a MBOX copy of the message that is
32949 temporarily created in a file called:
32950 .display
32951 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32952 .endd
32953 The &_.eml_& extension is a friendly hint to virus scanners that they can
32954 expect an MBOX-like structure inside that file. The file is created when the
32955 first content scanning facility is called. Subsequent calls to content
32956 scanning conditions open the same file again. The directory is recursively
32957 removed when the &%acl_smtp_data%& ACL has finished running, unless
32958 .code
32959 control = no_mbox_unspool
32960 .endd
32961 has been encountered. When the MIME ACL decodes files, they are put into the
32962 same directory by default.
32963
32964
32965
32966 .section "Scanning for viruses" "SECTscanvirus"
32967 .cindex "virus scanning"
32968 .cindex "content scanning" "for viruses"
32969 .cindex "content scanning" "the &%malware%& condition"
32970 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32971 It supports a &"generic"& interface to scanners called via the shell, and
32972 specialized interfaces for &"daemon"& type virus scanners, which are resident
32973 in memory and thus are much faster.
32974
32975 Since message data needs to have arrived,
32976 the condition may be only called in ACL defined by
32977 &%acl_smtp_data%&,
32978 &%acl_smtp_data_prdr%&,
32979 &%acl_smtp_mime%& or
32980 &%acl_smtp_dkim%&
32981
32982 A timeout of 2 minutes is applied to a scanner call (by default);
32983 if it expires then a defer action is taken.
32984
32985 .oindex "&%av_scanner%&"
32986 You can set the &%av_scanner%& option in the main part of the configuration
32987 to specify which scanner to use, together with any additional options that
32988 are needed. The basic syntax is as follows:
32989 .display
32990 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32991 .endd
32992 If you do not set &%av_scanner%&, it defaults to
32993 .code
32994 av_scanner = sophie:/var/run/sophie
32995 .endd
32996 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32997 before use.
32998 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32999 The following scanner types are supported in this release,
33000 though individual ones can be included or not at build time:
33001
33002 .vlist
33003 .vitem &%avast%&
33004 .cindex "virus scanners" "avast"
33005 This is the scanner daemon of Avast. It has been tested with Avast Core
33006 Security (currently at version 2.2.0).
33007 You can get a trial version at &url(https://www.avast.com) or for Linux
33008 at &url(https://www.avast.com/linux-server-antivirus).
33009 This scanner type takes one option,
33010 which can be either a full path to a UNIX socket,
33011 or host and port specifiers separated by white space.
33012 The host may be a name or an IP address; the port is either a
33013 single number or a pair of numbers with a dash between.
33014 A list of options may follow. These options are interpreted on the
33015 Exim's side of the malware scanner, or are given on separate lines to
33016 the daemon as options before the main scan command.
33017
33018 .cindex &`pass_unscanned`& "avast"
33019 If &`pass_unscanned`&
33020 is set, any files the Avast scanner can't scan (e.g.
33021 decompression bombs, or invalid archives) are considered clean. Use with
33022 care.
33023
33024 For example:
33025 .code
33026 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33027 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33028 av_scanner = avast:192.168.2.22 5036
33029 .endd
33030 If you omit the argument, the default path
33031 &_/var/run/avast/scan.sock_&
33032 is used.
33033 If you use a remote host,
33034 you need to make Exim's spool directory available to it,
33035 as the scanner is passed a file path, not file contents.
33036 For information about available commands and their options you may use
33037 .code
33038 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33039     FLAGS
33040     SENSITIVITY
33041     PACK
33042 .endd
33043
33044 If the scanner returns a temporary failure (e.g. license issues, or
33045 permission problems), the message is deferred and a paniclog entry is
33046 written.  The usual &`defer_ok`& option is available.
33047
33048 .vitem &%aveserver%&
33049 .cindex "virus scanners" "Kaspersky"
33050 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33051 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33052 which is the path to the daemon's UNIX socket. The default is shown in this
33053 example:
33054 .code
33055 av_scanner = aveserver:/var/run/aveserver
33056 .endd
33057
33058
33059 .vitem &%clamd%&
33060 .cindex "virus scanners" "clamd"
33061 This daemon-type scanner is GPL and free. You can get it at
33062 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33063 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33064 in the MIME ACL. This is no longer believed to be necessary.
33065
33066 The options are a list of server specifiers, which may be
33067 a UNIX socket specification,
33068 a TCP socket specification,
33069 or a (global) option.
33070
33071 A socket specification consists of a space-separated list.
33072 For a Unix socket the first element is a full path for the socket,
33073 for a TCP socket the first element is the IP address
33074 and the second a port number,
33075 Any further elements are per-server (non-global) options.
33076 These per-server options are supported:
33077 .code
33078 retry=<timespec>        Retry on connect fail
33079 .endd
33080
33081 The &`retry`& option specifies a time after which a single retry for
33082 a failed connect is made.  The default is to not retry.
33083
33084 If a Unix socket file is specified, only one server is supported.
33085
33086 Examples:
33087 .code
33088 av_scanner = clamd:/opt/clamd/socket
33089 av_scanner = clamd:192.0.2.3 1234
33090 av_scanner = clamd:192.0.2.3 1234:local
33091 av_scanner = clamd:192.0.2.3 1234 retry=10s
33092 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33093 .endd
33094 If the value of av_scanner points to a UNIX socket file or contains the
33095 &`local`&
33096 option, then the ClamAV interface will pass a filename containing the data
33097 to be scanned, which should normally result in less I/O happening and be
33098 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33099 Exim does not assume that there is a common filesystem with the remote host.
33100
33101 The final example shows that multiple TCP targets can be specified.  Exim will
33102 randomly use one for each incoming email (i.e. it load balances them).  Note
33103 that only TCP targets may be used if specifying a list of scanners; a UNIX
33104 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33105 unavailable, Exim will try the remaining one(s) until it finds one that works.
33106 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33107 not keep track of scanner state between multiple messages, and the scanner
33108 selection is random, so the message will get logged in the mainlog for each
33109 email that the down scanner gets chosen first (message wrapped to be readable):
33110 .code
33111 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33112    clamd: connection to localhost, port 3310 failed
33113    (Connection refused)
33114 .endd
33115
33116 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33117 contributing the code for this scanner.
33118
33119 .vitem &%cmdline%&
33120 .cindex "virus scanners" "command line interface"
33121 This is the keyword for the generic command line scanner interface. It can be
33122 used to attach virus scanners that are invoked from the shell. This scanner
33123 type takes 3 mandatory options:
33124
33125 .olist
33126 The full path and name of the scanner binary, with all command line options,
33127 and a placeholder (&`%s`&) for the directory to scan.
33128
33129 .next
33130 A regular expression to match against the STDOUT and STDERR output of the
33131 virus scanner. If the expression matches, a virus was found. You must make
33132 absolutely sure that this expression matches on &"virus found"&. This is called
33133 the &"trigger"& expression.
33134
33135 .next
33136 Another regular expression, containing exactly one pair of parentheses, to
33137 match the name of the virus found in the scanners output. This is called the
33138 &"name"& expression.
33139 .endlist olist
33140
33141 For example, Sophos Sweep reports a virus on a line like this:
33142 .code
33143 Virus 'W32/Magistr-B' found in file ./those.bat
33144 .endd
33145 For the trigger expression, we can match the phrase &"found in file"&. For the
33146 name expression, we want to extract the W32/Magistr-B string, so we can match
33147 for the single quotes left and right of it. Altogether, this makes the
33148 configuration setting:
33149 .code
33150 av_scanner = cmdline:\
33151              /path/to/sweep -ss -all -rec -archive %s:\
33152              found in file:'(.+)'
33153 .endd
33154 .vitem &%drweb%&
33155 .cindex "virus scanners" "DrWeb"
33156 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33157 takes one option,
33158 either a full path to a UNIX socket,
33159 or host and port specifiers separated by white space.
33160 The host may be a name or an IP address; the port is either a
33161 single number or a pair of numbers with a dash between.
33162 For example:
33163 .code
33164 av_scanner = drweb:/var/run/drwebd.sock
33165 av_scanner = drweb:192.168.2.20 31337
33166 .endd
33167 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33168 is used. Thanks to Alex Miller for contributing the code for this scanner.
33169
33170 .vitem &%f-protd%&
33171 .cindex "virus scanners" "f-protd"
33172 The f-protd scanner is accessed via HTTP over TCP.
33173 One argument is taken, being a space-separated hostname and port number
33174 (or port-range).
33175 For example:
33176 .code
33177 av_scanner = f-protd:localhost 10200-10204
33178 .endd
33179 If you omit the argument, the default values shown above are used.
33180
33181 .vitem &%f-prot6d%&
33182 .cindex "virus scanners" "f-prot6d"
33183 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33184 One argument is taken, being a space-separated hostname and port number.
33185 For example:
33186 .code
33187 av_scanner = f-prot6d:localhost 10200
33188 .endd
33189 If you omit the argument, the default values show above are used.
33190
33191 .vitem &%fsecure%&
33192 .cindex "virus scanners" "F-Secure"
33193 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33194 argument which is the path to a UNIX socket. For example:
33195 .code
33196 av_scanner = fsecure:/path/to/.fsav
33197 .endd
33198 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33199 Thelmen for contributing the code for this scanner.
33200
33201 .vitem &%kavdaemon%&
33202 .cindex "virus scanners" "Kaspersky"
33203 This is the scanner daemon of Kaspersky Version 4. This version of the
33204 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33205 scanner type takes one option, which is the path to the daemon's UNIX socket.
33206 For example:
33207 .code
33208 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33209 .endd
33210 The default path is &_/var/run/AvpCtl_&.
33211
33212 .vitem &%mksd%&
33213 .cindex "virus scanners" "mksd"
33214 This was a daemon type scanner that is aimed mainly at Polish users,
33215 though some documentation was available in English.
33216 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33217 and this appears to be a candidate for removal from Exim, unless
33218 we are informed of other virus scanners which use the same protocol
33219 to integrate.
33220 The only option for this scanner type is
33221 the maximum number of processes used simultaneously to scan the attachments,
33222 provided that mksd has
33223 been run with at least the same number of child processes. For example:
33224 .code
33225 av_scanner = mksd:2
33226 .endd
33227 You can safely omit this option (the default value is 1).
33228
33229 .vitem &%sock%&
33230 .cindex "virus scanners" "simple socket-connected"
33231 This is a general-purpose way of talking to simple scanner daemons
33232 running on the local machine.
33233 There are four options:
33234 an address (which may be an IP address and port, or the path of a Unix socket),
33235 a commandline to send (may include a single %s which will be replaced with
33236 the path to the mail file to be scanned),
33237 an RE to trigger on from the returned data,
33238 and an RE to extract malware_name from the returned data.
33239 For example:
33240 .code
33241 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33242 .endd
33243 Note that surrounding whitespace is stripped from each option, meaning
33244 there is no way to specify a trailing newline.
33245 The socket specifier and both regular-expressions are required.
33246 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33247 specify an empty element to get this.
33248
33249 .vitem &%sophie%&
33250 .cindex "virus scanners" "Sophos and Sophie"
33251 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33252 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33253 for this scanner type is the path to the UNIX socket that Sophie uses for
33254 client communication. For example:
33255 .code
33256 av_scanner = sophie:/tmp/sophie
33257 .endd
33258 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33259 the option.
33260 .endlist
33261
33262 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33263 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33264 ACL.
33265
33266 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33267 makes it possible to use different scanners. See further below for an example.
33268 The &%malware%& condition caches its results, so when you use it multiple times
33269 for the same message, the actual scanning process is only carried out once.
33270 However, using expandable items in &%av_scanner%& disables this caching, in
33271 which case each use of the &%malware%& condition causes a new scan of the
33272 message.
33273
33274 The &%malware%& condition takes a right-hand argument that is expanded before
33275 use and taken as a list, slash-separated by default.
33276 The first element can then be one of
33277
33278 .ilist
33279 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33280 The condition succeeds if a virus was found, and fail otherwise. This is the
33281 recommended usage.
33282 .next
33283 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33284 the condition fails immediately.
33285 .next
33286 A regular expression, in which case the message is scanned for viruses. The
33287 condition succeeds if a virus is found and its name matches the regular
33288 expression. This allows you to take special actions on certain types of virus.
33289 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33290 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33291 .endlist
33292
33293 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33294 messages even if there is a problem with the virus scanner.
33295 Otherwise, such a problem causes the ACL to defer.
33296
33297 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33298 specify a non-default timeout.  The default is two minutes.
33299 For example:
33300 .code
33301 malware = * / defer_ok / tmo=10s
33302 .endd
33303 A timeout causes the ACL to defer.
33304
33305 .vindex "&$callout_address$&"
33306 When a connection is made to the scanner the expansion variable &$callout_address$&
33307 is set to record the actual address used.
33308
33309 .vindex "&$malware_name$&"
33310 When a virus is found, the condition sets up an expansion variable called
33311 &$malware_name$& that contains the name of the virus. You can use it in a
33312 &%message%& modifier that specifies the error returned to the sender, and/or in
33313 logging data.
33314
33315 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33316 imposed by your anti-virus scanner.
33317
33318 Here is a very simple scanning example:
33319 .code
33320 deny message = This message contains malware ($malware_name)
33321      malware = *
33322 .endd
33323 The next example accepts messages when there is a problem with the scanner:
33324 .code
33325 deny message = This message contains malware ($malware_name)
33326      malware = */defer_ok
33327 .endd
33328 The next example shows how to use an ACL variable to scan with both sophie and
33329 aveserver. It assumes you have set:
33330 .code
33331 av_scanner = $acl_m0
33332 .endd
33333 in the main Exim configuration.
33334 .code
33335 deny message = This message contains malware ($malware_name)
33336      set acl_m0 = sophie
33337      malware = *
33338
33339 deny message = This message contains malware ($malware_name)
33340      set acl_m0 = aveserver
33341      malware = *
33342 .endd
33343
33344
33345 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33346 .cindex "content scanning" "for spam"
33347 .cindex "spam scanning"
33348 .cindex "SpamAssassin"
33349 .cindex "Rspamd"
33350 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33351 score and a report for the message.
33352 Support is also provided for Rspamd.
33353
33354 For more information about installation and configuration of SpamAssassin or
33355 Rspamd refer to their respective websites at
33356 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33357
33358 SpamAssassin can be installed with CPAN by running:
33359 .code
33360 perl -MCPAN -e 'install Mail::SpamAssassin'
33361 .endd
33362 SpamAssassin has its own set of configuration files. Please review its
33363 documentation to see how you can tweak it. The default installation should work
33364 nicely, however.
33365
33366 .oindex "&%spamd_address%&"
33367 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33368 intend to use an instance running on the local host you do not need to set
33369 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33370 you must set the &%spamd_address%& option in the global part of the Exim
33371 configuration as follows (example):
33372 .code
33373 spamd_address = 192.168.99.45 783
33374 .endd
33375 The SpamAssassin protocol relies on a TCP half-close from the client.
33376 If your SpamAssassin client side is running a Linux system with an
33377 iptables firewall, consider setting
33378 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33379 timeout, Exim uses when waiting for a response from the SpamAssassin
33380 server (currently defaulting to 120s).  With a lower value the Linux
33381 connection tracking may consider your half-closed connection as dead too
33382 soon.
33383
33384
33385 To use Rspamd (which by default listens on all local addresses
33386 on TCP port 11333)
33387 you should add &%variant=rspamd%& after the address/port pair, for example:
33388 .code
33389 spamd_address = 127.0.0.1 11333 variant=rspamd
33390 .endd
33391
33392 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33393 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33394 filename instead of an address/port pair:
33395 .code
33396 spamd_address = /var/run/spamd_socket
33397 .endd
33398 You can have multiple &%spamd%& servers to improve scalability. These can
33399 reside on other hardware reachable over the network. To specify multiple
33400 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33401 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33402 .code
33403 spamd_address = 192.168.2.10 783 : \
33404                 192.168.2.11 783 : \
33405                 192.168.2.12 783
33406 .endd
33407 Up to 32 &%spamd%& servers are supported.
33408 When a server fails to respond to the connection attempt, all other
33409 servers are tried until one succeeds. If no server responds, the &%spam%&
33410 condition defers.
33411
33412 Unix and TCP socket specifications may be mixed in any order.
33413 Each element of the list is a list itself, space-separated by default
33414 and changeable in the usual way (&<<SECTlistsepchange>>&);
33415 take care to not double the separator.
33416
33417 For TCP socket specifications a host name or IP (v4 or v6, but
33418 subject to list-separator quoting rules) address can be used,
33419 and the port can be one or a dash-separated pair.
33420 In the latter case, the range is tried in strict order.
33421
33422 Elements after the first for Unix sockets, or second for TCP socket,
33423 are options.
33424 The supported options are:
33425 .code
33426 pri=<priority>      Selection priority
33427 weight=<value>      Selection bias
33428 time=<start>-<end>  Use only between these times of day
33429 retry=<timespec>    Retry on connect fail
33430 tmo=<timespec>      Connection time limit
33431 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33432 .endd
33433
33434 The &`pri`& option specifies a priority for the server within the list,
33435 higher values being tried first.
33436 The default priority is 1.
33437
33438 The &`weight`& option specifies a selection bias.
33439 Within a priority set
33440 servers are queried in a random fashion, weighted by this value.
33441 The default value for selection bias is 1.
33442
33443 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33444 in the local time zone; each element being one or more digits.
33445 Either the seconds or both minutes and seconds, plus the leading &`.`&
33446 characters, may be omitted and will be taken as zero.
33447
33448 Timeout specifications for the &`retry`& and &`tmo`& options
33449 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33450
33451 The &`tmo`& option specifies an overall timeout for communication.
33452 The default value is two minutes.
33453
33454 The &`retry`& option specifies a time after which a single retry for
33455 a failed connect is made.
33456 The default is to not retry.
33457
33458 The &%spamd_address%& variable is expanded before use if it starts with
33459 a dollar sign. In this case, the expansion may return a string that is
33460 used as the list so that multiple spamd servers can be the result of an
33461 expansion.
33462
33463 .vindex "&$callout_address$&"
33464 When a connection is made to the server the expansion variable &$callout_address$&
33465 is set to record the actual address used.
33466
33467 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33468 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33469 .code
33470 deny message = This message was classified as SPAM
33471      spam = joe
33472 .endd
33473 The right-hand side of the &%spam%& condition specifies a name. This is
33474 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33475 to scan using a specific profile, but rather use the SpamAssassin system-wide
33476 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33477 Rspamd does not use this setting. However, you must put something on the
33478 right-hand side.
33479
33480 The name allows you to use per-domain or per-user antispam profiles in
33481 principle, but this is not straightforward in practice, because a message may
33482 have multiple recipients, not necessarily all in the same domain. Because the
33483 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33484 read the contents of the message, the variables &$local_part$& and &$domain$&
33485 are not set.
33486 Careful enforcement of single-recipient messages
33487 (e.g. by responding with defer in the recipient ACL for all recipients
33488 after the first),
33489 or the use of PRDR,
33490 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33491 are needed to use this feature.
33492
33493 The right-hand side of the &%spam%& condition is expanded before being used, so
33494 you can put lookups or conditions there. When the right-hand side evaluates to
33495 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33496
33497
33498 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33499 large ones may cause significant performance degradation. As most spam messages
33500 are quite small, it is recommended that you do not scan the big ones. For
33501 example:
33502 .code
33503 deny message = This message was classified as SPAM
33504      condition = ${if < {$message_size}{10K}}
33505      spam = nobody
33506 .endd
33507
33508 The &%spam%& condition returns true if the threshold specified in the user's
33509 SpamAssassin profile has been matched or exceeded. If you want to use the
33510 &%spam%& condition for its side effects (see the variables below), you can make
33511 it always return &"true"& by appending &`:true`& to the username.
33512
33513 .cindex "spam scanning" "returned variables"
33514 When the &%spam%& condition is run, it sets up a number of expansion
33515 variables.
33516 Except for &$spam_report$&,
33517 these variables are saved with the received message so are
33518 available for use at delivery time.
33519
33520 .vlist
33521 .vitem &$spam_score$&
33522 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33523 for inclusion in log or reject messages.
33524
33525 .vitem &$spam_score_int$&
33526 The spam score of the message, multiplied by ten, as an integer value. For
33527 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33528 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33529 The integer value is useful for numeric comparisons in conditions.
33530
33531 .vitem &$spam_bar$&
33532 A string consisting of a number of &"+"& or &"-"& characters, representing the
33533 integer part of the spam score value. A spam score of 4.4 would have a
33534 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33535 headers, since MUAs can match on such strings. The maximum length of the
33536 spam bar is 50 characters.
33537
33538 .vitem &$spam_report$&
33539 A multiline text table, containing the full SpamAssassin report for the
33540 message. Useful for inclusion in headers or reject messages.
33541 This variable is only usable in a DATA-time ACL.
33542 Beware that SpamAssassin may return non-ASCII characters, especially
33543 when running in country-specific locales, which are not legal
33544 unencoded in headers.
33545
33546 .vitem &$spam_action$&
33547 For SpamAssassin either 'reject' or 'no action' depending on the
33548 spam score versus threshold.
33549 For Rspamd, the recommended action.
33550
33551 .endlist
33552
33553 The &%spam%& condition caches its results unless expansion in
33554 spamd_address was used. If you call it again with the same user name, it
33555 does not scan again, but rather returns the same values as before.
33556
33557 The &%spam%& condition returns DEFER if there is any error while running
33558 the message through SpamAssassin or if the expansion of spamd_address
33559 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33560 statement block), append &`/defer_ok`& to the right-hand side of the
33561 spam condition, like this:
33562 .code
33563 deny message = This message was classified as SPAM
33564      spam    = joe/defer_ok
33565 .endd
33566 This causes messages to be accepted even if there is a problem with &%spamd%&.
33567
33568 Here is a longer, commented example of the use of the &%spam%&
33569 condition:
33570 .code
33571 # put headers in all messages (no matter if spam or not)
33572 warn  spam = nobody:true
33573       add_header = X-Spam-Score: $spam_score ($spam_bar)
33574       add_header = X-Spam-Report: $spam_report
33575
33576 # add second subject line with *SPAM* marker when message
33577 # is over threshold
33578 warn  spam = nobody
33579       add_header = Subject: *SPAM* $h_Subject:
33580
33581 # reject spam at high scores (> 12)
33582 deny  message = This message scored $spam_score spam points.
33583       spam = nobody:true
33584       condition = ${if >{$spam_score_int}{120}{1}{0}}
33585 .endd
33586
33587
33588
33589 .section "Scanning MIME parts" "SECTscanmimepart"
33590 .cindex "content scanning" "MIME parts"
33591 .cindex "MIME content scanning"
33592 .oindex "&%acl_smtp_mime%&"
33593 .oindex "&%acl_not_smtp_mime%&"
33594 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33595 each MIME part of an SMTP message, including multipart types, in the sequence
33596 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33597 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33598 options may both refer to the same ACL if you want the same processing in both
33599 cases.
33600
33601 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33602 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33603 the case of a non-SMTP message. However, a MIME ACL is called only if the
33604 message contains a &'Content-Type:'& header line. When a call to a MIME
33605 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33606 result code is sent to the client. In the case of an SMTP message, the
33607 &%acl_smtp_data%& ACL is not called when this happens.
33608
33609 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33610 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33611 condition to match against the raw MIME part. You can also use the
33612 &%mime_regex%& condition to match against the decoded MIME part (see section
33613 &<<SECTscanregex>>&).
33614
33615 At the start of a MIME ACL, a number of variables are set from the header
33616 information for the relevant MIME part. These are described below. The contents
33617 of the MIME part are not by default decoded into a disk file except for MIME
33618 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33619 part into a disk file, you can use the &%decode%& condition. The general
33620 syntax is:
33621 .display
33622 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33623 .endd
33624 The right hand side is expanded before use. After expansion,
33625 the value can be:
33626
33627 .olist
33628 &"0"& or &"false"&, in which case no decoding is done.
33629 .next
33630 The string &"default"&. In that case, the file is put in the temporary
33631 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33632 a sequential filename consisting of the message id and a sequence number. The
33633 full path and name is available in &$mime_decoded_filename$& after decoding.
33634 .next
33635 A full path name starting with a slash. If the full name is an existing
33636 directory, it is used as a replacement for the default directory. The filename
33637 is then sequentially assigned. If the path does not exist, it is used as
33638 the full path and filename.
33639 .next
33640 If the string does not start with a slash, it is used as the
33641 filename, and the default path is then used.
33642 .endlist
33643 The &%decode%& condition normally succeeds. It is only false for syntax
33644 errors or unusual circumstances such as memory shortages. You can easily decode
33645 a file with its original, proposed filename using
33646 .code
33647 decode = $mime_filename
33648 .endd
33649 However, you should keep in mind that &$mime_filename$& might contain
33650 anything. If you place files outside of the default path, they are not
33651 automatically unlinked.
33652
33653 For RFC822 attachments (these are messages attached to messages, with a
33654 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33655 as for the primary message, only that the &$mime_is_rfc822$& expansion
33656 variable is set (see below). Attached messages are always decoded to disk
33657 before being checked, and the files are unlinked once the check is done.
33658
33659 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33660 used to match regular expressions against raw and decoded MIME parts,
33661 respectively. They are described in section &<<SECTscanregex>>&.
33662
33663 .cindex "MIME content scanning" "returned variables"
33664 The following list describes all expansion variables that are
33665 available in the MIME ACL:
33666
33667 .vlist
33668 .vitem &$mime_boundary$&
33669 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33670 have a boundary string, which is stored in this variable. If the current part
33671 has no boundary parameter in the &'Content-Type:'& header, this variable
33672 contains the empty string.
33673
33674 .vitem &$mime_charset$&
33675 This variable contains the character set identifier, if one was found in the
33676 &'Content-Type:'& header. Examples for charset identifiers are:
33677 .code
33678 us-ascii
33679 gb2312 (Chinese)
33680 iso-8859-1
33681 .endd
33682 Please note that this value is not normalized, so you should do matches
33683 case-insensitively.
33684
33685 .vitem &$mime_content_description$&
33686 This variable contains the normalized content of the &'Content-Description:'&
33687 header. It can contain a human-readable description of the parts content. Some
33688 implementations repeat the filename for attachments here, but they are usually
33689 only used for display purposes.
33690
33691 .vitem &$mime_content_disposition$&
33692 This variable contains the normalized content of the &'Content-Disposition:'&
33693 header. You can expect strings like &"attachment"& or &"inline"& here.
33694
33695 .vitem &$mime_content_id$&
33696 This variable contains the normalized content of the &'Content-ID:'& header.
33697 This is a unique ID that can be used to reference a part from another part.
33698
33699 .vitem &$mime_content_size$&
33700 This variable is set only after the &%decode%& modifier (see above) has been
33701 successfully run. It contains the size of the decoded part in kilobytes. The
33702 size is always rounded up to full kilobytes, so only a completely empty part
33703 has a &$mime_content_size$& of zero.
33704
33705 .vitem &$mime_content_transfer_encoding$&
33706 This variable contains the normalized content of the
33707 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33708 type. Typical values are &"base64"& and &"quoted-printable"&.
33709
33710 .vitem &$mime_content_type$&
33711 If the MIME part has a &'Content-Type:'& header, this variable contains its
33712 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33713 are some examples of popular MIME types, as they may appear in this variable:
33714 .code
33715 text/plain
33716 text/html
33717 application/octet-stream
33718 image/jpeg
33719 audio/midi
33720 .endd
33721 If the MIME part has no &'Content-Type:'& header, this variable contains the
33722 empty string.
33723
33724 .vitem &$mime_decoded_filename$&
33725 This variable is set only after the &%decode%& modifier (see above) has been
33726 successfully run. It contains the full path and filename of the file
33727 containing the decoded data.
33728 .endlist
33729
33730 .cindex "RFC 2047"
33731 .vlist
33732 .vitem &$mime_filename$&
33733 This is perhaps the most important of the MIME variables. It contains a
33734 proposed filename for an attachment, if one was found in either the
33735 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33736 RFC2047
33737 or RFC2231
33738 decoded, but no additional sanity checks are done.
33739  If no filename was
33740 found, this variable contains the empty string.
33741
33742 .vitem &$mime_is_coverletter$&
33743 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33744 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33745 content in the cover letter, while not restricting attachments at all.
33746
33747 The variable contains 1 (true) for a MIME part believed to be part of the
33748 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33749 follows:
33750
33751 .olist
33752 The outermost MIME part of a message is always a cover letter.
33753
33754 .next
33755 If a multipart/alternative or multipart/related MIME part is a cover letter,
33756 so are all MIME subparts within that multipart.
33757
33758 .next
33759 If any other multipart is a cover letter, the first subpart is a cover letter,
33760 and the rest are attachments.
33761
33762 .next
33763 All parts contained within an attachment multipart are attachments.
33764 .endlist olist
33765
33766 As an example, the following will ban &"HTML mail"& (including that sent with
33767 alternative plain text), while allowing HTML files to be attached. HTML
33768 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33769 .code
33770 deny message = HTML mail is not accepted here
33771 !condition = $mime_is_rfc822
33772 condition = $mime_is_coverletter
33773 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33774 .endd
33775 .vitem &$mime_is_multipart$&
33776 This variable has the value 1 (true) when the current part has the main type
33777 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33778 Since multipart entities only serve as containers for other parts, you may not
33779 want to carry out specific actions on them.
33780
33781 .vitem &$mime_is_rfc822$&
33782 This variable has the value 1 (true) if the current part is not a part of the
33783 checked message itself, but part of an attached message. Attached message
33784 decoding is fully recursive.
33785
33786 .vitem &$mime_part_count$&
33787 This variable is a counter that is raised for each processed MIME part. It
33788 starts at zero for the very first part (which is usually a multipart). The
33789 counter is per-message, so it is reset when processing RFC822 attachments (see
33790 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33791 complete, so you can use it in the DATA ACL to determine the number of MIME
33792 parts of a message. For non-MIME messages, this variable contains the value -1.
33793 .endlist
33794
33795
33796
33797 .section "Scanning with regular expressions" "SECTscanregex"
33798 .cindex "content scanning" "with regular expressions"
33799 .cindex "regular expressions" "content scanning with"
33800 You can specify your own custom regular expression matches on the full body of
33801 the message, or on individual MIME parts.
33802
33803 The &%regex%& condition takes one or more regular expressions as arguments and
33804 matches them against the full message (when called in the DATA ACL) or a raw
33805 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33806 linewise, with a maximum line length of 32K characters. That means you cannot
33807 have multiline matches with the &%regex%& condition.
33808
33809 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33810 to 32K of decoded content (the whole content at once, not linewise). If the
33811 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33812 is decoded automatically when &%mime_regex%& is executed (using default path
33813 and filename values). If the decoded data is larger than  32K, only the first
33814 32K characters are checked.
33815
33816 The regular expressions are passed as a colon-separated list. To include a
33817 literal colon, you must double it. Since the whole right-hand side string is
33818 expanded before being used, you must also escape dollar signs and backslashes
33819 with more backslashes, or use the &`\N`& facility to disable expansion.
33820 Here is a simple example that contains two regular expressions:
33821 .code
33822 deny message = contains blacklisted regex ($regex_match_string)
33823      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33824 .endd
33825 The conditions returns true if any one of the regular expressions matches. The
33826 &$regex_match_string$& expansion variable is then set up and contains the
33827 matching regular expression.
33828 The expansion variables &$regex1$& &$regex2$& etc
33829 are set to any substrings captured by the regular expression.
33830
33831 &*Warning*&: With large messages, these conditions can be fairly
33832 CPU-intensive.
33833
33834 .ecindex IIDcosca
33835
33836
33837
33838
33839 . ////////////////////////////////////////////////////////////////////////////
33840 . ////////////////////////////////////////////////////////////////////////////
33841
33842 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33843          "Local scan function"
33844 .scindex IIDlosca "&[local_scan()]& function" "description of"
33845 .cindex "customizing" "input scan using C function"
33846 .cindex "policy control" "by local scan function"
33847 In these days of email worms, viruses, and ever-increasing spam, some sites
33848 want to apply a lot of checking to messages before accepting them.
33849
33850 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33851 passing messages to external virus and spam scanning software. You can also do
33852 a certain amount in Exim itself through string expansions and the &%condition%&
33853 condition in the ACL that runs after the SMTP DATA command or the ACL for
33854 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33855
33856 To allow for further customization to a site's own requirements, there is the
33857 possibility of linking Exim with a private message scanning function, written
33858 in C. If you want to run code that is written in something other than C, you
33859 can of course use a little C stub to call it.
33860
33861 The local scan function is run once for every incoming message, at the point
33862 when Exim is just about to accept the message.
33863 It can therefore be used to control non-SMTP messages from local processes as
33864 well as messages arriving via SMTP.
33865
33866 Exim applies a timeout to calls of the local scan function, and there is an
33867 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33868 Zero means &"no timeout"&.
33869 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33870 before calling the local scan function, so that the most common types of crash
33871 are caught. If the timeout is exceeded or one of those signals is caught, the
33872 incoming message is rejected with a temporary error if it is an SMTP message.
33873 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33874 code. The incident is logged on the main and reject logs.
33875
33876
33877
33878 .section "Building Exim to use a local scan function" "SECID207"
33879 .cindex "&[local_scan()]& function" "building Exim to use"
33880 To make use of the local scan function feature, you must tell Exim where your
33881 function is before building Exim, by setting
33882 both HAVE_LOCAL_SCAN and
33883 LOCAL_SCAN_SOURCE in your
33884 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33885 directory, so you might set
33886 .code
33887 HAVE_LOCAL_SCAN=yes
33888 LOCAL_SCAN_SOURCE=Local/local_scan.c
33889 .endd
33890 for example. The function must be called &[local_scan()]&;
33891 .new
33892 the source file(s) for it should first #define LOCAL_SCAN
33893 and then #include "local_scan.h".
33894 .wen
33895 It is called by
33896 Exim after it has received a message, when the success return code is about to
33897 be sent. This is after all the ACLs have been run. The return code from your
33898 function controls whether the message is actually accepted or not. There is a
33899 commented template function (that just accepts the message) in the file
33900 _src/local_scan.c_.
33901
33902 If you want to make use of Exim's runtime configuration file to set options
33903 for your &[local_scan()]& function, you must also set
33904 .code
33905 LOCAL_SCAN_HAS_OPTIONS=yes
33906 .endd
33907 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33908
33909
33910
33911
33912 .section "API for local_scan()" "SECTapiforloc"
33913 .cindex "&[local_scan()]& function" "API description"
33914 .cindex &%dlfunc%& "API description"
33915 You must include this line near the start of your code:
33916 .code
33917 #define LOCAL_SCAN
33918 #include "local_scan.h"
33919 .endd
33920 This header file defines a number of variables and other values, and the
33921 prototype for the function itself. Exim is coded to use unsigned char values
33922 almost exclusively, and one of the things this header defines is a shorthand
33923 for &`unsigned char`& called &`uschar`&.
33924 It also makes available the following macro definitions, to simplify casting character
33925 strings and pointers to character strings:
33926 .code
33927 #define CS   (char *)
33928 #define CCS  (const char *)
33929 #define CSS  (char **)
33930 #define US   (unsigned char *)
33931 #define CUS  (const unsigned char *)
33932 #define USS  (unsigned char **)
33933 .endd
33934 The function prototype for &[local_scan()]& is:
33935 .code
33936 extern int local_scan(int fd, uschar **return_text);
33937 .endd
33938 The arguments are as follows:
33939
33940 .ilist
33941 &%fd%& is a file descriptor for the file that contains the body of the message
33942 (the -D file). The file is open for reading and writing, but updating it is not
33943 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33944
33945 The descriptor is positioned at character 19 of the file, which is the first
33946 character of the body itself, because the first 19 characters are the message
33947 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33948 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33949 case this changes in some future version.
33950 .next
33951 &%return_text%& is an address which you can use to return a pointer to a text
33952 string at the end of the function. The value it points to on entry is NULL.
33953 .endlist
33954
33955 The function must return an &%int%& value which is one of the following macros:
33956
33957 .vlist
33958 .vitem &`LOCAL_SCAN_ACCEPT`&
33959 .vindex "&$local_scan_data$&"
33960 The message is accepted. If you pass back a string of text, it is saved with
33961 the message, and made available in the variable &$local_scan_data$&. No
33962 newlines are permitted (if there are any, they are turned into spaces) and the
33963 maximum length of text is 1000 characters.
33964
33965 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33966 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33967 queued without immediate delivery, and is frozen.
33968
33969 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33970 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33971 queued without immediate delivery.
33972
33973 .vitem &`LOCAL_SCAN_REJECT`&
33974 The message is rejected; the returned text is used as an error message which is
33975 passed back to the sender and which is also logged. Newlines are permitted &--
33976 they cause a multiline response for SMTP rejections, but are converted to
33977 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33978 used.
33979
33980 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33981 The message is temporarily rejected; the returned text is used as an error
33982 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33983 problem"& is used.
33984
33985 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33986 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33987 message is not written to the reject log. It has the effect of unsetting the
33988 &%rejected_header%& log selector for just this rejection. If
33989 &%rejected_header%& is already unset (see the discussion of the
33990 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33991 same as LOCAL_SCAN_REJECT.
33992
33993 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33994 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33995 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33996 .endlist
33997
33998 If the message is not being received by interactive SMTP, rejections are
33999 reported by writing to &%stderr%& or by sending an email, as configured by the
34000 &%-oe%& command line options.
34001
34002
34003
34004 .section "Configuration options for local_scan()" "SECTconoptloc"
34005 .cindex "&[local_scan()]& function" "configuration options"
34006 It is possible to have option settings in the main configuration file
34007 that set values in static variables in the &[local_scan()]& module. If you
34008 want to do this, you must have the line
34009 .code
34010 LOCAL_SCAN_HAS_OPTIONS=yes
34011 .endd
34012 in your &_Local/Makefile_& when you build Exim. (This line is in
34013 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34014 file, you must define static variables to hold the option values, and a table
34015 to define them.
34016
34017 The table must be a vector called &%local_scan_options%&, of type
34018 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34019 and a pointer to the variable that holds the value. The entries must appear in
34020 alphabetical order. Following &%local_scan_options%& you must also define a
34021 variable called &%local_scan_options_count%& that contains the number of
34022 entries in the table. Here is a short example, showing two kinds of option:
34023 .code
34024 static int my_integer_option = 42;
34025 static uschar *my_string_option = US"a default string";
34026
34027 optionlist local_scan_options[] = {
34028   { "my_integer", opt_int,       &my_integer_option },
34029   { "my_string",  opt_stringptr, &my_string_option }
34030 };
34031
34032 int local_scan_options_count =
34033   sizeof(local_scan_options)/sizeof(optionlist);
34034 .endd
34035 The values of the variables can now be changed from Exim's runtime
34036 configuration file by including a local scan section as in this example:
34037 .code
34038 begin local_scan
34039 my_integer = 99
34040 my_string = some string of text...
34041 .endd
34042 The available types of option data are as follows:
34043
34044 .vlist
34045 .vitem &*opt_bool*&
34046 This specifies a boolean (true/false) option. The address should point to a
34047 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34048 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34049 whether such a variable has been set at all, you can initialize it to
34050 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34051 values.)
34052
34053 .vitem &*opt_fixed*&
34054 This specifies a fixed point number, such as is used for load averages.
34055 The address should point to a variable of type &`int`&. The value is stored
34056 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34057
34058 .vitem &*opt_int*&
34059 This specifies an integer; the address should point to a variable of type
34060 &`int`&. The value may be specified in any of the integer formats accepted by
34061 Exim.
34062
34063 .vitem &*opt_mkint*&
34064 This is the same as &%opt_int%&, except that when such a value is output in a
34065 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34066 printed with the suffix K or M.
34067
34068 .vitem &*opt_octint*&
34069 This also specifies an integer, but the value is always interpreted as an
34070 octal integer, whether or not it starts with the digit zero, and it is
34071 always output in octal.
34072
34073 .vitem &*opt_stringptr*&
34074 This specifies a string value; the address must be a pointer to a
34075 variable that points to a string (for example, of type &`uschar *`&).
34076
34077 .vitem &*opt_time*&
34078 This specifies a time interval value. The address must point to a variable of
34079 type &`int`&. The value that is placed there is a number of seconds.
34080 .endlist
34081
34082 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34083 out the values of all the &[local_scan()]& options.
34084
34085
34086
34087 .section "Available Exim variables" "SECID208"
34088 .cindex "&[local_scan()]& function" "available Exim variables"
34089 The header &_local_scan.h_& gives you access to a number of C variables. These
34090 are the only ones that are guaranteed to be maintained from release to release.
34091 Note, however, that you can obtain the value of any Exim expansion variable,
34092 including &$recipients$&, by calling &'expand_string()'&. The exported
34093 C variables are as follows:
34094
34095 .vlist
34096 .vitem &*int&~body_linecount*&
34097 This variable contains the number of lines in the message's body.
34098 It is not valid if the &%spool_files_wireformat%& option is used.
34099
34100 .vitem &*int&~body_zerocount*&
34101 This variable contains the number of binary zero bytes in the message's body.
34102 It is not valid if the &%spool_files_wireformat%& option is used.
34103
34104 .vitem &*unsigned&~int&~debug_selector*&
34105 This variable is set to zero when no debugging is taking place. Otherwise, it
34106 is a bitmap of debugging selectors. Two bits are identified for use in
34107 &[local_scan()]&; they are defined as macros:
34108
34109 .ilist
34110 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34111 testing option that is not privileged &-- any caller may set it. All the
34112 other selector bits can be set only by admin users.
34113
34114 .next
34115 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34116 by the &`+local_scan`& debug selector. It is not included in the default set
34117 of debugging bits.
34118 .endlist ilist
34119
34120 Thus, to write to the debugging output only when &`+local_scan`& has been
34121 selected, you should use code like this:
34122 .code
34123 if ((debug_selector & D_local_scan) != 0)
34124   debug_printf("xxx", ...);
34125 .endd
34126 .vitem &*uschar&~*expand_string_message*&
34127 After a failing call to &'expand_string()'& (returned value NULL), the
34128 variable &%expand_string_message%& contains the error message, zero-terminated.
34129
34130 .vitem &*header_line&~*header_list*&
34131 A pointer to a chain of header lines. The &%header_line%& structure is
34132 discussed below.
34133
34134 .vitem &*header_line&~*header_last*&
34135 A pointer to the last of the header lines.
34136
34137 .vitem &*uschar&~*headers_charset*&
34138 The value of the &%headers_charset%& configuration option.
34139
34140 .vitem &*BOOL&~host_checking*&
34141 This variable is TRUE during a host checking session that is initiated by the
34142 &%-bh%& command line option.
34143
34144 .vitem &*uschar&~*interface_address*&
34145 The IP address of the interface that received the message, as a string. This
34146 is NULL for locally submitted messages.
34147
34148 .vitem &*int&~interface_port*&
34149 The port on which this message was received. When testing with the &%-bh%&
34150 command line option, the value of this variable is -1 unless a port has been
34151 specified via the &%-oMi%& option.
34152
34153 .vitem &*uschar&~*message_id*&
34154 This variable contains Exim's message id for the incoming message (the value of
34155 &$message_exim_id$&) as a zero-terminated string.
34156
34157 .vitem &*uschar&~*received_protocol*&
34158 The name of the protocol by which the message was received.
34159
34160 .vitem &*int&~recipients_count*&
34161 The number of accepted recipients.
34162
34163 .vitem &*recipient_item&~*recipients_list*&
34164 .cindex "recipient" "adding in local scan"
34165 .cindex "recipient" "removing in local scan"
34166 The list of accepted recipients, held in a vector of length
34167 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34168 can add additional recipients by calling &'receive_add_recipient()'& (see
34169 below). You can delete recipients by removing them from the vector and
34170 adjusting the value in &%recipients_count%&. In particular, by setting
34171 &%recipients_count%& to zero you remove all recipients. If you then return the
34172 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34173 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34174 and then call &'receive_add_recipient()'& as often as needed.
34175
34176 .vitem &*uschar&~*sender_address*&
34177 The envelope sender address. For bounce messages this is the empty string.
34178
34179 .vitem &*uschar&~*sender_host_address*&
34180 The IP address of the sending host, as a string. This is NULL for
34181 locally-submitted messages.
34182
34183 .vitem &*uschar&~*sender_host_authenticated*&
34184 The name of the authentication mechanism that was used, or NULL if the message
34185 was not received over an authenticated SMTP connection.
34186
34187 .vitem &*uschar&~*sender_host_name*&
34188 The name of the sending host, if known.
34189
34190 .vitem &*int&~sender_host_port*&
34191 The port on the sending host.
34192
34193 .vitem &*BOOL&~smtp_input*&
34194 This variable is TRUE for all SMTP input, including BSMTP.
34195
34196 .vitem &*BOOL&~smtp_batched_input*&
34197 This variable is TRUE for BSMTP input.
34198
34199 .vitem &*int&~store_pool*&
34200 The contents of this variable control which pool of memory is used for new
34201 requests. See section &<<SECTmemhanloc>>& for details.
34202 .endlist
34203
34204
34205 .section "Structure of header lines" "SECID209"
34206 The &%header_line%& structure contains the members listed below.
34207 You can add additional header lines by calling the &'header_add()'& function
34208 (see below). You can cause header lines to be ignored (deleted) by setting
34209 their type to *.
34210
34211
34212 .vlist
34213 .vitem &*struct&~header_line&~*next*&
34214 A pointer to the next header line, or NULL for the last line.
34215
34216 .vitem &*int&~type*&
34217 A code identifying certain headers that Exim recognizes. The codes are printing
34218 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34219 Notice in particular that any header line whose type is * is not transmitted
34220 with the message. This flagging is used for header lines that have been
34221 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34222 lines.) Effectively, * means &"deleted"&.
34223
34224 .vitem &*int&~slen*&
34225 The number of characters in the header line, including the terminating and any
34226 internal newlines.
34227
34228 .vitem &*uschar&~*text*&
34229 A pointer to the text of the header. It always ends with a newline, followed by
34230 a zero byte. Internal newlines are preserved.
34231 .endlist
34232
34233
34234
34235 .section "Structure of recipient items" "SECID210"
34236 The &%recipient_item%& structure contains these members:
34237
34238 .vlist
34239 .vitem &*uschar&~*address*&
34240 This is a pointer to the recipient address as it was received.
34241
34242 .vitem &*int&~pno*&
34243 This is used in later Exim processing when top level addresses are created by
34244 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34245 and must always contain -1 at this stage.
34246
34247 .vitem &*uschar&~*errors_to*&
34248 If this value is not NULL, bounce messages caused by failing to deliver to the
34249 recipient are sent to the address it contains. In other words, it overrides the
34250 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34251 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34252 an unqualified address, Exim qualifies it using the domain from
34253 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34254 is NULL for all recipients.
34255 .endlist
34256
34257
34258
34259 .section "Available Exim functions" "SECID211"
34260 .cindex "&[local_scan()]& function" "available Exim functions"
34261 The header &_local_scan.h_& gives you access to a number of Exim functions.
34262 These are the only ones that are guaranteed to be maintained from release to
34263 release:
34264
34265 .vlist
34266 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34267        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34268
34269 This function creates a child process that runs the command specified by
34270 &%argv%&. The environment for the process is specified by &%envp%&, which can
34271 be NULL if no environment variables are to be passed. A new umask is supplied
34272 for the process in &%newumask%&.
34273
34274 Pipes to the standard input and output of the new process are set up
34275 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34276 standard error is cloned to the standard output. If there are any file
34277 descriptors &"in the way"& in the new process, they are closed. If the final
34278 argument is TRUE, the new process is made into a process group leader.
34279
34280 The function returns the pid of the new process, or -1 if things go wrong.
34281
34282 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34283 This function waits for a child process to terminate, or for a timeout (in
34284 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34285 return value is as follows:
34286
34287 .ilist
34288 >= 0
34289
34290 The process terminated by a normal exit and the value is the process
34291 ending status.
34292
34293 .next
34294 < 0 and > &--256
34295
34296 The process was terminated by a signal and the value is the negation of the
34297 signal number.
34298
34299 .next
34300 &--256
34301
34302 The process timed out.
34303 .next
34304 &--257
34305
34306 The was some other error in wait(); &%errno%& is still set.
34307 .endlist
34308
34309 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34310 This function provide you with a means of submitting a new message to
34311 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34312 want, but this packages it all up for you.) The function creates a pipe,
34313 forks a subprocess that is running
34314 .code
34315 exim -t -oem -oi -f <>
34316 .endd
34317 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34318 that is connected to the standard input. The yield of the function is the PID
34319 of the subprocess. You can then write a message to the file descriptor, with
34320 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34321
34322 When you have finished, call &'child_close()'& to wait for the process to
34323 finish and to collect its ending status. A timeout value of zero is usually
34324 fine in this circumstance. Unless you have made a mistake with the recipient
34325 addresses, you should get a return code of zero.
34326
34327
34328 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34329        *sender_authentication)*&
34330 This function is a more sophisticated version of &'child_open()'&. The command
34331 that it runs is:
34332 .display
34333 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34334 .endd
34335 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34336
34337
34338 .vitem &*void&~debug_printf(char&~*,&~...)*&
34339 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34340 output is written to the standard error stream. If no debugging is selected,
34341 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34342 conditional on the &`local_scan`& debug selector by coding like this:
34343 .code
34344 if ((debug_selector & D_local_scan) != 0)
34345   debug_printf("xxx", ...);
34346 .endd
34347
34348 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34349 This is an interface to Exim's string expansion code. The return value is the
34350 expanded string, or NULL if there was an expansion failure.
34351 The C variable &%expand_string_message%& contains an error message after an
34352 expansion failure. If expansion does not change the string, the return value is
34353 the pointer to the input string. Otherwise, the return value points to a new
34354 block of memory that was obtained by a call to &'store_get()'&. See section
34355 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34356
34357 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34358 This function allows you to an add additional header line at the end of the
34359 existing ones. The first argument is the type, and should normally be a space
34360 character. The second argument is a format string and any number of
34361 substitution arguments as for &[sprintf()]&. You may include internal newlines
34362 if you want, and you must ensure that the string ends with a newline.
34363
34364 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34365         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34366 This function adds a new header line at a specified point in the header
34367 chain. The header itself is specified as for &'header_add()'&.
34368
34369 If &%name%& is NULL, the new header is added at the end of the chain if
34370 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34371 NULL, the header lines are searched for the first non-deleted header that
34372 matches the name. If one is found, the new header is added before it if
34373 &%after%& is false. If &%after%& is true, the new header is added after the
34374 found header and any adjacent subsequent ones with the same name (even if
34375 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34376 option controls where the header is added. If it is true, addition is at the
34377 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34378 headers, or at the top if there are no &'Received:'& headers, you could use
34379 .code
34380 header_add_at_position(TRUE, US"Received", TRUE,
34381   ' ', "X-xxx: ...");
34382 .endd
34383 Normally, there is always at least one non-deleted &'Received:'& header, but
34384 there may not be if &%received_header_text%& expands to an empty string.
34385
34386
34387 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34388 This function removes header lines. If &%occurrence%& is zero or negative, all
34389 occurrences of the header are removed. If occurrence is greater than zero, that
34390 particular instance of the header is removed. If no header(s) can be found that
34391 match the specification, the function does nothing.
34392
34393
34394 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34395         int&~length,&~BOOL&~notdel)*&"
34396 This function tests whether the given header has the given name. It is not just
34397 a string comparison, because white space is permitted between the name and the
34398 colon. If the &%notdel%& argument is true, a false return is forced for all
34399 &"deleted"& headers; otherwise they are not treated specially. For example:
34400 .code
34401 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34402 .endd
34403 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34404 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34405 This function base64-encodes a string, which is passed by address and length.
34406 The text may contain bytes of any value, including zero. The result is passed
34407 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34408 zero-terminated.
34409
34410 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34411 This function decodes a base64-encoded string. Its arguments are a
34412 zero-terminated base64-encoded string and the address of a variable that is set
34413 to point to the result, which is in dynamic memory. The length of the decoded
34414 string is the yield of the function. If the input is invalid base64 data, the
34415 yield is -1. A zero byte is added to the end of the output string to make it
34416 easy to interpret as a C string (assuming it contains no zeros of its own). The
34417 added zero byte is not included in the returned count.
34418
34419 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34420 This function checks for a match in a domain list. Domains are always
34421 matched caselessly. The return value is one of the following:
34422 .display
34423 &`OK     `& match succeeded
34424 &`FAIL   `& match failed
34425 &`DEFER  `& match deferred
34426 .endd
34427 DEFER is usually caused by some kind of lookup defer, such as the
34428 inability to contact a database.
34429
34430 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34431         BOOL&~caseless)*&"
34432 This function checks for a match in a local part list. The third argument
34433 controls case-sensitivity. The return values are as for
34434 &'lss_match_domain()'&.
34435
34436 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34437         BOOL&~caseless)*&"
34438 This function checks for a match in an address list. The third argument
34439 controls the case-sensitivity of the local part match. The domain is always
34440 matched caselessly. The return values are as for &'lss_match_domain()'&.
34441
34442 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34443         uschar&~*list)*&"
34444 This function checks for a match in a host list. The most common usage is
34445 expected to be
34446 .code
34447 lss_match_host(sender_host_name, sender_host_address, ...)
34448 .endd
34449 .vindex "&$sender_host_address$&"
34450 An empty address field matches an empty item in the host list. If the host name
34451 is NULL, the name corresponding to &$sender_host_address$& is automatically
34452 looked up if a host name is required to match an item in the list. The return
34453 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34454 returns ERROR in the case when it had to look up a host name, but the lookup
34455 failed.
34456
34457 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34458         *format,&~...)*&"
34459 This function writes to Exim's log files. The first argument should be zero (it
34460 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34461 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34462 them. It specifies to which log or logs the message is written. The remaining
34463 arguments are a format and relevant insertion arguments. The string should not
34464 contain any newlines, not even at the end.
34465
34466
34467 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34468 This function adds an additional recipient to the message. The first argument
34469 is the recipient address. If it is unqualified (has no domain), it is qualified
34470 with the &%qualify_recipient%& domain. The second argument must always be -1.
34471
34472 This function does not allow you to specify a private &%errors_to%& address (as
34473 described with the structure of &%recipient_item%& above), because it pre-dates
34474 the addition of that field to the structure. However, it is easy to add such a
34475 value afterwards. For example:
34476 .code
34477  receive_add_recipient(US"monitor@mydom.example", -1);
34478  recipients_list[recipients_count-1].errors_to =
34479    US"postmaster@mydom.example";
34480 .endd
34481
34482 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34483 This is a convenience function to remove a named recipient from the list of
34484 recipients. It returns true if a recipient was removed, and false if no
34485 matching recipient could be found. The argument must be a complete email
34486 address.
34487 .endlist
34488
34489
34490 .cindex "RFC 2047"
34491 .vlist
34492 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34493   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34494 This function decodes strings that are encoded according to RFC 2047. Typically
34495 these are the contents of header lines. First, each &"encoded word"& is decoded
34496 from the Q or B encoding into a byte-string. Then, if provided with the name of
34497 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34498 made  to translate the result to the named character set. If this fails, the
34499 binary string is returned with an error message.
34500
34501 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34502 maximum MIME word length is enforced. The third argument is the target
34503 encoding, or NULL if no translation is wanted.
34504
34505 .cindex "binary zero" "in RFC 2047 decoding"
34506 .cindex "RFC 2047" "binary zero in"
34507 If a binary zero is encountered in the decoded string, it is replaced by the
34508 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34509 not be 0 because header lines are handled as zero-terminated strings.
34510
34511 The function returns the result of processing the string, zero-terminated; if
34512 &%lenptr%& is not NULL, the length of the result is set in the variable to
34513 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34514
34515 If an error is encountered, the function returns NULL and uses the &%error%&
34516 argument to return an error message. The variable pointed to by &%error%& is
34517 set to NULL if there is no error; it may be set non-NULL even when the function
34518 returns a non-NULL value if decoding was successful, but there was a problem
34519 with translation.
34520
34521
34522 .vitem &*int&~smtp_fflush(void)*&
34523 This function is used in conjunction with &'smtp_printf()'&, as described
34524 below.
34525
34526 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34527 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34528 output stream. You should use this function only when there is an SMTP output
34529 stream, that is, when the incoming message is being received via interactive
34530 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34531 is FALSE. If you want to test for an incoming message from another host (as
34532 opposed to a local process that used the &%-bs%& command line option), you can
34533 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34534 is involved.
34535
34536 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34537 output function, so it can be used for all forms of SMTP connection.
34538
34539 The second argument is used to request that the data be buffered
34540 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34541 This is advisory only, but likely to save on system-calls and packets
34542 sent when a sequence of calls to the function are made.
34543
34544 The argument was added in Exim version 4.90 - changing the API/ABI.
34545 Nobody noticed until 4.93 was imminent, at which point the
34546 ABI version number was incremented.
34547
34548 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34549 must start with an appropriate response code: 550 if you are going to return
34550 LOCAL_SCAN_REJECT, 451 if you are going to return
34551 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34552 initial lines of a multi-line response, the code must be followed by a hyphen
34553 to indicate that the line is not the final response line. You must also ensure
34554 that the lines you write terminate with CRLF. For example:
34555 .code
34556 smtp_printf("550-this is some extra info\r\n");
34557 return LOCAL_SCAN_REJECT;
34558 .endd
34559 Note that you can also create multi-line responses by including newlines in
34560 the data returned via the &%return_text%& argument. The added value of using
34561 &'smtp_printf()'& is that, for instance, you could introduce delays between
34562 multiple output lines.
34563
34564 The &'smtp_printf()'& function does not return any error indication, because it
34565 does not
34566 guarantee a flush of
34567 pending output, and therefore does not test
34568 the state of the stream. (In the main code of Exim, flushing and error
34569 detection is done when Exim is ready for the next SMTP input command.) If
34570 you want to flush the output and check for an error (for example, the
34571 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34572 arguments. It flushes the output stream, and returns a non-zero value if there
34573 is an error.
34574
34575 .new
34576 .vitem &*void&~*store_get(int,BOOL)*&
34577 This function accesses Exim's internal store (memory) manager. It gets a new
34578 chunk of memory whose size is given by the first argument.
34579 The second argument should be given as TRUE if the memory will be used for
34580 data possibly coming from an attacker (eg. the message content),
34581 FALSE if it is locally-sourced.
34582 Exim bombs out if it ever
34583 runs out of memory. See the next section for a discussion of memory handling.
34584 .wen
34585
34586 .vitem &*void&~*store_get_perm(int,BOOL)*&
34587 This function is like &'store_get()'&, but it always gets memory from the
34588 permanent pool. See the next section for a discussion of memory handling.
34589
34590 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34591 See below.
34592
34593 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34594 See below.
34595
34596 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34597 These three functions create strings using Exim's dynamic memory facilities.
34598 The first makes a copy of an entire string. The second copies up to a maximum
34599 number of characters, indicated by the second argument. The third uses a format
34600 and insertion arguments to create a new string. In each case, the result is a
34601 pointer to a new string in the current memory pool. See the next section for
34602 more discussion.
34603 .endlist
34604
34605
34606
34607 .section "More about Exim's memory handling" "SECTmemhanloc"
34608 .cindex "&[local_scan()]& function" "memory handling"
34609 No function is provided for freeing memory, because that is never needed.
34610 The dynamic memory that Exim uses when receiving a message is automatically
34611 recycled if another message is received by the same process (this applies only
34612 to incoming SMTP connections &-- other input methods can supply only one
34613 message at a time). After receiving the last message, a reception process
34614 terminates.
34615
34616 Because it is recycled, the normal dynamic memory cannot be used for holding
34617 data that must be preserved over a number of incoming messages on the same SMTP
34618 connection. However, Exim in fact uses two pools of dynamic memory; the second
34619 one is not recycled, and can be used for this purpose.
34620
34621 If you want to allocate memory that remains available for subsequent messages
34622 in the same SMTP connection, you should set
34623 .code
34624 store_pool = POOL_PERM
34625 .endd
34626 before calling the function that does the allocation. There is no need to
34627 restore the value if you do not need to; however, if you do want to revert to
34628 the normal pool, you can either restore the previous value of &%store_pool%& or
34629 set it explicitly to POOL_MAIN.
34630
34631 The pool setting applies to all functions that get dynamic memory, including
34632 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34633 There is also a convenience function called &'store_get_perm()'& that gets a
34634 block of memory from the permanent pool while preserving the value of
34635 &%store_pool%&.
34636 .ecindex IIDlosca
34637
34638
34639
34640
34641 . ////////////////////////////////////////////////////////////////////////////
34642 . ////////////////////////////////////////////////////////////////////////////
34643
34644 .chapter "System-wide message filtering" "CHAPsystemfilter"
34645 .scindex IIDsysfil1 "filter" "system filter"
34646 .scindex IIDsysfil2 "filtering all mail"
34647 .scindex IIDsysfil3 "system filter"
34648 The previous chapters (on ACLs and the local scan function) describe checks
34649 that can be applied to messages before they are accepted by a host. There is
34650 also a mechanism for checking messages once they have been received, but before
34651 they are delivered. This is called the &'system filter'&.
34652
34653 The system filter operates in a similar manner to users' filter files, but it
34654 is run just once per message (however many recipients the message has).
34655 It should not normally be used as a substitute for routing, because &%deliver%&
34656 commands in a system router provide new envelope recipient addresses.
34657 The system filter must be an Exim filter. It cannot be a Sieve filter.
34658
34659 The system filter is run at the start of a delivery attempt, before any routing
34660 is done. If a message fails to be completely delivered at the first attempt,
34661 the system filter is run again at the start of every retry.
34662 If you want your filter to do something only once per message, you can make use
34663 of the &%first_delivery%& condition in an &%if%& command in the filter to
34664 prevent it happening on retries.
34665
34666 .vindex "&$domain$&"
34667 .vindex "&$local_part$&"
34668 &*Warning*&: Because the system filter runs just once, variables that are
34669 specific to individual recipient addresses, such as &$local_part$& and
34670 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34671 you want to run a centrally-specified filter for each recipient address
34672 independently, you can do so by setting up a suitable &(redirect)& router, as
34673 described in section &<<SECTperaddfil>>& below.
34674
34675
34676 .section "Specifying a system filter" "SECID212"
34677 .cindex "uid (user id)" "system filter"
34678 .cindex "gid (group id)" "system filter"
34679 The name of the file that contains the system filter must be specified by
34680 setting &%system_filter%&. If you want the filter to run under a uid and gid
34681 other than root, you must also set &%system_filter_user%& and
34682 &%system_filter_group%& as appropriate. For example:
34683 .code
34684 system_filter = /etc/mail/exim.filter
34685 system_filter_user = exim
34686 .endd
34687 If a system filter generates any deliveries directly to files or pipes (via the
34688 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34689 specified by setting &%system_filter_file_transport%& and
34690 &%system_filter_pipe_transport%&, respectively. Similarly,
34691 &%system_filter_reply_transport%& must be set to handle any messages generated
34692 by the &%reply%& command.
34693
34694
34695 .section "Testing a system filter" "SECID213"
34696 You can run simple tests of a system filter in the same way as for a user
34697 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34698 are permitted only in system filters are recognized.
34699
34700 If you want to test the combined effect of a system filter and a user filter,
34701 you can use both &%-bF%& and &%-bf%& on the same command line.
34702
34703
34704
34705 .section "Contents of a system filter" "SECID214"
34706 The language used to specify system filters is the same as for users' filter
34707 files. It is described in the separate end-user document &'Exim's interface to
34708 mail filtering'&. However, there are some additional features that are
34709 available only in system filters; these are described in subsequent sections.
34710 If they are encountered in a user's filter file or when testing with &%-bf%&,
34711 they cause errors.
34712
34713 .cindex "frozen messages" "manual thaw; testing in filter"
34714 There are two special conditions which, though available in users' filter
34715 files, are designed for use in system filters. The condition &%first_delivery%&
34716 is true only for the first attempt at delivering a message, and
34717 &%manually_thawed%& is true only if the message has been frozen, and
34718 subsequently thawed by an admin user. An explicit forced delivery counts as a
34719 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34720
34721 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34722 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34723 succeed, it will not be tried again.
34724 If you want Exim to retry an unseen delivery until it succeeds, you should
34725 arrange to set it up every time the filter runs.
34726
34727 When a system filter finishes running, the values of the variables &$n0$& &--
34728 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34729 users' filter files. Thus a system filter can, for example, set up &"scores"&
34730 to which users' filter files can refer.
34731
34732
34733
34734 .section "Additional variable for system filters" "SECID215"
34735 .vindex "&$recipients$&"
34736 The expansion variable &$recipients$&, containing a list of all the recipients
34737 of the message (separated by commas and white space), is available in system
34738 filters. It is not available in users' filters for privacy reasons.
34739
34740
34741
34742 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34743 .cindex "freezing messages"
34744 .cindex "message" "freezing"
34745 .cindex "message" "forced failure"
34746 .cindex "&%fail%&" "in system filter"
34747 .cindex "&%freeze%& in system filter"
34748 .cindex "&%defer%& in system filter"
34749 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34750 always available in system filters, but are not normally enabled in users'
34751 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34752 for the &(redirect)& router.) These commands can optionally be followed by the
34753 word &%text%& and a string containing an error message, for example:
34754 .code
34755 fail text "this message looks like spam to me"
34756 .endd
34757 The keyword &%text%& is optional if the next character is a double quote.
34758
34759 The &%defer%& command defers delivery of the original recipients of the
34760 message. The &%fail%& command causes all the original recipients to be failed,
34761 and a bounce message to be created. The &%freeze%& command suspends all
34762 delivery attempts for the original recipients. In all cases, any new deliveries
34763 that are specified by the filter are attempted as normal after the filter has
34764 run.
34765
34766 The &%freeze%& command is ignored if the message has been manually unfrozen and
34767 not manually frozen since. This means that automatic freezing by a system
34768 filter can be used as a way of checking out suspicious messages. If a message
34769 is found to be all right, manually unfreezing it allows it to be delivered.
34770
34771 .cindex "log" "&%fail%& command log line"
34772 .cindex "&%fail%&" "log line; reducing"
34773 The text given with a fail command is used as part of the bounce message as
34774 well as being written to the log. If the message is quite long, this can fill
34775 up a lot of log space when such failures are common. To reduce the size of the
34776 log message, Exim interprets the text in a special way if it starts with the
34777 two characters &`<<`& and contains &`>>`& later. The text between these two
34778 strings is written to the log, and the rest of the text is used in the bounce
34779 message. For example:
34780 .code
34781 fail "<<filter test 1>>Your message is rejected \
34782      because it contains attachments that we are \
34783      not prepared to receive."
34784 .endd
34785
34786 .cindex "loop" "caused by &%fail%&"
34787 Take great care with the &%fail%& command when basing the decision to fail on
34788 the contents of the message, because the bounce message will of course include
34789 the contents of the original message and will therefore trigger the &%fail%&
34790 command again (causing a mail loop) unless steps are taken to prevent this.
34791 Testing the &%error_message%& condition is one way to prevent this. You could
34792 use, for example
34793 .code
34794 if $message_body contains "this is spam" and not error_message
34795 then fail text "spam is not wanted here" endif
34796 .endd
34797 though of course that might let through unwanted bounce messages. The
34798 alternative is clever checking of the body and/or headers to detect bounces
34799 generated by the filter.
34800
34801 The interpretation of a system filter file ceases after a
34802 &%defer%&,
34803 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34804 set up earlier in the filter file are honoured, so you can use a sequence such
34805 as
34806 .code
34807 mail ...
34808 freeze
34809 .endd
34810 to send a specified message when the system filter is freezing (or deferring or
34811 failing) a message. The normal deliveries for the message do not, of course,
34812 take place.
34813
34814
34815
34816 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34817 .cindex "header lines" "adding; in system filter"
34818 .cindex "header lines" "removing; in system filter"
34819 .cindex "filter" "header lines; adding/removing"
34820 Two filter commands that are available only in system filters are:
34821 .code
34822 headers add <string>
34823 headers remove <string>
34824 .endd
34825 The argument for the &%headers add%& is a string that is expanded and then
34826 added to the end of the message's headers. It is the responsibility of the
34827 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34828 space is ignored, and if the string is otherwise empty, or if the expansion is
34829 forced to fail, the command has no effect.
34830
34831 You can use &"\n"& within the string, followed by white space, to specify
34832 continued header lines. More than one header may be added in one command by
34833 including &"\n"& within the string without any following white space. For
34834 example:
34835 .code
34836 headers add "X-header-1: ....\n  \
34837              continuation of X-header-1 ...\n\
34838              X-header-2: ...."
34839 .endd
34840 Note that the header line continuation white space after the first newline must
34841 be placed before the backslash that continues the input string, because white
34842 space after input continuations is ignored.
34843
34844 The argument for &%headers remove%& is a colon-separated list of header names.
34845 This command applies only to those headers that are stored with the message;
34846 those that are added at delivery time (such as &'Envelope-To:'& and
34847 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34848 header with the same name, they are all removed.
34849
34850 The &%headers%& command in a system filter makes an immediate change to the set
34851 of header lines that was received with the message (with possible additions
34852 from ACL processing). Subsequent commands in the system filter operate on the
34853 modified set, which also forms the basis for subsequent message delivery.
34854 Unless further modified during routing or transporting, this set of headers is
34855 used for all recipients of the message.
34856
34857 During routing and transporting, the variables that refer to the contents of
34858 header lines refer only to those lines that are in this set. Thus, header lines
34859 that are added by a system filter are visible to users' filter files and to all
34860 routers and transports. This contrasts with the manipulation of header lines by
34861 routers and transports, which is not immediate, but which instead is saved up
34862 until the message is actually being written (see section
34863 &<<SECTheadersaddrem>>&).
34864
34865 If the message is not delivered at the first attempt, header lines that were
34866 added by the system filter are stored with the message, and so are still
34867 present at the next delivery attempt. Header lines that were removed are still
34868 present, but marked &"deleted"& so that they are not transported with the
34869 message. For this reason, it is usual to make the &%headers%& command
34870 conditional on &%first_delivery%& so that the set of header lines is not
34871 modified more than once.
34872
34873 Because header modification in a system filter acts immediately, you have to
34874 use an indirect approach if you want to modify the contents of a header line.
34875 For example:
34876 .code
34877 headers add "Old-Subject: $h_subject:"
34878 headers remove "Subject"
34879 headers add "Subject: new subject (was: $h_old-subject:)"
34880 headers remove "Old-Subject"
34881 .endd
34882
34883
34884
34885 .section "Setting an errors address in a system filter" "SECID217"
34886 .cindex "envelope from"
34887 .cindex "envelope sender"
34888 In a system filter, if a &%deliver%& command is followed by
34889 .code
34890 errors_to <some address>
34891 .endd
34892 in order to change the envelope sender (and hence the error reporting) for that
34893 delivery, any address may be specified. (In a user filter, only the current
34894 user's address can be set.) For example, if some mail is being monitored, you
34895 might use
34896 .code
34897 unseen deliver monitor@spying.example errors_to root@local.example
34898 .endd
34899 to take a copy which would not be sent back to the normal error reporting
34900 address if its delivery failed.
34901
34902
34903
34904 .section "Per-address filtering" "SECTperaddfil"
34905 .vindex "&$domain$&"
34906 .vindex "&$local_part$&"
34907 In contrast to the system filter, which is run just once per message for each
34908 delivery attempt, it is also possible to set up a system-wide filtering
34909 operation that runs once for each recipient address. In this case, variables
34910 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34911 filter file could be made dependent on them. This is an example of a router
34912 which implements such a filter:
34913 .code
34914 central_filter:
34915   check_local_user
34916   driver = redirect
34917   domains = +local_domains
34918   file = /central/filters/$local_part
34919   no_verify
34920   allow_filter
34921   allow_freeze
34922 .endd
34923 The filter is run in a separate process under its own uid. Therefore, either
34924 &%check_local_user%& must be set (as above), in which case the filter is run as
34925 the local user, or the &%user%& option must be used to specify which user to
34926 use. If both are set, &%user%& overrides.
34927
34928 Care should be taken to ensure that none of the commands in the filter file
34929 specify a significant delivery if the message is to go on to be delivered to
34930 its intended recipient. The router will not then claim to have dealt with the
34931 address, so it will be passed on to subsequent routers to be delivered in the
34932 normal way.
34933 .ecindex IIDsysfil1
34934 .ecindex IIDsysfil2
34935 .ecindex IIDsysfil3
34936
34937
34938
34939
34940
34941
34942 . ////////////////////////////////////////////////////////////////////////////
34943 . ////////////////////////////////////////////////////////////////////////////
34944
34945 .chapter "Message processing" "CHAPmsgproc"
34946 .scindex IIDmesproc "message" "general processing"
34947 Exim performs various transformations on the sender and recipient addresses of
34948 all messages that it handles, and also on the messages' header lines. Some of
34949 these are optional and configurable, while others always take place. All of
34950 this processing, except rewriting as a result of routing, and the addition or
34951 removal of header lines while delivering, happens when a message is received,
34952 before it is placed on Exim's queue.
34953
34954 Some of the automatic processing takes place by default only for
34955 &"locally-originated"& messages. This adjective is used to describe messages
34956 that are not received over TCP/IP, but instead are passed to an Exim process on
34957 its standard input. This includes the interactive &"local SMTP"& case that is
34958 set up by the &%-bs%& command line option.
34959
34960 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34961 or ::1) are not considered to be locally-originated. Exim does not treat the
34962 loopback interface specially in any way.
34963
34964 If you want the loopback interface to be treated specially, you must ensure
34965 that there are appropriate entries in your ACLs.
34966
34967
34968
34969
34970 .section "Submission mode for non-local messages" "SECTsubmodnon"
34971 .cindex "message" "submission"
34972 .cindex "submission mode"
34973 Processing that happens automatically for locally-originated messages (unless
34974 &%suppress_local_fixups%& is set) can also be requested for messages that are
34975 received over TCP/IP. The term &"submission mode"& is used to describe this
34976 state. Submission mode is set by the modifier
34977 .code
34978 control = submission
34979 .endd
34980 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34981 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34982 a local submission, and is normally used when the source of the message is
34983 known to be an MUA running on a client host (as opposed to an MTA). For
34984 example, to set submission mode for messages originating on the IPv4 loopback
34985 interface, you could include the following in the MAIL ACL:
34986 .code
34987 warn  hosts = 127.0.0.1
34988       control = submission
34989 .endd
34990 .cindex "&%sender_retain%& submission option"
34991 There are some options that can be used when setting submission mode. A slash
34992 is used to separate options. For example:
34993 .code
34994 control = submission/sender_retain
34995 .endd
34996 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34997 true and &%local_from_check%& false for the current incoming message. The first
34998 of these allows an existing &'Sender:'& header in the message to remain, and
34999 the second suppresses the check to ensure that &'From:'& matches the
35000 authenticated sender. With this setting, Exim still fixes up messages by adding
35001 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35002 attempt to check sender authenticity in header lines.
35003
35004 When &%sender_retain%& is not set, a submission mode setting may specify a
35005 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35006 example:
35007 .code
35008 control = submission/domain=some.domain
35009 .endd
35010 The domain may be empty. How this value is used is described in sections
35011 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35012 that allows you to specify the user's full name for inclusion in a created
35013 &'Sender:'& or &'From:'& header line. For example:
35014 .code
35015 accept authenticated = *
35016        control = submission/domain=wonderland.example/\
35017                             name=${lookup {$authenticated_id} \
35018                                    lsearch {/etc/exim/namelist}}
35019 .endd
35020 Because the name may contain any characters, including slashes, the &%name%&
35021 option must be given last. The remainder of the string is used as the name. For
35022 the example above, if &_/etc/exim/namelist_& contains:
35023 .code
35024 bigegg:  Humpty Dumpty
35025 .endd
35026 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35027 line would be:
35028 .code
35029 Sender: Humpty Dumpty <bigegg@wonderland.example>
35030 .endd
35031 .cindex "return path" "in submission mode"
35032 By default, submission mode forces the return path to the same address as is
35033 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35034 specified, the return path is also left unchanged.
35035
35036 &*Note*&: The changes caused by submission mode take effect after the predata
35037 ACL. This means that any sender checks performed before the fix-ups use the
35038 untrusted sender address specified by the user, not the trusted sender address
35039 specified by submission mode. Although this might be slightly unexpected, it
35040 does mean that you can configure ACL checks to spot that a user is trying to
35041 spoof another's address.
35042
35043 .section "Line endings" "SECTlineendings"
35044 .cindex "line endings"
35045 .cindex "carriage return"
35046 .cindex "linefeed"
35047 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35048 linefeed) is the line ending for messages transmitted over the Internet using
35049 SMTP over TCP/IP. However, within individual operating systems, different
35050 conventions are used. For example, Unix-like systems use just LF, but others
35051 use CRLF or just CR.
35052
35053 Exim was designed for Unix-like systems, and internally, it stores messages
35054 using the system's convention of a single LF as a line terminator. When
35055 receiving a message, all line endings are translated to this standard format.
35056 Originally, it was thought that programs that passed messages directly to an
35057 MTA within an operating system would use that system's convention. Experience
35058 has shown that this is not the case; for example, there are Unix applications
35059 that use CRLF in this circumstance. For this reason, and for compatibility with
35060 other MTAs, the way Exim handles line endings for all messages is now as
35061 follows:
35062
35063 .ilist
35064 LF not preceded by CR is treated as a line ending.
35065 .next
35066 CR is treated as a line ending; if it is immediately followed by LF, the LF
35067 is ignored.
35068 .next
35069 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35070 nor a local message in the state where a line containing only a dot is a
35071 terminator.
35072 .next
35073 If a bare CR is encountered within a header line, an extra space is added after
35074 the line terminator so as not to end the header line. The reasoning behind this
35075 is that bare CRs in header lines are most likely either to be mistakes, or
35076 people trying to play silly games.
35077 .next
35078 If the first header line received in a message ends with CRLF, a subsequent
35079 bare LF in a header line is treated in the same way as a bare CR in a header
35080 line.
35081 .endlist
35082
35083
35084
35085
35086
35087 .section "Unqualified addresses" "SECID218"
35088 .cindex "unqualified addresses"
35089 .cindex "address" "qualification"
35090 By default, Exim expects every envelope address it receives from an external
35091 host to be fully qualified. Unqualified addresses cause negative responses to
35092 SMTP commands. However, because SMTP is used as a means of transporting
35093 messages from MUAs running on personal workstations, there is sometimes a
35094 requirement to accept unqualified addresses from specific hosts or IP networks.
35095
35096 Exim has two options that separately control which hosts may send unqualified
35097 sender or recipient addresses in SMTP commands, namely
35098 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35099 cases, if an unqualified address is accepted, it is qualified by adding the
35100 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35101
35102 .oindex "&%qualify_domain%&"
35103 .oindex "&%qualify_recipient%&"
35104 Unqualified addresses in header lines are automatically qualified for messages
35105 that are locally originated, unless the &%-bnq%& option is given on the command
35106 line. For messages received over SMTP, unqualified addresses in header lines
35107 are qualified only if unqualified addresses are permitted in SMTP commands. In
35108 other words, such qualification is also controlled by
35109 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35110
35111
35112
35113
35114 .section "The UUCP From line" "SECID219"
35115 .cindex "&""From""& line"
35116 .cindex "UUCP" "&""From""& line"
35117 .cindex "sender" "address"
35118 .oindex "&%uucp_from_pattern%&"
35119 .oindex "&%uucp_from_sender%&"
35120 .cindex "envelope from"
35121 .cindex "envelope sender"
35122 .cindex "Sendmail compatibility" "&""From""& line"
35123 Messages that have come from UUCP (and some other applications) often begin
35124 with a line containing the envelope sender and a timestamp, following the word
35125 &"From"&. Examples of two common formats are:
35126 .code
35127 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35128 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35129 .endd
35130 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35131 Exim recognizes such lines at the start of messages that are submitted to it
35132 via the command line (that is, on the standard input). It does not recognize
35133 such lines in incoming SMTP messages, unless the sending host matches
35134 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35135 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35136 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35137 default value matches the two common cases shown above and puts the address
35138 that follows &"From"& into &$1$&.
35139
35140 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35141 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35142 a trusted user, the message's sender address is constructed by expanding the
35143 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35144 then parsed as an RFC 2822 address. If there is no domain, the local part is
35145 qualified with &%qualify_domain%& unless it is the empty string. However, if
35146 the command line &%-f%& option is used, it overrides the &"From"& line.
35147
35148 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35149 sender address is not changed. This is also the case for incoming SMTP messages
35150 that are permitted to contain &"From"& lines.
35151
35152 Only one &"From"& line is recognized. If there is more than one, the second is
35153 treated as a data line that starts the body of the message, as it is not valid
35154 as a header line. This also happens if a &"From"& line is present in an
35155 incoming SMTP message from a source that is not permitted to send them.
35156
35157
35158
35159 .section "Resent- header lines" "SECID220"
35160 .cindex "&%Resent-%& header lines"
35161 .cindex "header lines" "Resent-"
35162 RFC 2822 makes provision for sets of header lines starting with the string
35163 &`Resent-`& to be added to a message when it is resent by the original
35164 recipient to somebody else. These headers are &'Resent-Date:'&,
35165 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35166 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35167
35168 .blockquote
35169 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35170 processing of replies or other such automatic actions on messages.'&
35171 .endblockquote
35172
35173 This leaves things a bit vague as far as other processing actions such as
35174 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35175 follows:
35176
35177 .ilist
35178 A &'Resent-From:'& line that just contains the login id of the submitting user
35179 is automatically rewritten in the same way as &'From:'& (see below).
35180 .next
35181 If there's a rewriting rule for a particular header line, it is also applied to
35182 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35183 &'From:'& also rewrites &'Resent-From:'&.
35184 .next
35185 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35186 also removed.
35187 .next
35188 For a locally-submitted message,
35189 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35190 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35191 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35192 included in log lines in this case.
35193 .next
35194 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35195 &%Resent-%& header lines are present.
35196 .endlist
35197
35198
35199
35200
35201 .section "The Auto-Submitted: header line" "SECID221"
35202 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35203 includes the header line:
35204 .code
35205 Auto-Submitted: auto-replied
35206 .endd
35207
35208 .section "The Bcc: header line" "SECID222"
35209 .cindex "&'Bcc:'& header line"
35210 If Exim is called with the &%-t%& option, to take recipient addresses from a
35211 message's header, it removes any &'Bcc:'& header line that may exist (after
35212 extracting its addresses). If &%-t%& is not present on the command line, any
35213 existing &'Bcc:'& is not removed.
35214
35215
35216 .section "The Date: header line" "SECID223"
35217 .cindex "&'Date:'& header line"
35218 .cindex "header lines" "Date:"
35219 If a locally-generated or submission-mode message has no &'Date:'& header line,
35220 Exim adds one, using the current date and time, unless the
35221 &%suppress_local_fixups%& control has been specified.
35222
35223 .section "The Delivery-date: header line" "SECID224"
35224 .cindex "&'Delivery-date:'& header line"
35225 .oindex "&%delivery_date_remove%&"
35226 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35227 set. Exim can be configured to add them to the final delivery of messages. (See
35228 the generic &%delivery_date_add%& transport option.) They should not be present
35229 in messages in transit. If the &%delivery_date_remove%& configuration option is
35230 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35231 messages.
35232
35233
35234 .section "The Envelope-to: header line" "SECID225"
35235 .cindex "&'Envelope-to:'& header line"
35236 .cindex "header lines" "Envelope-to:"
35237 .oindex "&%envelope_to_remove%&"
35238 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35239 Exim can be configured to add them to the final delivery of messages. (See the
35240 generic &%envelope_to_add%& transport option.) They should not be present in
35241 messages in transit. If the &%envelope_to_remove%& configuration option is set
35242 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35243 messages.
35244
35245
35246 .section "The From: header line" "SECTthefrohea"
35247 .cindex "&'From:'& header line"
35248 .cindex "header lines" "From:"
35249 .cindex "Sendmail compatibility" "&""From""& line"
35250 .cindex "message" "submission"
35251 .cindex "submission mode"
35252 If a submission-mode message does not contain a &'From:'& header line, Exim
35253 adds one if either of the following conditions is true:
35254
35255 .ilist
35256 The envelope sender address is not empty (that is, this is not a bounce
35257 message). The added header line copies the envelope sender address.
35258 .next
35259 .vindex "&$authenticated_id$&"
35260 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35261 .olist
35262 .vindex "&$qualify_domain$&"
35263 If no domain is specified by the submission control, the local part is
35264 &$authenticated_id$& and the domain is &$qualify_domain$&.
35265 .next
35266 If a non-empty domain is specified by the submission control, the local
35267 part is &$authenticated_id$&, and the domain is the specified domain.
35268 .next
35269 If an empty domain is specified by the submission control,
35270 &$authenticated_id$& is assumed to be the complete address.
35271 .endlist
35272 .endlist
35273
35274 A non-empty envelope sender takes precedence.
35275
35276 If a locally-generated incoming message does not contain a &'From:'& header
35277 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35278 containing the sender's address. The calling user's login name and full name
35279 are used to construct the address, as described in section &<<SECTconstr>>&.
35280 They are obtained from the password data by calling &[getpwuid()]& (but see the
35281 &%unknown_login%& configuration option). The address is qualified with
35282 &%qualify_domain%&.
35283
35284 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35285 &'From:'& header line containing just the unqualified login name of the calling
35286 user, this is replaced by an address containing the user's login name and full
35287 name as described in section &<<SECTconstr>>&.
35288
35289
35290 .section "The Message-ID: header line" "SECID226"
35291 .cindex "&'Message-ID:'& header line"
35292 .cindex "header lines" "Message-ID:"
35293 .cindex "message" "submission"
35294 .oindex "&%message_id_header_text%&"
35295 If a locally-generated or submission-mode incoming message does not contain a
35296 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35297 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35298 to the message. If there are any &'Resent-:'& headers in the message, it
35299 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35300 message id, preceded by the letter E to ensure it starts with a letter, and
35301 followed by @ and the primary host name. Additional information can be included
35302 in this header line by setting the &%message_id_header_text%& and/or
35303 &%message_id_header_domain%& options.
35304
35305
35306 .section "The Received: header line" "SECID227"
35307 .cindex "&'Received:'& header line"
35308 .cindex "header lines" "Received:"
35309 A &'Received:'& header line is added at the start of every message. The
35310 contents are defined by the &%received_header_text%& configuration option, and
35311 Exim automatically adds a semicolon and a timestamp to the configured string.
35312
35313 The &'Received:'& header is generated as soon as the message's header lines
35314 have been received. At this stage, the timestamp in the &'Received:'& header
35315 line is the time that the message started to be received. This is the value
35316 that is seen by the DATA ACL and by the &[local_scan()]& function.
35317
35318 Once a message is accepted, the timestamp in the &'Received:'& header line is
35319 changed to the time of acceptance, which is (apart from a small delay while the
35320 -H spool file is written) the earliest time at which delivery could start.
35321
35322
35323 .section "The References: header line" "SECID228"
35324 .cindex "&'References:'& header line"
35325 .cindex "header lines" "References:"
35326 Messages created by the &(autoreply)& transport include a &'References:'&
35327 header line. This is constructed according to the rules that are described in
35328 section 3.64 of RFC 2822 (which states that replies should contain such a
35329 header line), and section 3.14 of RFC 3834 (which states that automatic
35330 responses are not different in this respect). However, because some mail
35331 processing software does not cope well with very long header lines, no more
35332 than 12 message IDs are copied from the &'References:'& header line in the
35333 incoming message. If there are more than 12, the first one and then the final
35334 11 are copied, before adding the message ID of the incoming message.
35335
35336
35337
35338 .section "The Return-path: header line" "SECID229"
35339 .cindex "&'Return-path:'& header line"
35340 .cindex "header lines" "Return-path:"
35341 .oindex "&%return_path_remove%&"
35342 &'Return-path:'& header lines are defined as something an MTA may insert when
35343 it does the final delivery of messages. (See the generic &%return_path_add%&
35344 transport option.) Therefore, they should not be present in messages in
35345 transit. If the &%return_path_remove%& configuration option is set (the
35346 default), Exim removes &'Return-path:'& header lines from incoming messages.
35347
35348
35349
35350 .section "The Sender: header line" "SECTthesenhea"
35351 .cindex "&'Sender:'& header line"
35352 .cindex "message" "submission"
35353 .cindex "header lines" "Sender:"
35354 For a locally-originated message from an untrusted user, Exim may remove an
35355 existing &'Sender:'& header line, and it may add a new one. You can modify
35356 these actions by setting the &%local_sender_retain%& option true, the
35357 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35358 control setting.
35359
35360 When a local message is received from an untrusted user and
35361 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35362 control has not been set, a check is made to see if the address given in the
35363 &'From:'& header line is the correct (local) sender of the message. The address
35364 that is expected has the login name as the local part and the value of
35365 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35366 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35367 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35368 line is added to the message.
35369
35370 If you set &%local_from_check%& false, this checking does not occur. However,
35371 the removal of an existing &'Sender:'& line still happens, unless you also set
35372 &%local_sender_retain%& to be true. It is not possible to set both of these
35373 options true at the same time.
35374
35375 .cindex "submission mode"
35376 By default, no processing of &'Sender:'& header lines is done for messages
35377 received over TCP/IP or for messages submitted by trusted users. However, when
35378 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35379 not specified on the submission control, the following processing takes place:
35380
35381 .vindex "&$authenticated_id$&"
35382 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35383 authenticated, and &$authenticated_id$& is not empty, a sender address is
35384 created as follows:
35385
35386 .ilist
35387 .vindex "&$qualify_domain$&"
35388 If no domain is specified by the submission control, the local part is
35389 &$authenticated_id$& and the domain is &$qualify_domain$&.
35390 .next
35391 If a non-empty domain is specified by the submission control, the local part
35392 is &$authenticated_id$&, and the domain is the specified domain.
35393 .next
35394 If an empty domain is specified by the submission control,
35395 &$authenticated_id$& is assumed to be the complete address.
35396 .endlist
35397
35398 This address is compared with the address in the &'From:'& header line. If they
35399 are different, a &'Sender:'& header line containing the created address is
35400 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35401 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35402
35403 .cindex "return path" "created from &'Sender:'&"
35404 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35405 the message (the envelope sender address) is changed to be the same address,
35406 except in the case of submission mode when &%sender_retain%& is specified.
35407
35408
35409
35410 .section "Adding and removing header lines in routers and transports" &&&
35411          "SECTheadersaddrem"
35412 .cindex "header lines" "adding; in router or transport"
35413 .cindex "header lines" "removing; in router or transport"
35414 When a message is delivered, the addition and removal of header lines can be
35415 specified in a system filter, or on any of the routers and transports that
35416 process the message. Section &<<SECTaddremheasys>>& contains details about
35417 modifying headers in a system filter. Header lines can also be added in an ACL
35418 as a message is received (see section &<<SECTaddheadacl>>&).
35419
35420 In contrast to what happens in a system filter, header modifications that are
35421 specified on routers and transports apply only to the particular recipient
35422 addresses that are being processed by those routers and transports. These
35423 changes do not actually take place until a copy of the message is being
35424 transported. Therefore, they do not affect the basic set of header lines, and
35425 they do not affect the values of the variables that refer to header lines.
35426
35427 &*Note*&: In particular, this means that any expansions in the configuration of
35428 the transport cannot refer to the modified header lines, because such
35429 expansions all occur before the message is actually transported.
35430
35431 For both routers and transports, the argument of a &%headers_add%&
35432 option must be in the form of one or more RFC 2822 header lines, separated by
35433 newlines (coded as &"\n"&). For example:
35434 .code
35435 headers_add = X-added-header: added by $primary_hostname\n\
35436               X-added-second: another added header line
35437 .endd
35438 Exim does not check the syntax of these added header lines.
35439
35440 Multiple &%headers_add%& options for a single router or transport can be
35441 specified; the values will append to a single list of header lines.
35442 Each header-line is separately expanded.
35443
35444 The argument of a &%headers_remove%& option must consist of a colon-separated
35445 list of header names. This is confusing, because header names themselves are
35446 often terminated by colons. In this case, the colons are the list separators,
35447 not part of the names. For example:
35448 .code
35449 headers_remove = return-receipt-to:acknowledge-to
35450 .endd
35451
35452 Multiple &%headers_remove%& options for a single router or transport can be
35453 specified; the arguments will append to a single header-names list.
35454 Each item is separately expanded.
35455 Note that colons in complex expansions which are used to
35456 form all or part of a &%headers_remove%& list
35457 will act as list separators.
35458
35459 When &%headers_add%& or &%headers_remove%& is specified on a router,
35460 items are expanded at routing time,
35461 and then associated with all addresses that are
35462 accepted by that router, and also with any new addresses that it generates. If
35463 an address passes through several routers as a result of aliasing or
35464 forwarding, the changes are cumulative.
35465
35466 .oindex "&%unseen%&"
35467 However, this does not apply to multiple routers that result from the use of
35468 the &%unseen%& option. Any header modifications that were specified by the
35469 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35470
35471 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35472 settings cannot be delivered together in a batch, so a transport is always
35473 dealing with a set of addresses that have the same header-processing
35474 requirements.
35475
35476 The transport starts by writing the original set of header lines that arrived
35477 with the message, possibly modified by the system filter. As it writes out
35478 these lines, it consults the list of header names that were attached to the
35479 recipient address(es) by &%headers_remove%& options in routers, and it also
35480 consults the transport's own &%headers_remove%& option. Header lines whose
35481 names are on either of these lists are not written out. If there are multiple
35482 instances of any listed header, they are all skipped.
35483
35484 After the remaining original header lines have been written, new header
35485 lines that were specified by routers' &%headers_add%& options are written, in
35486 the order in which they were attached to the address. These are followed by any
35487 header lines specified by the transport's &%headers_add%& option.
35488
35489 This way of handling header line modifications in routers and transports has
35490 the following consequences:
35491
35492 .ilist
35493 The original set of header lines, possibly modified by the system filter,
35494 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35495 to it, at all times.
35496 .next
35497 Header lines that are added by a router's
35498 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35499 expansion syntax in subsequent routers or the transport.
35500 .next
35501 Conversely, header lines that are specified for removal by &%headers_remove%&
35502 in a router remain visible to subsequent routers and the transport.
35503 .next
35504 Headers added to an address by &%headers_add%& in a router cannot be removed by
35505 a later router or by a transport.
35506 .next
35507 An added header can refer to the contents of an original header that is to be
35508 removed, even it has the same name as the added header. For example:
35509 .code
35510 headers_remove = subject
35511 headers_add = Subject: new subject (was: $h_subject:)
35512 .endd
35513 .endlist
35514
35515 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35516 for a &(redirect)& router that has the &%one_time%& option set.
35517
35518
35519
35520
35521
35522 .section "Constructed addresses" "SECTconstr"
35523 .cindex "address" "constructed"
35524 .cindex "constructed address"
35525 When Exim constructs a sender address for a locally-generated message, it uses
35526 the form
35527 .display
35528 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35529 .endd
35530 For example:
35531 .code
35532 Zaphod Beeblebrox <zaphod@end.univ.example>
35533 .endd
35534 The user name is obtained from the &%-F%& command line option if set, or
35535 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35536 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35537 ampersand character, this is replaced by the login name with the first letter
35538 upper cased, as is conventional in a number of operating systems. See the
35539 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35540 The &%unknown_username%& option can be used to specify user names in cases when
35541 there is no password file entry.
35542
35543 .cindex "RFC 2047"
35544 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35545 parts of it if necessary. In addition, if it contains any non-printing
35546 characters, it is encoded as described in RFC 2047, which defines a way of
35547 including non-ASCII characters in header lines. The value of the
35548 &%headers_charset%& option specifies the name of the encoding that is used (the
35549 characters are assumed to be in this encoding). The setting of
35550 &%print_topbitchars%& controls whether characters with the top bit set (that
35551 is, with codes greater than 127) count as printing characters or not.
35552
35553
35554
35555 .section "Case of local parts" "SECID230"
35556 .cindex "case of local parts"
35557 .cindex "local part" "case of"
35558 RFC 2822 states that the case of letters in the local parts of addresses cannot
35559 be assumed to be non-significant. Exim preserves the case of local parts of
35560 addresses, but by default it uses a lower-cased form when it is routing,
35561 because on most Unix systems, usernames are in lower case and case-insensitive
35562 routing is required. However, any particular router can be made to use the
35563 original case for local parts by setting the &%caseful_local_part%& generic
35564 router option.
35565
35566 .cindex "mixed-case login names"
35567 If you must have mixed-case user names on your system, the best way to proceed,
35568 assuming you want case-independent handling of incoming email, is to set up
35569 your first router to convert incoming local parts in your domains to the
35570 correct case by means of a file lookup. For example:
35571 .code
35572 correct_case:
35573   driver = redirect
35574   domains = +local_domains
35575   data = ${lookup{$local_part}cdb\
35576               {/etc/usercased.cdb}{$value}fail}\
35577               @$domain
35578 .endd
35579 For this router, the local part is forced to lower case by the default action
35580 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35581 up a new local part in the correct case. If you then set &%caseful_local_part%&
35582 on any subsequent routers which process your domains, they will operate on
35583 local parts with the correct case in a case-sensitive manner.
35584
35585
35586
35587 .section "Dots in local parts" "SECID231"
35588 .cindex "dot" "in local part"
35589 .cindex "local part" "dots in"
35590 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35591 part may not begin or end with a dot, nor have two consecutive dots in the
35592 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35593 empty components for compatibility.
35594
35595
35596
35597 .section "Rewriting addresses" "SECID232"
35598 .cindex "rewriting" "addresses"
35599 Rewriting of sender and recipient addresses, and addresses in headers, can
35600 happen automatically, or as the result of configuration options, as described
35601 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35602 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35603
35604 Automatic rewriting includes qualification, as mentioned above. The other case
35605 in which it can happen is when an incomplete non-local domain is given. The
35606 routing process may cause this to be expanded into the full domain name. For
35607 example, a header such as
35608 .code
35609 To: hare@teaparty
35610 .endd
35611 might get rewritten as
35612 .code
35613 To: hare@teaparty.wonderland.fict.example
35614 .endd
35615 Rewriting as a result of routing is the one kind of message processing that
35616 does not happen at input time, as it cannot be done until the address has
35617 been routed.
35618
35619 Strictly, one should not do &'any'& deliveries of a message until all its
35620 addresses have been routed, in case any of the headers get changed as a
35621 result of routing. However, doing this in practice would hold up many
35622 deliveries for unreasonable amounts of time, just because one address could not
35623 immediately be routed. Exim therefore does not delay other deliveries when
35624 routing of one or more addresses is deferred.
35625 .ecindex IIDmesproc
35626
35627
35628
35629 . ////////////////////////////////////////////////////////////////////////////
35630 . ////////////////////////////////////////////////////////////////////////////
35631
35632 .chapter "SMTP processing" "CHAPSMTP"
35633 .scindex IIDsmtpproc1 "SMTP" "processing details"
35634 .scindex IIDsmtpproc2 "LMTP" "processing details"
35635 Exim supports a number of different ways of using the SMTP protocol, and its
35636 LMTP variant, which is an interactive protocol for transferring messages into a
35637 closed mail store application. This chapter contains details of how SMTP is
35638 processed. For incoming mail, the following are available:
35639
35640 .ilist
35641 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35642 .next
35643 SMTP over the standard input and output (the &%-bs%& option);
35644 .next
35645 Batched SMTP on the standard input (the &%-bS%& option).
35646 .endlist
35647
35648 For mail delivery, the following are available:
35649
35650 .ilist
35651 SMTP over TCP/IP (the &(smtp)& transport);
35652 .next
35653 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35654 &"lmtp"&);
35655 .next
35656 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35657 transport);
35658 .next
35659 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35660 the &%use_bsmtp%& option set).
35661 .endlist
35662
35663 &'Batched SMTP'& is the name for a process in which batches of messages are
35664 stored in or read from files (or pipes), in a format in which SMTP commands are
35665 used to contain the envelope information.
35666
35667
35668
35669 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35670 .cindex "SMTP" "outgoing over TCP/IP"
35671 .cindex "outgoing SMTP over TCP/IP"
35672 .cindex "LMTP" "over TCP/IP"
35673 .cindex "outgoing LMTP over TCP/IP"
35674 .cindex "EHLO"
35675 .cindex "HELO"
35676 .cindex "SIZE option on MAIL command"
35677 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35678 The &%protocol%& option selects which protocol is to be used, but the actual
35679 processing is the same in both cases.
35680
35681 If, in response to its EHLO command, Exim is told that the SIZE
35682 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35683 command. The value of <&'n'&> is the message size plus the value of the
35684 &%size_addition%& option (default 1024) to allow for additions to the message
35685 such as per-transport header lines, or changes made in a
35686 .cindex "transport" "filter"
35687 .cindex "filter" "transport filter"
35688 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35689 suppressed.
35690
35691 If the remote server advertises support for PIPELINING, Exim uses the
35692 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35693 required for the transaction.
35694
35695 If the remote server advertises support for the STARTTLS command, and Exim
35696 was built to support TLS encryption, it tries to start a TLS session unless the
35697 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35698 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35699 is called for verification.
35700
35701 If the remote server advertises support for the AUTH command, Exim scans
35702 the authenticators configuration for any suitable client settings, as described
35703 in chapter &<<CHAPSMTPAUTH>>&.
35704
35705 .cindex "carriage return"
35706 .cindex "linefeed"
35707 Responses from the remote host are supposed to be terminated by CR followed by
35708 LF. However, there are known to be hosts that do not send CR characters, so in
35709 order to be able to interwork with such hosts, Exim treats LF on its own as a
35710 line terminator.
35711
35712 If a message contains a number of different addresses, all those with the same
35713 characteristics (for example, the same envelope sender) that resolve to the
35714 same set of hosts, in the same order, are sent in a single SMTP transaction,
35715 even if they are for different domains, unless there are more than the setting
35716 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35717 they are split into groups containing no more than &%max_rcpt%&s addresses
35718 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35719 in parallel sessions. The order of hosts with identical MX values is not
35720 significant when checking whether addresses can be batched in this way.
35721
35722 When the &(smtp)& transport suffers a temporary failure that is not
35723 message-related, Exim updates its transport-specific database, which contains
35724 records indexed by host name that remember which messages are waiting for each
35725 particular host. It also updates the retry database with new retry times.
35726
35727 .cindex "hints database" "retry keys"
35728 Exim's retry hints are based on host name plus IP address, so if one address of
35729 a multi-homed host is broken, it will soon be skipped most of the time.
35730 See the next section for more detail about error handling.
35731
35732 .cindex "SMTP" "passed connection"
35733 .cindex "SMTP" "batching over TCP/IP"
35734 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35735 looks in the hints database for the transport to see if there are any queued
35736 messages waiting for the host to which it is connected. If it finds one, it
35737 creates a new Exim process using the &%-MC%& option (which can only be used by
35738 a process running as root or the Exim user) and passes the TCP/IP socket to it
35739 so that it can deliver another message using the same socket. The new process
35740 does only those deliveries that are routed to the connected host, and may in
35741 turn pass the socket on to a third process, and so on.
35742
35743 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35744 limit the number of messages sent down a single TCP/IP connection.
35745
35746 .cindex "asterisk" "after IP address"
35747 The second and subsequent messages delivered down an existing connection are
35748 identified in the main log by the addition of an asterisk after the closing
35749 square bracket of the IP address.
35750
35751
35752
35753
35754 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35755 .cindex "error" "in outgoing SMTP"
35756 .cindex "SMTP" "errors in outgoing"
35757 .cindex "host" "error"
35758 Three different kinds of error are recognized for outgoing SMTP: host errors,
35759 message errors, and recipient errors.
35760
35761 .vlist
35762 .vitem "&*Host errors*&"
35763 A host error is not associated with a particular message or with a
35764 particular recipient of a message. The host errors are:
35765
35766 .ilist
35767 Connection refused or timed out,
35768 .next
35769 Any error response code on connection,
35770 .next
35771 Any error response code to EHLO or HELO,
35772 .next
35773 Loss of connection at any time, except after &"."&,
35774 .next
35775 I/O errors at any time,
35776 .next
35777 Timeouts during the session, other than in response to MAIL, RCPT or
35778 the &"."& at the end of the data.
35779 .endlist ilist
35780
35781 For a host error, a permanent error response on connection, or in response to
35782 EHLO, causes all addresses routed to the host to be failed. Any other host
35783 error causes all addresses to be deferred, and retry data to be created for the
35784 host. It is not tried again, for any message, until its retry time arrives. If
35785 the current set of addresses are not all delivered in this run (to some
35786 alternative host), the message is added to the list of those waiting for this
35787 host, so if it is still undelivered when a subsequent successful delivery is
35788 made to the host, it will be sent down the same SMTP connection.
35789
35790 .vitem "&*Message errors*&"
35791 .cindex "message" "error"
35792 A message error is associated with a particular message when sent to a
35793 particular host, but not with a particular recipient of the message. The
35794 message errors are:
35795
35796 .ilist
35797 Any error response code to MAIL, DATA, or the &"."& that terminates
35798 the data,
35799 .next
35800 Timeout after MAIL,
35801 .next
35802 Timeout or loss of connection after the &"."& that terminates the data. A
35803 timeout after the DATA command itself is treated as a host error, as is loss of
35804 connection at any other time.
35805 .endlist ilist
35806
35807 For a message error, a permanent error response (5&'xx'&) causes all addresses
35808 to be failed, and a delivery error report to be returned to the sender. A
35809 temporary error response (4&'xx'&), or one of the timeouts, causes all
35810 addresses to be deferred. Retry data is not created for the host, but instead,
35811 a retry record for the combination of host plus message id is created. The
35812 message is not added to the list of those waiting for this host. This ensures
35813 that the failing message will not be sent to this host again until the retry
35814 time arrives. However, other messages that are routed to the host are not
35815 affected, so if it is some property of the message that is causing the error,
35816 it will not stop the delivery of other mail.
35817
35818 If the remote host specified support for the SIZE parameter in its response
35819 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35820 over-large message will cause a message error because the error arrives as a
35821 response to MAIL.
35822
35823 .vitem "&*Recipient errors*&"
35824 .cindex "recipient" "error"
35825 A recipient error is associated with a particular recipient of a message. The
35826 recipient errors are:
35827
35828 .ilist
35829 Any error response to RCPT,
35830 .next
35831 Timeout after RCPT.
35832 .endlist
35833
35834 For a recipient error, a permanent error response (5&'xx'&) causes the
35835 recipient address to be failed, and a bounce message to be returned to the
35836 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35837 address to be deferred, and routing retry data to be created for it. This is
35838 used to delay processing of the address in subsequent queue runs, until its
35839 routing retry time arrives. This applies to all messages, but because it
35840 operates only in queue runs, one attempt will be made to deliver a new message
35841 to the failing address before the delay starts to operate. This ensures that,
35842 if the failure is really related to the message rather than the recipient
35843 (&"message too big for this recipient"& is a possible example), other messages
35844 have a chance of getting delivered. If a delivery to the address does succeed,
35845 the retry information gets cleared, so all stuck messages get tried again, and
35846 the retry clock is reset.
35847
35848 The message is not added to the list of those waiting for this host. Use of the
35849 host for other messages is unaffected, and except in the case of a timeout,
35850 other recipients are processed independently, and may be successfully delivered
35851 in the current SMTP session. After a timeout it is of course impossible to
35852 proceed with the session, so all addresses get deferred. However, those other
35853 than the one that failed do not suffer any subsequent retry delays. Therefore,
35854 if one recipient is causing trouble, the others have a chance of getting
35855 through when a subsequent delivery attempt occurs before the failing
35856 recipient's retry time.
35857 .endlist
35858
35859 In all cases, if there are other hosts (or IP addresses) available for the
35860 current set of addresses (for example, from multiple MX records), they are
35861 tried in this run for any undelivered addresses, subject of course to their
35862 own retry data. In other words, recipient error retry data does not take effect
35863 until the next delivery attempt.
35864
35865 Some hosts have been observed to give temporary error responses to every
35866 MAIL command at certain times (&"insufficient space"& has been seen). It
35867 would be nice if such circumstances could be recognized, and defer data for the
35868 host itself created, but this is not possible within the current Exim design.
35869 What actually happens is that retry data for every (host, message) combination
35870 is created.
35871
35872 The reason that timeouts after MAIL and RCPT are treated specially is that
35873 these can sometimes arise as a result of the remote host's verification
35874 procedures. Exim makes this assumption, and treats them as if a temporary error
35875 response had been received. A timeout after &"."& is treated specially because
35876 it is known that some broken implementations fail to recognize the end of the
35877 message if the last character of the last line is a binary zero. Thus, it is
35878 helpful to treat this case as a message error.
35879
35880 Timeouts at other times are treated as host errors, assuming a problem with the
35881 host, or the connection to it. If a timeout after MAIL, RCPT,
35882 or &"."& is really a connection problem, the assumption is that at the next try
35883 the timeout is likely to occur at some other point in the dialogue, causing it
35884 then to be treated as a host error.
35885
35886 There is experimental evidence that some MTAs drop the connection after the
35887 terminating &"."& if they do not like the contents of the message for some
35888 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35889 should be given. That is why Exim treats this case as a message rather than a
35890 host error, in order not to delay other messages to the same host.
35891
35892
35893
35894
35895 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35896 .cindex "SMTP" "incoming over TCP/IP"
35897 .cindex "incoming SMTP over TCP/IP"
35898 .cindex "inetd"
35899 .cindex "daemon"
35900 Incoming SMTP messages can be accepted in one of two ways: by running a
35901 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35902 &_/etc/inetd.conf_& should be like this:
35903 .code
35904 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35905 .endd
35906 Exim distinguishes between this case and the case of a locally running user
35907 agent using the &%-bs%& option by checking whether or not the standard input is
35908 a socket. When it is, either the port must be privileged (less than 1024), or
35909 the caller must be root or the Exim user. If any other user passes a socket
35910 with an unprivileged port number, Exim prints a message on the standard error
35911 stream and exits with an error code.
35912
35913 By default, Exim does not make a log entry when a remote host connects or
35914 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35915 unexpected. It can be made to write such log entries by setting the
35916 &%smtp_connection%& log selector.
35917
35918 .cindex "carriage return"
35919 .cindex "linefeed"
35920 Commands from the remote host are supposed to be terminated by CR followed by
35921 LF. However, there are known to be hosts that do not send CR characters. In
35922 order to be able to interwork with such hosts, Exim treats LF on its own as a
35923 line terminator.
35924 Furthermore, because common code is used for receiving messages from all
35925 sources, a CR on its own is also interpreted as a line terminator. However, the
35926 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35927
35928 .cindex "EHLO" "invalid data"
35929 .cindex "HELO" "invalid data"
35930 One area that sometimes gives rise to problems concerns the EHLO or
35931 HELO commands. Some clients send syntactically invalid versions of these
35932 commands, which Exim rejects by default. (This is nothing to do with verifying
35933 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35934 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35935 match the broken hosts that send invalid commands.
35936
35937 .cindex "SIZE option on MAIL command"
35938 .cindex "MAIL" "SIZE option"
35939 The amount of disk space available is checked whenever SIZE is received on
35940 a MAIL command, independently of whether &%message_size_limit%& or
35941 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35942 false. A temporary error is given if there is not enough space. If
35943 &%check_spool_space%& is set, the check is for that amount of space plus the
35944 value given with SIZE, that is, it checks that the addition of the incoming
35945 message will not reduce the space below the threshold.
35946
35947 When a message is successfully received, Exim includes the local message id in
35948 its response to the final &"."& that terminates the data. If the remote host
35949 logs this text it can help with tracing what has happened to a message.
35950
35951 The Exim daemon can limit the number of simultaneous incoming connections it is
35952 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35953 number of simultaneous incoming connections from a single remote host (see the
35954 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35955 rejected using the SMTP temporary error code 421.
35956
35957 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35958 subprocess has finished, as this can get lost at busy times. Instead, it looks
35959 for completed subprocesses every time it wakes up. Provided there are other
35960 things happening (new incoming calls, starts of queue runs), completed
35961 processes will be noticed and tidied away. On very quiet systems you may
35962 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35963 it will be noticed when the daemon next wakes up.
35964
35965 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35966 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35967 high system load &-- for details see the &%smtp_accept_reserve%&,
35968 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35969 applies in both the daemon and &'inetd'& cases.
35970
35971 Exim normally starts a delivery process for each message received, though this
35972 can be varied by means of the &%-odq%& command line option and the
35973 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35974 number of simultaneously running delivery processes started in this way from
35975 SMTP input can be limited by the &%smtp_accept_queue%& and
35976 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35977 subsequently received messages are just put on the input queue without starting
35978 a delivery process.
35979
35980 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35981 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35982 started up from the &'inetd'& daemon, because in that case each connection is
35983 handled by an entirely independent Exim process. Control by load average is,
35984 however, available with &'inetd'&.
35985
35986 Exim can be configured to verify addresses in incoming SMTP commands as they
35987 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35988 to rewrite addresses at this time &-- before any syntax checking is done. See
35989 section &<<SECTrewriteS>>&.
35990
35991 Exim can also be configured to limit the rate at which a client host submits
35992 MAIL and RCPT commands in a single SMTP session. See the
35993 &%smtp_ratelimit_hosts%& option.
35994
35995
35996
35997 .section "Unrecognized SMTP commands" "SECID234"
35998 .cindex "SMTP" "unrecognized commands"
35999 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36000 commands during a single SMTP connection, it drops the connection after sending
36001 the error response to the last command. The default value for
36002 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36003 abuse that subvert web servers into making connections to SMTP ports; in these
36004 circumstances, a number of non-SMTP lines are sent first.
36005
36006
36007 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36008 .cindex "SMTP" "syntax errors"
36009 .cindex "SMTP" "protocol errors"
36010 A syntax error is detected if an SMTP command is recognized, but there is
36011 something syntactically wrong with its data, for example, a malformed email
36012 address in a RCPT command. Protocol errors include invalid command
36013 sequencing such as RCPT before MAIL. If Exim receives more than
36014 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36015 drops the connection after sending the error response to the last command. The
36016 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36017 broken clients that loop sending bad commands (yes, it has been seen).
36018
36019
36020
36021 .section "Use of non-mail SMTP commands" "SECID236"
36022 .cindex "SMTP" "non-mail commands"
36023 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36024 DATA. Exim counts such commands, and drops the connection if there are too
36025 many of them in a single SMTP session. This action catches some
36026 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36027 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36028 defines what &"too many"& means. Its default value is 10.
36029
36030 When a new message is expected, one occurrence of RSET is not counted. This
36031 allows a client to send one RSET between messages (this is not necessary,
36032 but some clients do it). Exim also allows one uncounted occurrence of HELO
36033 or EHLO, and one occurrence of STARTTLS between messages. After
36034 starting up a TLS session, another EHLO is expected, and so it too is not
36035 counted.
36036
36037 The first occurrence of AUTH in a connection, or immediately following
36038 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36039 RCPT, DATA, and QUIT are counted.
36040
36041 You can control which hosts are subject to the limit set by
36042 &%smtp_accept_max_nonmail%& by setting
36043 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36044 the limit apply to all hosts. This option means that you can exclude any
36045 specific badly-behaved hosts that you have to live with.
36046
36047
36048
36049
36050 .section "The VRFY and EXPN commands" "SECID237"
36051 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36052 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36053 appropriate) in order to decide whether the command should be accepted or not.
36054
36055 .cindex "VRFY" "processing"
36056 When no ACL is defined for VRFY, or if it rejects without
36057 setting an explicit response code, the command is accepted
36058 (with a 252 SMTP response code)
36059 in order to support awkward clients that do a VRFY before every RCPT.
36060 When VRFY is accepted, it runs exactly the same code as when Exim is
36061 called with the &%-bv%& option, and returns 250/451/550
36062 SMTP response codes.
36063
36064 .cindex "EXPN" "processing"
36065 If no ACL for EXPN is defined, the command is rejected.
36066 When EXPN is accepted, a single-level expansion of the address is done.
36067 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36068 than a verification (the &%-bv%& option). If an unqualified local part is given
36069 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36070 of VRFY and EXPN commands are logged on the main and reject logs, and
36071 VRFY verification failures are logged on the main log for consistency with
36072 RCPT failures.
36073
36074
36075
36076 .section "The ETRN command" "SECTETRN"
36077 .cindex "ETRN" "processing"
36078 RFC 1985 describes an SMTP command called ETRN that is designed to
36079 overcome the security problems of the TURN command (which has fallen into
36080 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36081 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36082 should be accepted or not. If no ACL is defined, the command is rejected.
36083
36084 The ETRN command is concerned with &"releasing"& messages that are awaiting
36085 delivery to certain hosts. As Exim does not organize its message queue by host,
36086 the only form of ETRN that is supported by default is the one where the
36087 text starts with the &"#"& prefix, in which case the remainder of the text is
36088 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36089 the &%-R%& option to happen, with the remainder of the ETRN text as its
36090 argument. For example,
36091 .code
36092 ETRN #brigadoon
36093 .endd
36094 runs the command
36095 .code
36096 exim -R brigadoon
36097 .endd
36098 which causes a delivery attempt on all messages with undelivered addresses
36099 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36100 default), Exim prevents the simultaneous execution of more than one queue run
36101 for the same argument string as a result of an ETRN command. This stops
36102 a misbehaving client from starting more than one queue runner at once.
36103
36104 .cindex "hints database" "ETRN serialization"
36105 Exim implements the serialization by means of a hints database in which a
36106 record is written whenever a process is started by ETRN, and deleted when
36107 the process completes. However, Exim does not keep the SMTP session waiting for
36108 the ETRN process to complete. Once ETRN is accepted, the client is sent
36109 a &"success"& return code. Obviously there is scope for hints records to get
36110 left lying around if there is a system or program crash. To guard against this,
36111 Exim ignores any records that are more than six hours old.
36112
36113 .oindex "&%smtp_etrn_command%&"
36114 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36115 used. This specifies a command that is run whenever ETRN is received,
36116 whatever the form of its argument. For
36117 example:
36118 .code
36119 smtp_etrn_command = /etc/etrn_command $domain \
36120                     $sender_host_address
36121 .endd
36122 .vindex "&$domain$&"
36123 The string is split up into arguments which are independently expanded. The
36124 expansion variable &$domain$& is set to the argument of the ETRN command,
36125 and no syntax checking is done on the contents of this argument. Exim does not
36126 wait for the command to complete, so its status code is not checked. Exim runs
36127 under its own uid and gid when receiving incoming SMTP, so it is not possible
36128 for it to change them before running the command.
36129
36130
36131
36132 .section "Incoming local SMTP" "SECID238"
36133 .cindex "SMTP" "local incoming"
36134 Some user agents use SMTP to pass messages to their local MTA using the
36135 standard input and output, as opposed to passing the envelope on the command
36136 line and writing the message to the standard input. This is supported by the
36137 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36138 messages over TCP/IP (including the use of ACLs), except that the envelope
36139 sender given in a MAIL command is ignored unless the caller is trusted. In
36140 an ACL you can detect this form of SMTP input by testing for an empty host
36141 identification. It is common to have this as the first line in the ACL that
36142 runs for RCPT commands:
36143 .code
36144 accept hosts = :
36145 .endd
36146 This accepts SMTP messages from local processes without doing any other tests.
36147
36148
36149
36150 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36151 .cindex "SMTP" "batched outgoing"
36152 .cindex "batched SMTP output"
36153 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36154 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36155 be output in BSMTP format. No SMTP responses are possible for this form of
36156 delivery. All it is doing is using SMTP commands as a way of transmitting the
36157 envelope along with the message.
36158
36159 The message is written to the file or pipe preceded by the SMTP commands
36160 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36161 the message that start with a dot have an extra dot added. The SMTP command
36162 HELO is not normally used. If it is required, the &%message_prefix%& option
36163 can be used to specify it.
36164
36165 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36166 one recipient address at a time by default. However, you can arrange for them
36167 to handle several addresses at once by setting the &%batch_max%& option. When
36168 this is done for BSMTP, messages may contain multiple RCPT commands. See
36169 chapter &<<CHAPbatching>>& for more details.
36170
36171 .vindex "&$host$&"
36172 When one or more addresses are routed to a BSMTP transport by a router that
36173 sets up a host list, the name of the first host on the list is available to the
36174 transport in the variable &$host$&. Here is an example of such a transport and
36175 router:
36176 .code
36177 begin routers
36178 route_append:
36179   driver = manualroute
36180   transport = smtp_appendfile
36181   route_list = domain.example  batch.host.example
36182
36183 begin transports
36184 smtp_appendfile:
36185   driver = appendfile
36186   directory = /var/bsmtp/$host
36187   batch_max = 1000
36188   use_bsmtp
36189   user = exim
36190 .endd
36191 This causes messages addressed to &'domain.example'& to be written in BSMTP
36192 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36193 message (unless there are more than 1000 recipients).
36194
36195
36196
36197 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36198 .cindex "SMTP" "batched incoming"
36199 .cindex "batched SMTP input"
36200 The &%-bS%& command line option causes Exim to accept one or more messages by
36201 reading SMTP on the standard input, but to generate no responses. If the caller
36202 is trusted, the senders in the MAIL commands are believed; otherwise the
36203 sender is always the caller of Exim. Unqualified senders and receivers are not
36204 rejected (there seems little point) but instead just get qualified. HELO
36205 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36206 as NOOP; QUIT quits.
36207
36208 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36209 ACL is run in the same way as for non-SMTP local input.
36210
36211 If an error is detected while reading a message, including a missing &"."& at
36212 the end, Exim gives up immediately. It writes details of the error to the
36213 standard output in a stylized way that the calling program should be able to
36214 make some use of automatically, for example:
36215 .code
36216 554 Unexpected end of file
36217 Transaction started in line 10
36218 Error detected in line 14
36219 .endd
36220 It writes a more verbose version, for human consumption, to the standard error
36221 file, for example:
36222 .code
36223 An error was detected while processing a file of BSMTP input.
36224 The error message was:
36225
36226 501 '>' missing at end of address
36227
36228 The SMTP transaction started in line 10.
36229 The error was detected in line 12.
36230 The SMTP command at fault was:
36231
36232 rcpt to:<malformed@in.com.plete
36233
36234 1 previous message was successfully processed.
36235 The rest of the batch was abandoned.
36236 .endd
36237 The return code from Exim is zero only if there were no errors. It is 1 if some
36238 messages were accepted before an error was detected, and 2 if no messages were
36239 accepted.
36240 .ecindex IIDsmtpproc1
36241 .ecindex IIDsmtpproc2
36242
36243
36244
36245 . ////////////////////////////////////////////////////////////////////////////
36246 . ////////////////////////////////////////////////////////////////////////////
36247
36248 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36249          "Customizing messages"
36250 When a message fails to be delivered, or remains in the queue for more than a
36251 configured amount of time, Exim sends a message to the original sender, or
36252 to an alternative configured address. The text of these messages is built into
36253 the code of Exim, but it is possible to change it, either by adding a single
36254 string, or by replacing each of the paragraphs by text supplied in a file.
36255
36256 The &'From:'& and &'To:'& header lines are automatically generated; you can
36257 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36258 option. Exim also adds the line
36259 .code
36260 Auto-Submitted: auto-generated
36261 .endd
36262 to all warning and bounce messages,
36263
36264
36265 .section "Customizing bounce messages" "SECID239"
36266 .cindex "customizing" "bounce message"
36267 .cindex "bounce message" "customizing"
36268 If &%bounce_message_text%& is set, its contents are included in the default
36269 message immediately after &"This message was created automatically by mail
36270 delivery software."& The string is not expanded. It is not used if
36271 &%bounce_message_file%& is set.
36272
36273 When &%bounce_message_file%& is set, it must point to a template file for
36274 constructing error messages. The file consists of a series of text items,
36275 separated by lines consisting of exactly four asterisks. If the file cannot be
36276 opened, default text is used and a message is written to the main and panic
36277 logs. If any text item in the file is empty, default text is used for that
36278 item.
36279
36280 .vindex "&$bounce_recipient$&"
36281 .vindex "&$bounce_return_size_limit$&"
36282 Each item of text that is read from the file is expanded, and there are two
36283 expansion variables which can be of use here: &$bounce_recipient$& is set to
36284 the recipient of an error message while it is being created, and
36285 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36286 option, rounded to a whole number.
36287
36288 The items must appear in the file in the following order:
36289
36290 .ilist
36291 The first item is included in the headers, and should include at least a
36292 &'Subject:'& header. Exim does not check the syntax of these headers.
36293 .next
36294 The second item forms the start of the error message. After it, Exim lists the
36295 failing addresses with their error messages.
36296 .next
36297 The third item is used to introduce any text from pipe transports that is to be
36298 returned to the sender. It is omitted if there is no such text.
36299 .next
36300 The fourth, fifth and sixth items will be ignored and may be empty.
36301 The fields exist for back-compatibility
36302 .endlist
36303
36304 The default state (&%bounce_message_file%& unset) is equivalent to the
36305 following file, in which the sixth item is empty. The &'Subject:'& and some
36306 other lines have been split in order to fit them on the page:
36307 .code
36308 Subject: Mail delivery failed
36309   ${if eq{$sender_address}{$bounce_recipient}
36310   {: returning message to sender}}
36311 ****
36312 This message was created automatically by mail delivery software.
36313
36314 A message ${if eq{$sender_address}{$bounce_recipient}
36315   {that you sent }{sent by
36316
36317 <$sender_address>
36318
36319 }}could not be delivered to all of its recipients.
36320 This is a permanent error. The following address(es) failed:
36321 ****
36322 The following text was generated during the delivery attempt(s):
36323 ****
36324 ------ This is a copy of the message, including all the headers.
36325   ------
36326 ****
36327 ------ The body of the message is $message_size characters long;
36328   only the first
36329 ------ $bounce_return_size_limit or so are included here.
36330 ****
36331 .endd
36332 .section "Customizing warning messages" "SECTcustwarn"
36333 .cindex "customizing" "warning message"
36334 .cindex "warning of delay" "customizing the message"
36335 The option &%warn_message_file%& can be pointed at a template file for use when
36336 warnings about message delays are created. In this case there are only three
36337 text sections:
36338
36339 .ilist
36340 The first item is included in the headers, and should include at least a
36341 &'Subject:'& header. Exim does not check the syntax of these headers.
36342 .next
36343 The second item forms the start of the warning message. After it, Exim lists
36344 the delayed addresses.
36345 .next
36346 The third item then ends the message.
36347 .endlist
36348
36349 The default state is equivalent to the following file, except that some lines
36350 have been split here, in order to fit them on the page:
36351 .code
36352 Subject: Warning: message $message_exim_id delayed
36353   $warn_message_delay
36354 ****
36355 This message was created automatically by mail delivery software.
36356
36357 A message ${if eq{$sender_address}{$warn_message_recipients}
36358 {that you sent }{sent by
36359
36360 <$sender_address>
36361
36362 }}has not been delivered to all of its recipients after
36363 more than $warn_message_delay in the queue on $primary_hostname.
36364
36365 The message identifier is:     $message_exim_id
36366 The subject of the message is: $h_subject
36367 The date of the message is:    $h_date
36368
36369 The following address(es) have not yet been delivered:
36370 ****
36371 No action is required on your part. Delivery attempts will
36372 continue for some time, and this warning may be repeated at
36373 intervals if the message remains undelivered. Eventually the
36374 mail delivery software will give up, and when that happens,
36375 the message will be returned to you.
36376 .endd
36377 .vindex "&$warn_message_delay$&"
36378 .vindex "&$warn_message_recipients$&"
36379 However, in the default state the subject and date lines are omitted if no
36380 appropriate headers exist. During the expansion of this file,
36381 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36382 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36383 of recipients for the warning message. There may be more than one if there are
36384 multiple addresses with different &%errors_to%& settings on the routers that
36385 handled them.
36386
36387
36388
36389
36390 . ////////////////////////////////////////////////////////////////////////////
36391 . ////////////////////////////////////////////////////////////////////////////
36392
36393 .chapter "Some common configuration settings" "CHAPcomconreq"
36394 This chapter discusses some configuration settings that seem to be fairly
36395 common. More examples and discussion can be found in the Exim book.
36396
36397
36398
36399 .section "Sending mail to a smart host" "SECID240"
36400 .cindex "smart host" "example router"
36401 If you want to send all mail for non-local domains to a &"smart host"&, you
36402 should replace the default &(dnslookup)& router with a router which does the
36403 routing explicitly:
36404 .code
36405 send_to_smart_host:
36406   driver = manualroute
36407   route_list = !+local_domains smart.host.name
36408   transport = remote_smtp
36409 .endd
36410 You can use the smart host's IP address instead of the name if you wish.
36411 If you are using Exim only to submit messages to a smart host, and not for
36412 receiving incoming messages, you can arrange for it to do the submission
36413 synchronously by setting the &%mua_wrapper%& option (see chapter
36414 &<<CHAPnonqueueing>>&).
36415
36416
36417
36418
36419 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36420 .cindex "mailing lists"
36421 Exim can be used to run simple mailing lists, but for large and/or complicated
36422 requirements, the use of additional specialized mailing list software such as
36423 Majordomo or Mailman is recommended.
36424
36425 The &(redirect)& router can be used to handle mailing lists where each list
36426 is maintained in a separate file, which can therefore be managed by an
36427 independent manager. The &%domains%& router option can be used to run these
36428 lists in a separate domain from normal mail. For example:
36429 .code
36430 lists:
36431   driver = redirect
36432   domains = lists.example
36433   file = /usr/lists/$local_part
36434   forbid_pipe
36435   forbid_file
36436   errors_to = $local_part-request@lists.example
36437   no_more
36438 .endd
36439 This router is skipped for domains other than &'lists.example'&. For addresses
36440 in that domain, it looks for a file that matches the local part. If there is no
36441 such file, the router declines, but because &%no_more%& is set, no subsequent
36442 routers are tried, and so the whole delivery fails.
36443
36444 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36445 expanded into a filename or a pipe delivery, which is usually inappropriate in
36446 a mailing list.
36447
36448 .oindex "&%errors_to%&"
36449 The &%errors_to%& option specifies that any delivery errors caused by addresses
36450 taken from a mailing list are to be sent to the given address rather than the
36451 original sender of the message. However, before acting on this, Exim verifies
36452 the error address, and ignores it if verification fails.
36453
36454 For example, using the configuration above, mail sent to
36455 &'dicts@lists.example'& is passed on to those addresses contained in
36456 &_/usr/lists/dicts_&, with error reports directed to
36457 &'dicts-request@lists.example'&, provided that this address can be verified.
36458 There could be a file called &_/usr/lists/dicts-request_& containing
36459 the address(es) of this particular list's manager(s), but other approaches,
36460 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36461 or &%local_part_suffix%& options) to handle addresses of the form
36462 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36463
36464
36465
36466 .section "Syntax errors in mailing lists" "SECID241"
36467 .cindex "mailing lists" "syntax errors in"
36468 If an entry in redirection data contains a syntax error, Exim normally defers
36469 delivery of the original address. That means that a syntax error in a mailing
36470 list holds up all deliveries to the list. This may not be appropriate when a
36471 list is being maintained automatically from data supplied by users, and the
36472 addresses are not rigorously checked.
36473
36474 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36475 entries that fail to parse, noting the incident in the log. If in addition
36476 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36477 whenever a broken address is skipped. It is usually appropriate to set
36478 &%syntax_errors_to%& to the same address as &%errors_to%&.
36479
36480
36481
36482 .section "Re-expansion of mailing lists" "SECID242"
36483 .cindex "mailing lists" "re-expansion of"
36484 Exim remembers every individual address to which a message has been delivered,
36485 in order to avoid duplication, but it normally stores only the original
36486 recipient addresses with a message. If all the deliveries to a mailing list
36487 cannot be done at the first attempt, the mailing list is re-expanded when the
36488 delivery is next tried. This means that alterations to the list are taken into
36489 account at each delivery attempt, so addresses that have been added to
36490 the list since the message arrived will therefore receive a copy of the
36491 message, even though it pre-dates their subscription.
36492
36493 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36494 on the &(redirect)& router. If this is done, any addresses generated by the
36495 router that fail to deliver at the first attempt are added to the message as
36496 &"top level"& addresses, and the parent address that generated them is marked
36497 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36498 subsequent delivery attempts. The disadvantage of this is that if any of the
36499 failing addresses are incorrect, correcting them in the file has no effect on
36500 pre-existing messages.
36501
36502 The original top-level address is remembered with each of the generated
36503 addresses, and is output in any log messages. However, any intermediate parent
36504 addresses are not recorded. This makes a difference to the log only if the
36505 &%all_parents%& selector is set, but for mailing lists there is normally only
36506 one level of expansion anyway.
36507
36508
36509
36510 .section "Closed mailing lists" "SECID243"
36511 .cindex "mailing lists" "closed"
36512 The examples so far have assumed open mailing lists, to which anybody may
36513 send mail. It is also possible to set up closed lists, where mail is accepted
36514 from specified senders only. This is done by making use of the generic
36515 &%senders%& option to restrict the router that handles the list.
36516
36517 The following example uses the same file as a list of recipients and as a list
36518 of permitted senders. It requires three routers:
36519 .code
36520 lists_request:
36521   driver = redirect
36522   domains = lists.example
36523   local_part_suffix = -request
36524   file = /usr/lists/$local_part$local_part_suffix
36525   no_more
36526
36527 lists_post:
36528   driver = redirect
36529   domains = lists.example
36530   senders = ${if exists {/usr/lists/$local_part}\
36531              {lsearch;/usr/lists/$local_part}{*}}
36532   file = /usr/lists/$local_part
36533   forbid_pipe
36534   forbid_file
36535   errors_to = $local_part-request@lists.example
36536   no_more
36537
36538 lists_closed:
36539   driver = redirect
36540   domains = lists.example
36541   allow_fail
36542   data = :fail: $local_part@lists.example is a closed mailing list
36543 .endd
36544 All three routers have the same &%domains%& setting, so for any other domains,
36545 they are all skipped. The first router runs only if the local part ends in
36546 &%-request%&. It handles messages to the list manager(s) by means of an open
36547 mailing list.
36548
36549 The second router runs only if the &%senders%& precondition is satisfied. It
36550 checks for the existence of a list that corresponds to the local part, and then
36551 checks that the sender is on the list by means of a linear search. It is
36552 necessary to check for the existence of the file before trying to search it,
36553 because otherwise Exim thinks there is a configuration error. If the file does
36554 not exist, the expansion of &%senders%& is *, which matches all senders. This
36555 means that the router runs, but because there is no list, declines, and
36556 &%no_more%& ensures that no further routers are run. The address fails with an
36557 &"unrouteable address"& error.
36558
36559 The third router runs only if the second router is skipped, which happens when
36560 a mailing list exists, but the sender is not on it. This router forcibly fails
36561 the address, giving a suitable error message.
36562
36563
36564
36565
36566 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36567 .cindex "VERP"
36568 .cindex "Variable Envelope Return Paths"
36569 .cindex "envelope from"
36570 .cindex "envelope sender"
36571 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36572 are a way of helping mailing list administrators discover which subscription
36573 address is the cause of a particular delivery failure. The idea is to encode
36574 the original recipient address in the outgoing envelope sender address, so that
36575 if the message is forwarded by another host and then subsequently bounces, the
36576 original recipient can be extracted from the recipient address of the bounce.
36577
36578 .oindex &%errors_to%&
36579 .oindex &%return_path%&
36580 Envelope sender addresses can be modified by Exim using two different
36581 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36582 list examples), or the &%return_path%& option on a transport. The second of
36583 these is effective only if the message is successfully delivered to another
36584 host; it is not used for errors detected on the local host (see the description
36585 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36586 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36587 .code
36588 verp_smtp:
36589   driver = smtp
36590   max_rcpt = 1
36591   return_path = \
36592     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36593       {$1-request+$local_part=$domain@your.dom.example}fail}
36594 .endd
36595 This has the effect of rewriting the return path (envelope sender) on outgoing
36596 SMTP messages, if the local part of the original return path ends in
36597 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36598 local part and domain of the recipient into the return path. Suppose, for
36599 example, that a message whose return path has been set to
36600 &'somelist-request@your.dom.example'& is sent to
36601 &'subscriber@other.dom.example'&. In the transport, the return path is
36602 rewritten as
36603 .code
36604 somelist-request+subscriber=other.dom.example@your.dom.example
36605 .endd
36606 .vindex "&$local_part$&"
36607 For this to work, you must tell Exim to send multiple copies of messages that
36608 have more than one recipient, so that each copy has just one recipient. This is
36609 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36610 might be sent to several different recipients in the same domain, in which case
36611 &$local_part$& is not available in the transport, because it is not unique.
36612
36613 Unless your host is doing nothing but mailing list deliveries, you should
36614 probably use a separate transport for the VERP deliveries, so as not to use
36615 extra resources in making one-per-recipient copies for other deliveries. This
36616 can easily be done by expanding the &%transport%& option in the router:
36617 .code
36618 dnslookup:
36619   driver = dnslookup
36620   domains = ! +local_domains
36621   transport = \
36622     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36623       {verp_smtp}{remote_smtp}}
36624   no_more
36625 .endd
36626 If you want to change the return path using &%errors_to%& in a router instead
36627 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36628 routers that handle mailing list addresses. This will ensure that all delivery
36629 errors, including those detected on the local host, are sent to the VERP
36630 address.
36631
36632 On a host that does no local deliveries and has no manual routing, only the
36633 &(dnslookup)& router needs to be changed. A special transport is not needed for
36634 SMTP deliveries. Every mailing list recipient has its own return path value,
36635 and so Exim must hand them to the transport one at a time. Here is an example
36636 of a &(dnslookup)& router that implements VERP:
36637 .code
36638 verp_dnslookup:
36639   driver = dnslookup
36640   domains = ! +local_domains
36641   transport = remote_smtp
36642   errors_to = \
36643     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36644      {$1-request+$local_part=$domain@your.dom.example}fail}
36645   no_more
36646 .endd
36647 Before you start sending out messages with VERPed return paths, you must also
36648 configure Exim to accept the bounce messages that come back to those paths.
36649 Typically this is done by setting a &%local_part_suffix%& option for a
36650 router, and using this to route the messages to wherever you want to handle
36651 them.
36652
36653 The overhead incurred in using VERP depends very much on the size of the
36654 message, the number of recipient addresses that resolve to the same remote
36655 host, and the speed of the connection over which the message is being sent. If
36656 a lot of addresses resolve to the same host and the connection is slow, sending
36657 a separate copy of the message for each address may take substantially longer
36658 than sending a single copy with many recipients (for which VERP cannot be
36659 used).
36660
36661
36662
36663
36664
36665
36666 .section "Virtual domains" "SECTvirtualdomains"
36667 .cindex "virtual domains"
36668 .cindex "domain" "virtual"
36669 The phrase &'virtual domain'& is unfortunately used with two rather different
36670 meanings:
36671
36672 .ilist
36673 A domain for which there are no real mailboxes; all valid local parts are
36674 aliases for other email addresses. Common examples are organizational
36675 top-level domains and &"vanity"& domains.
36676 .next
36677 One of a number of independent domains that are all handled by the same host,
36678 with mailboxes on that host, but where the mailbox owners do not necessarily
36679 have login accounts on that host.
36680 .endlist
36681
36682 The first usage is probably more common, and does seem more &"virtual"& than
36683 the second. This kind of domain can be handled in Exim with a straightforward
36684 aliasing router. One approach is to create a separate alias file for each
36685 virtual domain. Exim can test for the existence of the alias file to determine
36686 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36687 to a router of this form:
36688 .code
36689 virtual:
36690   driver = redirect
36691   domains = dsearch;/etc/mail/virtual
36692   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36693   no_more
36694 .endd
36695 The &%domains%& option specifies that the router is to be skipped, unless there
36696 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36697 domain that is being processed. When the router runs, it looks up the local
36698 part in the file to find a new address (or list of addresses). The &%no_more%&
36699 setting ensures that if the lookup fails (leading to &%data%& being an empty
36700 string), Exim gives up on the address without trying any subsequent routers.
36701
36702 This one router can handle all the virtual domains because the alias filenames
36703 follow a fixed pattern. Permissions can be arranged so that appropriate people
36704 can edit the different alias files. A successful aliasing operation results in
36705 a new envelope recipient address, which is then routed from scratch.
36706
36707 The other kind of &"virtual"& domain can also be handled in a straightforward
36708 way. One approach is to create a file for each domain containing a list of
36709 valid local parts, and use it in a router like this:
36710 .code
36711 my_domains:
36712   driver = accept
36713   domains = dsearch;/etc/mail/domains
36714   local_parts = lsearch;/etc/mail/domains/$domain
36715   transport = my_mailboxes
36716 .endd
36717 The address is accepted if there is a file for the domain, and the local part
36718 can be found in the file. The &%domains%& option is used to check for the
36719 file's existence because &%domains%& is tested before the &%local_parts%&
36720 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36721 because that option is tested after &%local_parts%&. The transport is as
36722 follows:
36723 .code
36724 my_mailboxes:
36725   driver = appendfile
36726   file = /var/mail/$domain/$local_part
36727   user = mail
36728 .endd
36729 This uses a directory of mailboxes for each domain. The &%user%& setting is
36730 required, to specify which uid is to be used for writing to the mailboxes.
36731
36732 The configuration shown here is just one example of how you might support this
36733 requirement. There are many other ways this kind of configuration can be set
36734 up, for example, by using a database instead of separate files to hold all the
36735 information about the domains.
36736
36737
36738
36739 .section "Multiple user mailboxes" "SECTmulbox"
36740 .cindex "multiple mailboxes"
36741 .cindex "mailbox" "multiple"
36742 .cindex "local part" "prefix"
36743 .cindex "local part" "suffix"
36744 Heavy email users often want to operate with multiple mailboxes, into which
36745 incoming mail is automatically sorted. A popular way of handling this is to
36746 allow users to use multiple sender addresses, so that replies can easily be
36747 identified. Users are permitted to add prefixes or suffixes to their local
36748 parts for this purpose. The wildcard facility of the generic router options
36749 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36750 example, consider this router:
36751 .code
36752 userforward:
36753   driver = redirect
36754   check_local_user
36755   file = $home/.forward
36756   local_part_suffix = -*
36757   local_part_suffix_optional
36758   allow_filter
36759 .endd
36760 .vindex "&$local_part_suffix$&"
36761 It runs a user's &_.forward_& file for all local parts of the form
36762 &'username-*'&. Within the filter file the user can distinguish different
36763 cases by testing the variable &$local_part_suffix$&. For example:
36764 .code
36765 if $local_part_suffix contains -special then
36766 save /home/$local_part/Mail/special
36767 endif
36768 .endd
36769 If the filter file does not exist, or does not deal with such addresses, they
36770 fall through to subsequent routers, and, assuming no subsequent use of the
36771 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36772 control over which suffixes are valid.
36773
36774 Alternatively, a suffix can be used to trigger the use of a different
36775 &_.forward_& file &-- which is the way a similar facility is implemented in
36776 another MTA:
36777 .code
36778 userforward:
36779   driver = redirect
36780   check_local_user
36781   file = $home/.forward$local_part_suffix
36782   local_part_suffix = -*
36783   local_part_suffix_optional
36784   allow_filter
36785 .endd
36786 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36787 example, &_.forward-special_& is used. Once again, if the appropriate file
36788 does not exist, or does not deal with the address, it is passed on to
36789 subsequent routers, which could, if required, look for an unqualified
36790 &_.forward_& file to use as a default.
36791
36792
36793
36794 .section "Simplified vacation processing" "SECID244"
36795 .cindex "vacation processing"
36796 The traditional way of running the &'vacation'& program is for a user to set up
36797 a pipe command in a &_.forward_& file
36798 (see section &<<SECTspecitredli>>& for syntax details).
36799 This is prone to error by inexperienced users. There are two features of Exim
36800 that can be used to make this process simpler for users:
36801
36802 .ilist
36803 A local part prefix such as &"vacation-"& can be specified on a router which
36804 can cause the message to be delivered directly to the &'vacation'& program, or
36805 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36806 &_.forward_& file are then much simpler. For example:
36807 .code
36808 spqr, vacation-spqr
36809 .endd
36810 .next
36811 The &%require_files%& generic router option can be used to trigger a
36812 vacation delivery by checking for the existence of a certain file in the
36813 user's home directory. The &%unseen%& generic option should also be used, to
36814 ensure that the original delivery also proceeds. In this case, all the user has
36815 to do is to create a file called, say, &_.vacation_&, containing a vacation
36816 message.
36817 .endlist
36818
36819 Another advantage of both these methods is that they both work even when the
36820 use of arbitrary pipes by users is locked out.
36821
36822
36823
36824 .section "Taking copies of mail" "SECID245"
36825 .cindex "message" "copying every"
36826 Some installations have policies that require archive copies of all messages to
36827 be made. A single copy of each message can easily be taken by an appropriate
36828 command in a system filter, which could, for example, use a different file for
36829 each day's messages.
36830
36831 There is also a shadow transport mechanism that can be used to take copies of
36832 messages that are successfully delivered by local transports, one copy per
36833 delivery. This could be used, &'inter alia'&, to implement automatic
36834 notification of delivery by sites that insist on doing such things.
36835
36836
36837
36838 .section "Intermittently connected hosts" "SECID246"
36839 .cindex "intermittently connected hosts"
36840 It has become quite common (because it is cheaper) for hosts to connect to the
36841 Internet periodically rather than remain connected all the time. The normal
36842 arrangement is that mail for such hosts accumulates on a system that is
36843 permanently connected.
36844
36845 Exim was designed for use on permanently connected hosts, and so it is not
36846 particularly well-suited to use in an intermittently connected environment.
36847 Nevertheless there are some features that can be used.
36848
36849
36850 .section "Exim on the upstream server host" "SECID247"
36851 It is tempting to arrange for incoming mail for the intermittently connected
36852 host to remain in Exim's queue until the client connects. However, this
36853 approach does not scale very well. Two different kinds of waiting message are
36854 being mixed up in the same queue &-- those that cannot be delivered because of
36855 some temporary problem, and those that are waiting for their destination host
36856 to connect. This makes it hard to manage the queue, as well as wasting
36857 resources, because each queue runner scans the entire queue.
36858
36859 A better approach is to separate off those messages that are waiting for an
36860 intermittently connected host. This can be done by delivering these messages
36861 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36862 format, from where they are transmitted by other software when their
36863 destination connects. This makes it easy to collect all the mail for one host
36864 in a single directory, and to apply local timeout rules on a per-message basis
36865 if required.
36866
36867 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36868 you are doing this, you should configure Exim with a long retry period for the
36869 intermittent host. For example:
36870 .code
36871 cheshire.wonderland.fict.example    *   F,5d,24h
36872 .endd
36873 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36874 which messages it has queued up for that host. Once the intermittent host comes
36875 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36876 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36877 causes all the queued up messages to be delivered, often down a single SMTP
36878 connection. While the host remains connected, any new messages get delivered
36879 immediately.
36880
36881 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36882 issued with a different IP address each time it connects, Exim's retry
36883 mechanisms on the holding host get confused, because the IP address is normally
36884 used as part of the key string for holding retry information. This can be
36885 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36886 Since this has disadvantages for permanently connected hosts, it is best to
36887 arrange a separate transport for the intermittently connected ones.
36888
36889
36890
36891 .section "Exim on the intermittently connected client host" "SECID248"
36892 The value of &%smtp_accept_queue_per_connection%& should probably be
36893 increased, or even set to zero (that is, disabled) on the intermittently
36894 connected host, so that all incoming messages down a single connection get
36895 delivered immediately.
36896
36897 .cindex "SMTP" "passed connection"
36898 .cindex "SMTP" "multiple deliveries"
36899 .cindex "multiple SMTP deliveries"
36900 .cindex "first pass routing"
36901 Mail waiting to be sent from an intermittently connected host will probably
36902 not have been routed, because without a connection DNS lookups are not
36903 possible. This means that if a normal queue run is done at connection time,
36904 each message is likely to be sent in a separate SMTP session. This can be
36905 avoided by starting the queue run with a command line option beginning with
36906 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36907 first pass, routing is done but no deliveries take place. The second pass is a
36908 normal queue run; since all the messages have been previously routed, those
36909 destined for the same host are likely to get sent as multiple deliveries in a
36910 single SMTP connection.
36911
36912
36913
36914 . ////////////////////////////////////////////////////////////////////////////
36915 . ////////////////////////////////////////////////////////////////////////////
36916
36917 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36918          "Exim as a non-queueing client"
36919 .cindex "client, non-queueing"
36920 .cindex "smart host" "suppressing queueing"
36921 On a personal computer, it is a common requirement for all
36922 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36923 configured to operate that way, for all the popular operating systems.
36924 However, there are some MUAs for Unix-like systems that cannot be so
36925 configured: they submit messages using the command line interface of
36926 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36927 messages this way.
36928
36929 If the personal computer runs continuously, there is no problem, because it can
36930 run a conventional MTA that handles delivery to the smart host, and deal with
36931 any delays via its queueing mechanism. However, if the computer does not run
36932 continuously or runs different operating systems at different times, queueing
36933 email is not desirable.
36934
36935 There is therefore a requirement for something that can provide the
36936 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36937 any queueing or retrying facilities. Furthermore, the delivery to the smart
36938 host should be synchronous, so that if it fails, the sending MUA is immediately
36939 informed. In other words, we want something that extends an MUA that submits
36940 to a local MTA via the command line so that it behaves like one that submits
36941 to a remote smart host using TCP/SMTP.
36942
36943 There are a number of applications (for example, there is one called &'ssmtp'&)
36944 that do this job. However, people have found them to be lacking in various
36945 ways. For instance, you might want to allow aliasing and forwarding to be done
36946 before sending a message to the smart host.
36947
36948 Exim already had the necessary infrastructure for doing this job. Just a few
36949 tweaks were needed to make it behave as required, though it is somewhat of an
36950 overkill to use a fully-featured MTA for this purpose.
36951
36952 .oindex "&%mua_wrapper%&"
36953 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36954 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36955 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36956 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36957 compatible router and transport configuration. Typically there will be just one
36958 router and one transport, sending everything to a smart host.
36959
36960 When run in MUA wrapping mode, the behaviour of Exim changes in the
36961 following ways:
36962
36963 .ilist
36964 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36965 In other words, the only way to submit messages is via the command line.
36966 .next
36967 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36968 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36969 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36970 does not finish until the delivery attempt is complete. If the delivery is
36971 successful, a zero return code is given.
36972 .next
36973 Address redirection is permitted, but the final routing for all addresses must
36974 be to the same remote transport, and to the same list of hosts. Furthermore,
36975 the return address (envelope sender) must be the same for all recipients, as
36976 must any added or deleted header lines. In other words, it must be possible to
36977 deliver the message in a single SMTP transaction, however many recipients there
36978 are.
36979 .next
36980 If these conditions are not met, or if routing any address results in a
36981 failure or defer status, or if Exim is unable to deliver all the recipients
36982 successfully to one of the smart hosts, delivery of the entire message fails.
36983 .next
36984 Because no queueing is allowed, all failures are treated as permanent; there
36985 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36986 smart host. Furthermore, because only a single yes/no response can be given to
36987 the caller, it is not possible to deliver to some recipients and not others. If
36988 there is an error (temporary or permanent) for any recipient, all are failed.
36989 .next
36990 If more than one smart host is listed, Exim will try another host after a
36991 connection failure or a timeout, in the normal way. However, if this kind of
36992 failure happens for all the hosts, the delivery fails.
36993 .next
36994 When delivery fails, an error message is written to the standard error stream
36995 (as well as to Exim's log), and Exim exits to the caller with a return code
36996 value 1. The message is expunged from Exim's spool files. No bounce messages
36997 are ever generated.
36998 .next
36999 No retry data is maintained, and any retry rules are ignored.
37000 .next
37001 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37002 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37003 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37004 .endlist
37005
37006 The overall effect is that Exim makes a single synchronous attempt to deliver
37007 the message, failing if there is any kind of problem. Because no local
37008 deliveries are done and no daemon can be run, Exim does not need root
37009 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37010 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37011 the advantages and disadvantages of running without root privilege.
37012
37013
37014
37015
37016 . ////////////////////////////////////////////////////////////////////////////
37017 . ////////////////////////////////////////////////////////////////////////////
37018
37019 .chapter "Log files" "CHAPlog"
37020 .scindex IIDloggen "log" "general description"
37021 .cindex "log" "types of"
37022 Exim writes three different logs, referred to as the main log, the reject log,
37023 and the panic log:
37024
37025 .ilist
37026 .cindex "main log"
37027 The main log records the arrival of each message and each delivery in a single
37028 line in each case. The format is as compact as possible, in an attempt to keep
37029 down the size of log files. Two-character flag sequences make it easy to pick
37030 out these lines. A number of other events are recorded in the main log. Some of
37031 them are optional, in which case the &%log_selector%& option controls whether
37032 they are included or not. A Perl script called &'eximstats'&, which does simple
37033 analysis of main log files, is provided in the Exim distribution (see section
37034 &<<SECTmailstat>>&).
37035 .next
37036 .cindex "reject log"
37037 The reject log records information from messages that are rejected as a result
37038 of a configuration option (that is, for policy reasons).
37039 The first line of each rejection is a copy of the line that is also written to
37040 the main log. Then, if the message's header has been read at the time the log
37041 is written, its contents are written to this log. Only the original header
37042 lines are available; header lines added by ACLs are not logged. You can use the
37043 reject log to check that your policy controls are working correctly; on a busy
37044 host this may be easier than scanning the main log for rejection messages. You
37045 can suppress the writing of the reject log by setting &%write_rejectlog%&
37046 false.
37047 .next
37048 .cindex "panic log"
37049 .cindex "system log"
37050 When certain serious errors occur, Exim writes entries to its panic log. If the
37051 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37052 are usually written to the main log as well, but can get lost amid the mass of
37053 other entries. The panic log should be empty under normal circumstances. It is
37054 therefore a good idea to check it (or to have a &'cron'& script check it)
37055 regularly, in order to become aware of any problems. When Exim cannot open its
37056 panic log, it tries as a last resort to write to the system log (syslog). This
37057 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37058 message itself is written at priority LOG_CRIT.
37059 .endlist
37060
37061 Every log line starts with a timestamp, in the format shown in the following
37062 example. Note that many of the examples shown in this chapter are line-wrapped.
37063 In the log file, this would be all on one line:
37064 .code
37065 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37066   by QUIT
37067 .endd
37068 By default, the timestamps are in the local timezone. There are two
37069 ways of changing this:
37070
37071 .ilist
37072 You can set the &%timezone%& option to a different time zone; in particular, if
37073 you set
37074 .code
37075 timezone = UTC
37076 .endd
37077 the timestamps will be in UTC (aka GMT).
37078 .next
37079 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37080 example:
37081 .code
37082 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37083 .endd
37084 .endlist
37085
37086 .cindex "log" "process ids in"
37087 .cindex "pid (process id)" "in log lines"
37088 Exim does not include its process id in log lines by default, but you can
37089 request that it does so by specifying the &`pid`& log selector (see section
37090 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37091 brackets, immediately after the time and date.
37092
37093
37094
37095
37096 .section "Where the logs are written" "SECTwhelogwri"
37097 .cindex "log" "destination"
37098 .cindex "log" "to file"
37099 .cindex "log" "to syslog"
37100 .cindex "syslog"
37101 The logs may be written to local files, or to syslog, or both. However, it
37102 should be noted that many syslog implementations use UDP as a transport, and
37103 are therefore unreliable in the sense that messages are not guaranteed to
37104 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37105 It has also been reported that on large log files (tens of megabytes) you may
37106 need to tweak syslog to prevent it syncing the file with each write &-- on
37107 Linux this has been seen to make syslog take 90% plus of CPU time.
37108
37109 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37110 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37111 configuration. This latter string is expanded, so it can contain, for example,
37112 references to the host name:
37113 .code
37114 log_file_path = /var/log/$primary_hostname/exim_%slog
37115 .endd
37116 It is generally advisable, however, to set the string in &_Local/Makefile_&
37117 rather than at runtime, because then the setting is available right from the
37118 start of Exim's execution. Otherwise, if there's something it wants to log
37119 before it has read the configuration file (for example, an error in the
37120 configuration file) it will not use the path you want, and may not be able to
37121 log at all.
37122
37123 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37124 list, currently limited to at most two items. This is one option where the
37125 facility for changing a list separator may not be used. The list must always be
37126 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37127 otherwise the item must either be an absolute path, containing &`%s`& at the
37128 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37129 implying the use of a default path.
37130
37131 When Exim encounters an empty item in the list, it searches the list defined by
37132 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37133 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37134 mean &"use the path specified at build time"&. It no such item exists, log
37135 files are written in the &_log_& subdirectory of the spool directory. This is
37136 equivalent to the setting:
37137 .code
37138 log_file_path = $spool_directory/log/%slog
37139 .endd
37140 If you do not specify anything at build time or runtime,
37141 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37142 that is where the logs are written.
37143
37144 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37145 are in use &-- see section &<<SECTdatlogfil>>& below.
37146
37147 Here are some examples of possible settings:
37148 .display
37149 &`LOG_FILE_PATH=syslog                    `& syslog only
37150 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37151 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37152 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37153 .endd
37154 If there are more than two paths in the list, the first is used and a panic
37155 error is logged.
37156
37157
37158
37159 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37160 .cindex "log" "cycling local files"
37161 .cindex "cycling logs"
37162 .cindex "&'exicyclog'&"
37163 .cindex "log" "local files; writing to"
37164 Some operating systems provide centralized and standardized methods for cycling
37165 log files. For those that do not, a utility script called &'exicyclog'& is
37166 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37167 main and reject logs each time it is called. The maximum number of old logs to
37168 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37169
37170 An Exim delivery process opens the main log when it first needs to write to it,
37171 and it keeps the file open in case subsequent entries are required &-- for
37172 example, if a number of different deliveries are being done for the same
37173 message. However, remote SMTP deliveries can take a long time, and this means
37174 that the file may be kept open long after it is renamed if &'exicyclog'& or
37175 something similar is being used to rename log files on a regular basis. To
37176 ensure that a switch of log files is noticed as soon as possible, Exim calls
37177 &[stat()]& on the main log's name before reusing an open file, and if the file
37178 does not exist, or its inode has changed, the old file is closed and Exim
37179 tries to open the main log from scratch. Thus, an old log file may remain open
37180 for quite some time, but no Exim processes should write to it once it has been
37181 renamed.
37182
37183
37184
37185 .section "Datestamped log files" "SECTdatlogfil"
37186 .cindex "log" "datestamped files"
37187 Instead of cycling the main and reject log files by renaming them
37188 periodically, some sites like to use files whose names contain a datestamp,
37189 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37190 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37191 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37192 point where the datestamp is required. For example:
37193 .code
37194 log_file_path = /var/spool/exim/log/%slog-%D
37195 log_file_path = /var/log/exim-%s-%D.log
37196 log_file_path = /var/spool/exim/log/%D-%slog
37197 log_file_path = /var/log/exim/%s.%M
37198 .endd
37199 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37200 examples of names generated by the above examples:
37201 .code
37202 /var/spool/exim/log/mainlog-20021225
37203 /var/log/exim-reject-20021225.log
37204 /var/spool/exim/log/20021225-mainlog
37205 /var/log/exim/main.200212
37206 .endd
37207 When this form of log file is specified, Exim automatically switches to new
37208 files at midnight. It does not make any attempt to compress old logs; you
37209 will need to write your own script if you require this. You should not
37210 run &'exicyclog'& with this form of logging.
37211
37212 The location of the panic log is also determined by &%log_file_path%&, but it
37213 is not datestamped, because rotation of the panic log does not make sense.
37214 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37215 the string. In addition, if it immediately follows a slash, a following
37216 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37217 character is removed. Thus, the four examples above would give these panic
37218 log names:
37219 .code
37220 /var/spool/exim/log/paniclog
37221 /var/log/exim-panic.log
37222 /var/spool/exim/log/paniclog
37223 /var/log/exim/panic
37224 .endd
37225
37226
37227 .section "Logging to syslog" "SECID249"
37228 .cindex "log" "syslog; writing to"
37229 The use of syslog does not change what Exim logs or the format of its messages,
37230 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37231 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37232 that, the same strings are written to syslog as to log files. The syslog
37233 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37234 by default, but you can change these by setting the &%syslog_facility%& and
37235 &%syslog_processname%& options, respectively. If Exim was compiled with
37236 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37237 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37238 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37239 the time and host name to each line.
37240 The three log streams are mapped onto syslog priorities as follows:
37241
37242 .ilist
37243 &'mainlog'& is mapped to LOG_INFO
37244 .next
37245 &'rejectlog'& is mapped to LOG_NOTICE
37246 .next
37247 &'paniclog'& is mapped to LOG_ALERT
37248 .endlist
37249
37250 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37251 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37252 these are routed by syslog to the same place. You can suppress this duplication
37253 by setting &%syslog_duplication%& false.
37254
37255 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37256 entries contain multiple lines when headers are included. To cope with both
37257 these cases, entries written to syslog are split into separate &[syslog()]&
37258 calls at each internal newline, and also after a maximum of
37259 870 data characters. (This allows for a total syslog line length of 1024, when
37260 additions such as timestamps are added.) If you are running a syslog
37261 replacement that can handle lines longer than the 1024 characters allowed by
37262 RFC 3164, you should set
37263 .code
37264 SYSLOG_LONG_LINES=yes
37265 .endd
37266 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37267 lines, but it still splits at internal newlines in &'reject'& log entries.
37268
37269 To make it easy to re-assemble split lines later, each component of a split
37270 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37271 where <&'n'&> is the component number and <&'m'&> is the total number of
37272 components in the entry. The / delimiter is used when the line was split
37273 because it was too long; if it was split because of an internal newline, the \
37274 delimiter is used. For example, supposing the length limit to be 50 instead of
37275 870, the following would be the result of a typical rejection message to
37276 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37277 name, and pid as added by syslog:
37278 .code
37279 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37280 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37281 [3/5]  when scanning for sender: missing or malformed lo
37282 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37283 [5/5] mple>)
37284 .endd
37285 The same error might cause the following lines to be written to &"rejectlog"&
37286 (LOG_NOTICE):
37287 .code
37288 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37289 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37290 [3/18] er when scanning for sender: missing or malformed
37291 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37292 [5\18] .example>)
37293 [6\18] Recipients: ph10@some.domain.cam.example
37294 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37295 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37296 [9\18]        id 16RdAL-0006pc-00
37297 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37298 [11\18] 09:43 +0100
37299 [12\18] F From: <>
37300 [13\18]   Subject: this is a test header
37301 [18\18]   X-something: this is another header
37302 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37303 [16\18] le>
37304 [17\18] B Bcc:
37305 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37306 .endd
37307 Log lines that are neither too long nor contain newlines are written to syslog
37308 without modification.
37309
37310 If only syslog is being used, the Exim monitor is unable to provide a log tail
37311 display, unless syslog is routing &'mainlog'& to a file on the local host and
37312 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37313 where it is.
37314
37315
37316
37317 .section "Log line flags" "SECID250"
37318 One line is written to the main log for each message received, and for each
37319 successful, unsuccessful, and delayed delivery. These lines can readily be
37320 picked out by the distinctive two-character flags that immediately follow the
37321 timestamp. The flags are:
37322 .display
37323 &`<=`&     message arrival
37324 &`(=`&     message fakereject
37325 &`=>`&     normal message delivery
37326 &`->`&     additional address in same delivery
37327 &`>>`&     cutthrough message delivery
37328 &`*>`&     delivery suppressed by &%-N%&
37329 &`**`&     delivery failed; address bounced
37330 &`==`&     delivery deferred; temporary problem
37331 .endd
37332
37333
37334 .section "Logging message reception" "SECID251"
37335 .cindex "log" "reception line"
37336 The format of the single-line entry in the main log that is written for every
37337 message received is shown in the basic example below, which is split over
37338 several lines in order to fit it on the page:
37339 .code
37340 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37341   H=mailer.fict.example [192.168.123.123] U=exim
37342   P=smtp S=5678 id=<incoming message id>
37343 .endd
37344 The address immediately following &"<="& is the envelope sender address. A
37345 bounce message is shown with the sender address &"<>"&, and if it is locally
37346 generated, this is followed by an item of the form
37347 .code
37348 R=<message id>
37349 .endd
37350 which is a reference to the message that caused the bounce to be sent.
37351
37352 .cindex "HELO"
37353 .cindex "EHLO"
37354 For messages from other hosts, the H and U fields identify the remote host and
37355 record the RFC 1413 identity of the user that sent the message, if one was
37356 received. The number given in square brackets is the IP address of the sending
37357 host. If there is a single, unparenthesized  host name in the H field, as
37358 above, it has been verified to correspond to the IP address (see the
37359 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37360 by the remote host in the SMTP HELO or EHLO command, and has not been
37361 verified. If verification yields a different name to that given for HELO or
37362 EHLO, the verified name appears first, followed by the HELO or EHLO
37363 name in parentheses.
37364
37365 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37366 without brackets, in the HELO or EHLO command, leading to entries in
37367 the log containing text like these examples:
37368 .code
37369 H=(10.21.32.43) [192.168.8.34]
37370 H=([10.21.32.43]) [192.168.8.34]
37371 .endd
37372 This can be confusing. Only the final address in square brackets can be relied
37373 on.
37374
37375 For locally generated messages (that is, messages not received over TCP/IP),
37376 the H field is omitted, and the U field contains the login name of the caller
37377 of Exim.
37378
37379 .cindex "authentication" "logging"
37380 .cindex "AUTH" "logging"
37381 For all messages, the P field specifies the protocol used to receive the
37382 message. This is the value that is stored in &$received_protocol$&. In the case
37383 of incoming SMTP messages, the value indicates whether or not any SMTP
37384 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37385 session was encrypted, there is an additional X field that records the cipher
37386 suite that was used.
37387
37388 .cindex log protocol
37389 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37390 hosts that have authenticated themselves using the SMTP AUTH command. The first
37391 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37392 there is an additional item A= followed by the name of the authenticator that
37393 was used. If an authenticated identification was set up by the authenticator's
37394 &%server_set_id%& option, this is logged too, separated by a colon from the
37395 authenticator name.
37396
37397 .cindex "size" "of message"
37398 The id field records the existing message id, if present. The size of the
37399 received message is given by the S field. When the message is delivered,
37400 headers may be removed or added, so that the size of delivered copies of the
37401 message may not correspond with this value (and indeed may be different to each
37402 other).
37403
37404 The &%log_selector%& option can be used to request the logging of additional
37405 data when a message is received. See section &<<SECTlogselector>>& below.
37406
37407
37408
37409 .section "Logging deliveries" "SECID252"
37410 .cindex "log" "delivery line"
37411 The format of the single-line entry in the main log that is written for every
37412 delivery is shown in one of the examples below, for local and remote
37413 deliveries, respectively. Each example has been split into multiple lines in order
37414 to fit it on the page:
37415 .code
37416 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37417   <marv@hitch.fict.example> R=localuser T=local_delivery
37418 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37419   monk@holistic.fict.example R=dnslookup T=remote_smtp
37420   H=holistic.fict.example [192.168.234.234]
37421 .endd
37422 For ordinary local deliveries, the original address is given in angle brackets
37423 after the final delivery address, which might be a pipe or a file. If
37424 intermediate address(es) exist between the original and the final address, the
37425 last of these is given in parentheses after the final address. The R and T
37426 fields record the router and transport that were used to process the address.
37427
37428 If SMTP AUTH was used for the delivery there is an additional item A=
37429 followed by the name of the authenticator that was used.
37430 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37431 option, this is logged too, separated by a colon from the authenticator name.
37432
37433 If a shadow transport was run after a successful local delivery, the log line
37434 for the successful delivery has an item added on the end, of the form
37435 .display
37436 &`ST=<`&&'shadow transport name'&&`>`&
37437 .endd
37438 If the shadow transport did not succeed, the error message is put in
37439 parentheses afterwards.
37440
37441 .cindex "asterisk" "after IP address"
37442 When more than one address is included in a single delivery (for example, two
37443 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37444 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37445 down a single SMTP connection, an asterisk follows the IP address in the log
37446 lines for the second and subsequent messages.
37447 When two or more messages are delivered down a single TLS connection, the
37448 DNS and some TLS-related information logged for the first message delivered
37449 will not be present in the log lines for the second and subsequent messages.
37450 TLS cipher information is still available.
37451
37452 .cindex "delivery" "cutthrough; logging"
37453 .cindex "cutthrough" "logging"
37454 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37455 line precedes the reception line, since cutthrough waits for a possible
37456 rejection from the destination in case it can reject the sourced item.
37457
37458 The generation of a reply message by a filter file gets logged as a
37459 &"delivery"& to the addressee, preceded by &">"&.
37460
37461 The &%log_selector%& option can be used to request the logging of additional
37462 data when a message is delivered. See section &<<SECTlogselector>>& below.
37463
37464
37465 .section "Discarded deliveries" "SECID253"
37466 .cindex "discarded messages"
37467 .cindex "message" "discarded"
37468 .cindex "delivery" "discarded; logging"
37469 When a message is discarded as a result of the command &"seen finish"& being
37470 obeyed in a filter file which generates no deliveries, a log entry of the form
37471 .code
37472 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37473   <low.club@bridge.example> R=userforward
37474 .endd
37475 is written, to record why no deliveries are logged. When a message is discarded
37476 because it is aliased to &":blackhole:"& the log line is like this:
37477 .code
37478 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37479   <hole@nowhere.example> R=blackhole_router
37480 .endd
37481
37482
37483 .section "Deferred deliveries" "SECID254"
37484 When a delivery is deferred, a line of the following form is logged:
37485 .code
37486 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37487   R=dnslookup T=smtp defer (146): Connection refused
37488 .endd
37489 In the case of remote deliveries, the error is the one that was given for the
37490 last IP address that was tried. Details of individual SMTP failures are also
37491 written to the log, so the above line would be preceded by something like
37492 .code
37493 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37494   mail1.endrest.example [192.168.239.239]: Connection refused
37495 .endd
37496 When a deferred address is skipped because its retry time has not been reached,
37497 a message is written to the log, but this can be suppressed by setting an
37498 appropriate value in &%log_selector%&.
37499
37500
37501
37502 .section "Delivery failures" "SECID255"
37503 .cindex "delivery" "failure; logging"
37504 If a delivery fails because an address cannot be routed, a line of the
37505 following form is logged:
37506 .code
37507 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37508   <jim@trek99.example>: unknown mail domain
37509 .endd
37510 If a delivery fails at transport time, the router and transport are shown, and
37511 the response from the remote host is included, as in this example:
37512 .code
37513 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37514   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37515   after pipelined RCPT TO:<ace400@pb.example>: host
37516   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37517   <ace400@pb.example>...Addressee unknown
37518 .endd
37519 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37520 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37521 disabling PIPELINING. The log lines for all forms of delivery failure are
37522 flagged with &`**`&.
37523
37524
37525
37526 .section "Fake deliveries" "SECID256"
37527 .cindex "delivery" "fake; logging"
37528 If a delivery does not actually take place because the &%-N%& option has been
37529 used to suppress it, a normal delivery line is written to the log, except that
37530 &"=>"& is replaced by &"*>"&.
37531
37532
37533
37534 .section "Completion" "SECID257"
37535 A line of the form
37536 .code
37537 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37538 .endd
37539 is written to the main log when a message is about to be removed from the spool
37540 at the end of its processing.
37541
37542
37543
37544
37545 .section "Summary of Fields in Log Lines" "SECID258"
37546 .cindex "log" "summary of fields"
37547 A summary of the field identifiers that are used in log lines is shown in
37548 the following table:
37549 .display
37550 &`A   `&        authenticator name (and optional id and sender)
37551 &`C   `&        SMTP confirmation on delivery
37552 &`    `&        command list for &"no mail in SMTP session"&
37553 &`CV  `&        certificate verification status
37554 &`D   `&        duration of &"no mail in SMTP session"&
37555 &`DKIM`&        domain verified in incoming message
37556 &`DN  `&        distinguished name from peer certificate
37557 &`DS  `&        DNSSEC secured lookups
37558 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37559 &`F   `&        sender address (on delivery lines)
37560 &`H   `&        host name and IP address
37561 &`I   `&        local interface used
37562 &`id  `&        message id (from header) for incoming message
37563 &`K   `&        CHUNKING extension used
37564 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37565 &`M8S `&        8BITMIME status for incoming message
37566 &`P   `&        on &`<=`& lines: protocol used
37567 &`    `&        on &`=>`& and &`**`& lines: return path
37568 &`PRDR`&        PRDR extension used
37569 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37570 &`Q   `&        alternate queue name
37571 &`QT  `&        on &`=>`& lines: time spent on queue so far
37572 &`    `&        on &"Completed"& lines: time spent on queue
37573 &`R   `&        on &`<=`& lines: reference for local bounce
37574 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37575 &`RT  `&        on &`<=`& lines: time taken for reception
37576 &`S   `&        size of message in bytes
37577 &`SNI `&        server name indication from TLS client hello
37578 &`ST  `&        shadow transport name
37579 &`T   `&        on &`<=`& lines: message subject (topic)
37580 &`TFO `&        connection took advantage of TCP Fast Open
37581 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37582 &`U   `&        local user or RFC 1413 identity
37583 &`X   `&        TLS cipher suite
37584 .endd
37585
37586
37587 .section "Other log entries" "SECID259"
37588 Various other types of log entry are written from time to time. Most should be
37589 self-explanatory. Among the more common are:
37590
37591 .ilist
37592 .cindex "retry" "time not reached"
37593 &'retry time not reached'&&~&~An address previously suffered a temporary error
37594 during routing or local delivery, and the time to retry has not yet arrived.
37595 This message is not written to an individual message log file unless it happens
37596 during the first delivery attempt.
37597 .next
37598 &'retry time not reached for any host'&&~&~An address previously suffered
37599 temporary errors during remote delivery, and the retry time has not yet arrived
37600 for any of the hosts to which it is routed.
37601 .next
37602 .cindex "spool directory" "file locked"
37603 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37604 some other Exim process is already working on the message. This can be quite
37605 common if queue running processes are started at frequent intervals. The
37606 &'exiwhat'& utility script can be used to find out what Exim processes are
37607 doing.
37608 .next
37609 .cindex "error" "ignored"
37610 &'error ignored'&&~&~There are several circumstances that give rise to this
37611 message:
37612 .olist
37613 Exim failed to deliver a bounce message whose age was greater than
37614 &%ignore_bounce_errors_after%&. The bounce was discarded.
37615 .next
37616 A filter file set up a delivery using the &"noerror"& option, and the delivery
37617 failed. The delivery was discarded.
37618 .next
37619 A delivery set up by a router configured with
37620 . ==== As this is a nested list, any displays it contains must be indented
37621 . ==== as otherwise they are too far to the left.
37622 .code
37623     errors_to = <>
37624 .endd
37625 failed. The delivery was discarded.
37626 .endlist olist
37627 .next
37628 .cindex DKIM "log line"
37629 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37630 logging and the message has a DKIM signature header.
37631 .endlist ilist
37632
37633
37634
37635
37636
37637 .section "Reducing or increasing what is logged" "SECTlogselector"
37638 .cindex "log" "selectors"
37639 By setting the &%log_selector%& global option, you can disable some of Exim's
37640 default logging, or you can request additional logging. The value of
37641 &%log_selector%& is made up of names preceded by plus or minus characters. For
37642 example:
37643 .code
37644 log_selector = +arguments -retry_defer
37645 .endd
37646 The list of optional log items is in the following table, with the default
37647 selection marked by asterisks:
37648 .display
37649 &` 8bitmime                   `&  received 8BITMIME status
37650 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37651 &` address_rewrite            `&  address rewriting
37652 &` all_parents                `&  all parents in => lines
37653 &` arguments                  `&  command line arguments
37654 &`*connection_reject          `&  connection rejections
37655 &`*delay_delivery             `&  immediate delivery delayed
37656 &` deliver_time               `&  time taken to attempt delivery
37657 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37658 &`*dkim                       `&  DKIM verified domain on <= lines
37659 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37660 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37661 &` dnssec                     `&  DNSSEC secured lookups
37662 &`*etrn                       `&  ETRN commands
37663 &`*host_lookup_failed         `&  as it says
37664 &` ident_timeout              `&  timeout for ident connection
37665 &` incoming_interface         `&  local interface on <= and => lines
37666 &` incoming_port              `&  remote port on <= lines
37667 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37668 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37669 &`*msg_id                     `&  on <= lines, Message-ID: header value
37670 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37671 &` outgoing_interface         `&  local interface on => lines
37672 &` outgoing_port              `&  add remote port to => lines
37673 &`*queue_run                  `&  start and end queue runs
37674 &` queue_time                 `&  time on queue for one recipient
37675 &` queue_time_overall         `&  time on queue for whole message
37676 &` pid                        `&  Exim process id
37677 &` pipelining                 `&  PIPELINING use, on <= and => lines
37678 &` proxy                      `&  proxy address on <= and => lines
37679 &` receive_time               `&  time taken to receive message
37680 &` received_recipients        `&  recipients on <= lines
37681 &` received_sender            `&  sender on <= lines
37682 &`*rejected_header            `&  header contents on reject log
37683 &`*retry_defer                `&  &"retry time not reached"&
37684 &` return_path_on_delivery    `&  put return path on => and ** lines
37685 &` sender_on_delivery         `&  add sender to => lines
37686 &`*sender_verify_fail         `&  sender verification failures
37687 &`*size_reject                `&  rejection because too big
37688 &`*skip_delivery              `&  delivery skipped in a queue run
37689 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37690 &` smtp_connection            `&  incoming SMTP connections
37691 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37692 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37693 &` smtp_no_mail               `&  session with no MAIL commands
37694 &` smtp_protocol_error        `&  SMTP protocol errors
37695 &` smtp_syntax_error          `&  SMTP syntax errors
37696 &` subject                    `&  contents of &'Subject:'& on <= lines
37697 &`*tls_certificate_verified   `&  certificate verification status
37698 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37699 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37700 &` tls_sni                    `&  TLS SNI on <= lines
37701 &` unknown_in_list            `&  DNS lookup failed in list match
37702
37703 &` all                        `&  all of the above
37704 .endd
37705 See also the &%slow_lookup_log%& main configuration option,
37706 section &<<SECID99>>&
37707
37708 More details on each of these items follows:
37709
37710 .ilist
37711 .cindex "8BITMIME"
37712 .cindex "log" "8BITMIME"
37713 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37714 which may help in tracking down interoperability issues with ancient MTAs
37715 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37716 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37717 &`7BIT`& and &`8BITMIME`& respectively.
37718 .next
37719 .cindex "&%warn%& ACL verb" "log when skipping"
37720 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37721 its conditions cannot be evaluated, a log line to this effect is written if
37722 this log selector is set.
37723 .next
37724 .cindex "log" "rewriting"
37725 .cindex "rewriting" "logging"
37726 &%address_rewrite%&: This applies both to global rewrites and per-transport
37727 rewrites, but not to rewrites in filters run as an unprivileged user (because
37728 such users cannot access the log).
37729 .next
37730 .cindex "log" "full parentage"
37731 &%all_parents%&: Normally only the original and final addresses are logged on
37732 delivery lines; with this selector, intermediate parents are given in
37733 parentheses between them.
37734 .next
37735 .cindex "log" "Exim arguments"
37736 .cindex "Exim arguments, logging"
37737 &%arguments%&: This causes Exim to write the arguments with which it was called
37738 to the main log, preceded by the current working directory. This is a debugging
37739 feature, added to make it easier to find out how certain MUAs call
37740 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37741 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37742 that are empty or that contain white space are quoted. Non-printing characters
37743 are shown as escape sequences. This facility cannot log unrecognized arguments,
37744 because the arguments are checked before the configuration file is read. The
37745 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37746 between the caller and Exim.
37747 .next
37748 .cindex "log" "connection rejections"
37749 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37750 connection is rejected, for whatever reason.
37751 .next
37752 .cindex "log" "delayed delivery"
37753 .cindex "delayed delivery, logging"
37754 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37755 started for an incoming message because the load is too high or too many
37756 messages were received on one connection. Logging does not occur if no delivery
37757 process is started because &%queue_only%& is set or &%-odq%& was used.
37758 .next
37759 .cindex "log" "delivery duration"
37760 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37761 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37762 If millisecond logging is enabled, short times will be shown with greater
37763 precision, eg. &`DT=0.304s`&.
37764 .next
37765 .cindex "log" "message size on delivery"
37766 .cindex "size" "of message"
37767 &%delivery_size%&: For each delivery, the size of message delivered is added to
37768 the &"=>"& line, tagged with S=.
37769 .next
37770 .cindex log "DKIM verification"
37771 .cindex DKIM "verification logging"
37772 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37773 verifies successfully a tag of DKIM is added, with one of the verified domains.
37774 .next
37775 .cindex log "DKIM verification"
37776 .cindex DKIM "verification logging"
37777 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37778 .next
37779 .cindex "log" "dnslist defer"
37780 .cindex "DNS list" "logging defer"
37781 .cindex "black list (DNS)"
37782 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37783 DNS black list suffers a temporary error.
37784 .next
37785 .cindex log dnssec
37786 .cindex dnssec logging
37787 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37788 dns lookups gave secure results a tag of DS is added.
37789 For acceptance this covers the reverse and forward lookups for host name verification.
37790 It does not cover helo-name verification.
37791 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37792 .next
37793 .cindex "log" "ETRN commands"
37794 .cindex "ETRN" "logging"
37795 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37796 is run to determine whether or not it is actually accepted. An invalid ETRN
37797 command, or one received within a message transaction is not logged by this
37798 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37799 .next
37800 .cindex "log" "host lookup failure"
37801 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37802 any addresses, or when a lookup of an IP address fails to find a host name, a
37803 log line is written. This logging does not apply to direct DNS lookups when
37804 routing email addresses, but it does apply to &"byname"& lookups.
37805 .next
37806 .cindex "log" "ident timeout"
37807 .cindex "RFC 1413" "logging timeout"
37808 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37809 client's ident port times out.
37810 .next
37811 .cindex "log" "incoming interface"
37812 .cindex "log" "local interface"
37813 .cindex "log" "local address and port"
37814 .cindex "TCP/IP" "logging local address and port"
37815 .cindex "interface" "logging"
37816 &%incoming_interface%&: The interface on which a message was received is added
37817 to the &"<="& line as an IP address in square brackets, tagged by I= and
37818 followed by a colon and the port number. The local interface and port are also
37819 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37820 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37821 The latter can be disabled by turning off the &%outgoing_interface%& option.
37822 .next
37823 .cindex log "incoming proxy address"
37824 .cindex proxy "logging proxy address"
37825 .cindex "TCP/IP" "logging proxy address"
37826 &%proxy%&: The internal (closest to the system running Exim) IP address
37827 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37828 on a proxied connection
37829 or the &"=>"& line for a message delivered on a proxied connection.
37830 See &<<SECTproxyInbound>>& for more information.
37831 .next
37832 .cindex "log" "incoming remote port"
37833 .cindex "port" "logging remote"
37834 .cindex "TCP/IP" "logging incoming remote port"
37835 .vindex "&$sender_fullhost$&"
37836 .vindex "&$sender_rcvhost$&"
37837 &%incoming_port%&: The remote port number from which a message was received is
37838 added to log entries and &'Received:'& header lines, following the IP address
37839 in square brackets, and separated from it by a colon. This is implemented by
37840 changing the value that is put in the &$sender_fullhost$& and
37841 &$sender_rcvhost$& variables. Recording the remote port number has become more
37842 important with the widening use of NAT (see RFC 2505).
37843 .next
37844 .cindex "log" "dropped connection"
37845 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37846 connection is unexpectedly dropped.
37847 .next
37848 .cindex "log" "millisecond timestamps"
37849 .cindex millisecond logging
37850 .cindex timestamps "millisecond, in logs"
37851 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37852 appended to the seconds value.
37853 .next
37854 .cindex "log" "message id"
37855 &%msg_id%&: The value of the Message-ID: header.
37856 .next
37857 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37858 This will be either because the message is a bounce, or was submitted locally
37859 (submission mode) without one.
37860 The field identifier will have an asterix appended: &"id*="&.
37861 .next
37862 .cindex "log" "outgoing interface"
37863 .cindex "log" "local interface"
37864 .cindex "log" "local address and port"
37865 .cindex "TCP/IP" "logging local address and port"
37866 .cindex "interface" "logging"
37867 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37868 interface on which a message was sent is added to delivery lines as an I= tag
37869 followed by IP address in square brackets. You can disable this by turning
37870 off the &%outgoing_interface%& option.
37871 .next
37872 .cindex "log" "outgoing remote port"
37873 .cindex "port" "logging outgoing remote"
37874 .cindex "TCP/IP" "logging outgoing remote port"
37875 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37876 containing => tags) following the IP address.
37877 The local port is also added if &%incoming_interface%& and
37878 &%outgoing_interface%& are both enabled.
37879 This option is not included in the default setting, because for most ordinary
37880 configurations, the remote port number is always 25 (the SMTP port), and the
37881 local port is a random ephemeral port.
37882 .next
37883 .cindex "log" "process ids in"
37884 .cindex "pid (process id)" "in log lines"
37885 &%pid%&: The current process id is added to every log line, in square brackets,
37886 immediately after the time and date.
37887 .next
37888 .cindex log pipelining
37889 .cindex pipelining "logging outgoing"
37890 &%pipelining%&: A field is added to delivery and accept
37891 log lines when the ESMTP PIPELINING extension was used.
37892 The field is a single "L".
37893
37894 On accept lines, where PIPELINING was offered but not used by the client,
37895 the field has a minus appended.
37896
37897 .cindex "pipelining" "early connection"
37898 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37899 accept "L" fields have a period appended if the feature was
37900 offered but not used, or an asterisk appended if used.
37901 Delivery "L" fields have an asterisk appended if used.
37902
37903 .next
37904 .cindex "log" "queue run"
37905 .cindex "queue runner" "logging"
37906 &%queue_run%&: The start and end of every queue run are logged.
37907 .next
37908 .cindex "log" "queue time"
37909 &%queue_time%&: The amount of time the message has been in the queue on the
37910 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37911 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37912 includes reception time as well as the delivery time for the current address.
37913 This means that it may be longer than the difference between the arrival and
37914 delivery log line times, because the arrival log line is not written until the
37915 message has been successfully received.
37916 If millisecond logging is enabled, short times will be shown with greater
37917 precision, eg. &`QT=1.578s`&.
37918 .next
37919 &%queue_time_overall%&: The amount of time the message has been in the queue on
37920 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37921 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37922 message, so it includes reception time as well as the total delivery time.
37923 .next
37924 .cindex "log" "receive duration"
37925 &%receive_time%&: For each message, the amount of real time it has taken to
37926 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37927 If millisecond logging is enabled, short times will be shown with greater
37928 precision, eg. &`RT=0.204s`&.
37929 .next
37930 .cindex "log" "recipients"
37931 &%received_recipients%&: The recipients of a message are listed in the main log
37932 as soon as the message is received. The list appears at the end of the log line
37933 that is written when a message is received, preceded by the word &"for"&. The
37934 addresses are listed after they have been qualified, but before any rewriting
37935 has taken place.
37936 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37937 in the list.
37938 .next
37939 .cindex "log" "sender reception"
37940 &%received_sender%&: The unrewritten original sender of a message is added to
37941 the end of the log line that records the message's arrival, after the word
37942 &"from"& (before the recipients if &%received_recipients%& is also set).
37943 .next
37944 .cindex "log" "header lines for rejection"
37945 &%rejected_header%&: If a message's header has been received at the time a
37946 rejection is written to the reject log, the complete header is added to the
37947 log. Header logging can be turned off individually for messages that are
37948 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37949 .next
37950 .cindex "log" "retry defer"
37951 &%retry_defer%&: A log line is written if a delivery is deferred because a
37952 retry time has not yet been reached. However, this &"retry time not reached"&
37953 message is always omitted from individual message logs after the first delivery
37954 attempt.
37955 .next
37956 .cindex "log" "return path"
37957 &%return_path_on_delivery%&: The return path that is being transmitted with
37958 the message is included in delivery and bounce lines, using the tag P=.
37959 This is omitted if no delivery actually happens, for example, if routing fails,
37960 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37961 .next
37962 .cindex "log" "sender on delivery"
37963 &%sender_on_delivery%&: The message's sender address is added to every delivery
37964 and bounce line, tagged by F= (for &"from"&).
37965 This is the original sender that was received with the message; it is not
37966 necessarily the same as the outgoing return path.
37967 .next
37968 .cindex "log" "sender verify failure"
37969 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37970 gives details of a sender verification failure is not written. Log lines for
37971 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37972 detail is lost.
37973 .next
37974 .cindex "log" "size rejection"
37975 &%size_reject%&: A log line is written whenever a message is rejected because
37976 it is too big.
37977 .next
37978 .cindex "log" "frozen messages; skipped"
37979 .cindex "frozen messages" "logging skipping"
37980 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37981 queue run because it is frozen or because another process is already delivering
37982 it.
37983 .cindex "&""spool file is locked""&"
37984 The message that is written is &"spool file is locked"&.
37985 .next
37986 .cindex "log" "smtp confirmation"
37987 .cindex "SMTP" "logging confirmation"
37988 .cindex "LMTP" "logging confirmation"
37989 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37990 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37991 A number of MTAs (including Exim) return an identifying string in this
37992 response.
37993 .next
37994 .cindex "log" "SMTP connections"
37995 .cindex "SMTP" "logging connections"
37996 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37997 established or closed, unless the connection is from a host that matches
37998 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37999 only when the closure is unexpected.) This applies to connections from local
38000 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38001 dropped in the middle of a message, a log line is always written, whether or
38002 not this selector is set, but otherwise nothing is written at the start and end
38003 of connections unless this selector is enabled.
38004
38005 For TCP/IP connections to an Exim daemon, the current number of connections is
38006 included in the log message for each new connection, but note that the count is
38007 reset if the daemon is restarted.
38008 Also, because connections are closed (and the closure is logged) in
38009 subprocesses, the count may not include connections that have been closed but
38010 whose termination the daemon has not yet noticed. Thus, while it is possible to
38011 match up the opening and closing of connections in the log, the value of the
38012 logged counts may not be entirely accurate.
38013 .next
38014 .cindex "log" "SMTP transaction; incomplete"
38015 .cindex "SMTP" "logging incomplete transactions"
38016 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38017 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38018 and the message sender plus any accepted recipients are included in the log
38019 line. This can provide evidence of dictionary attacks.
38020 .next
38021 .cindex "log" "non-MAIL SMTP sessions"
38022 .cindex "MAIL" "logging session without"
38023 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38024 connection terminates without having issued a MAIL command. This includes both
38025 the case when the connection is dropped, and the case when QUIT is used. It
38026 does not include cases where the connection is rejected right at the start (by
38027 an ACL, or because there are too many connections, or whatever). These cases
38028 already have their own log lines.
38029
38030 The log line that is written contains the identity of the client in the usual
38031 way, followed by D= and a time, which records the duration of the connection.
38032 If the connection was authenticated, this fact is logged exactly as it is for
38033 an incoming message, with an A= item. If the connection was encrypted, CV=,
38034 DN=, and X= items may appear as they do for an incoming message, controlled by
38035 the same logging options.
38036
38037 Finally, if any SMTP commands were issued during the connection, a C= item
38038 is added to the line, listing the commands that were used. For example,
38039 .code
38040 C=EHLO,QUIT
38041 .endd
38042 shows that the client issued QUIT straight after EHLO. If there were fewer
38043 than 20 commands, they are all listed. If there were more than 20 commands,
38044 the last 20 are listed, preceded by &"..."&. However, with the default
38045 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38046 have been aborted before 20 non-mail commands are processed.
38047 .next
38048 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38049 colon-separated, is appended to the A= item for a message arrival or delivery
38050 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38051 was accepted or used.
38052 .next
38053 .cindex "log" "SMTP protocol error"
38054 .cindex "SMTP" "logging protocol error"
38055 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38056 encountered. Exim does not have perfect detection of all protocol errors
38057 because of transmission delays and the use of pipelining. If PIPELINING has
38058 been advertised to a client, an Exim server assumes that the client will use
38059 it, and therefore it does not count &"expected"& errors (for example, RCPT
38060 received after rejecting MAIL) as protocol errors.
38061 .next
38062 .cindex "SMTP" "logging syntax errors"
38063 .cindex "SMTP" "syntax errors; logging"
38064 .cindex "SMTP" "unknown command; logging"
38065 .cindex "log" "unknown SMTP command"
38066 .cindex "log" "SMTP syntax error"
38067 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38068 encountered. An unrecognized command is treated as a syntax error. For an
38069 external connection, the host identity is given; for an internal connection
38070 using &%-bs%& the sender identification (normally the calling user) is given.
38071 .next
38072 .cindex "log" "subject"
38073 .cindex "subject, logging"
38074 &%subject%&: The subject of the message is added to the arrival log line,
38075 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38076 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38077 specifies whether characters with values greater than 127 should be logged
38078 unchanged, or whether they should be rendered as escape sequences.
38079 .next
38080 .cindex "log" "certificate verification"
38081 .cindex log DANE
38082 .cindex DANE logging
38083 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38084 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38085 verified
38086 using a CA trust anchor,
38087 &`CA=dane`& if using a DNS trust anchor,
38088 and &`CV=no`& if not.
38089 .next
38090 .cindex "log" "TLS cipher"
38091 .cindex "TLS" "logging cipher"
38092 &%tls_cipher%&: When a message is sent or received over an encrypted
38093 connection, the cipher suite used is added to the log line, preceded by X=.
38094 .next
38095 .cindex "log" "TLS peer DN"
38096 .cindex "TLS" "logging peer DN"
38097 &%tls_peerdn%&: When a message is sent or received over an encrypted
38098 connection, and a certificate is supplied by the remote host, the peer DN is
38099 added to the log line, preceded by DN=.
38100 .next
38101 .cindex "log" "TLS SNI"
38102 .cindex "TLS" "logging SNI"
38103 &%tls_sni%&: When a message is received over an encrypted connection, and
38104 the remote host provided the Server Name Indication extension, the SNI is
38105 added to the log line, preceded by SNI=.
38106 .next
38107 .cindex "log" "DNS failure in list"
38108 &%unknown_in_list%&: This setting causes a log entry to be written when the
38109 result of a list match is failure because a DNS lookup failed.
38110 .endlist
38111
38112
38113 .section "Message log" "SECID260"
38114 .cindex "message" "log file for"
38115 .cindex "log" "message log; description of"
38116 .cindex "&_msglog_& directory"
38117 .oindex "&%preserve_message_logs%&"
38118 In addition to the general log files, Exim writes a log file for each message
38119 that it handles. The names of these per-message logs are the message ids, and
38120 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38121 message log contains copies of the log lines that apply to the message. This
38122 makes it easier to inspect the status of an individual message without having
38123 to search the main log. A message log is deleted when processing of the message
38124 is complete, unless &%preserve_message_logs%& is set, but this should be used
38125 only with great care because they can fill up your disk very quickly.
38126
38127 On a heavily loaded system, it may be desirable to disable the use of
38128 per-message logs, in order to reduce disk I/O. This can be done by setting the
38129 &%message_logs%& option false.
38130 .ecindex IIDloggen
38131
38132
38133
38134
38135 . ////////////////////////////////////////////////////////////////////////////
38136 . ////////////////////////////////////////////////////////////////////////////
38137
38138 .chapter "Exim utilities" "CHAPutils"
38139 .scindex IIDutils "utilities"
38140 A number of utility scripts and programs are supplied with Exim and are
38141 described in this chapter. There is also the Exim Monitor, which is covered in
38142 the next chapter. The utilities described here are:
38143
38144 .itable none 0 0 3  7* left  15* left  40* left
38145 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38146   "list what Exim processes are doing"
38147 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38148 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38149 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38150 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38151                                                 various criteria"
38152 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38153 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38154   "extract statistics from the log"
38155 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38156   "check address acceptance from given IP"
38157 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38158 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38159 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38160 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38161 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38162 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38163 .endtable
38164
38165 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38166 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38167 &url(https://duncanthrax.net/exilog/) for details.
38168
38169
38170
38171
38172 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38173 .cindex "&'exiwhat'&"
38174 .cindex "process, querying"
38175 .cindex "SIGUSR1"
38176 On operating systems that can restart a system call after receiving a signal
38177 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38178 a line describing what it is doing to the file &_exim-process.info_& in the
38179 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38180 processes it can find, having first emptied the file. It then waits for one
38181 second to allow the Exim processes to react before displaying the results. In
38182 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38183 send the signal to the Exim processes, so it is normally run as root.
38184
38185 &*Warning*&: This is not an efficient process. It is intended for occasional
38186 use by system administrators. It is not sensible, for example, to set up a
38187 script that sends SIGUSR1 signals to Exim processes at short intervals.
38188
38189
38190 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38191 varies in different operating systems. Not only are different options used,
38192 but the format of the output is different. For this reason, there are some
38193 system configuration options that configure exactly how &'exiwhat'& works. If
38194 it doesn't seem to be working for you, check the following compile-time
38195 options:
38196 .display
38197 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38198 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38199 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38200 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38201 .endd
38202 An example of typical output from &'exiwhat'& is
38203 .code
38204 164 daemon: -q1h, listening on port 25
38205 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38206 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38207   [10.19.42.42] (editor@ref.example)
38208 10592 handling incoming call from [192.168.243.242]
38209 10628 accepting a local non-SMTP message
38210 .endd
38211 The first number in the output line is the process number. The third line has
38212 been split here, in order to fit it on the page.
38213
38214
38215
38216 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38217 .cindex "&'exiqgrep'&"
38218 .cindex "queue" "grepping"
38219 This utility is a Perl script contributed by Matt Hubbard. It runs
38220 .code
38221 exim -bpu
38222 .endd
38223 or (in case &*-a*& switch is specified)
38224 .code
38225 exim -bp
38226 .endd
38227 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38228 contain alternate exim configuration the queue management might be using.
38229
38230 to obtain a queue listing, and then greps the output to select messages
38231 that match given criteria. The following selection options are available:
38232
38233 .vlist
38234 .vitem &*-f*&&~<&'regex'&>
38235 Match the sender address using a case-insensitive search. The field that is
38236 tested is enclosed in angle brackets, so you can test for bounce messages with
38237 .code
38238 exiqgrep -f '^<>$'
38239 .endd
38240 .vitem &*-r*&&~<&'regex'&>
38241 Match a recipient address using a case-insensitive search. The field that is
38242 tested is not enclosed in angle brackets.
38243
38244 .vitem &*-s*&&~<&'regex'&>
38245 Match against the size field.
38246
38247 .vitem &*-y*&&~<&'seconds'&>
38248 Match messages that are younger than the given time.
38249
38250 .vitem &*-o*&&~<&'seconds'&>
38251 Match messages that are older than the given time.
38252
38253 .vitem &*-z*&
38254 Match only frozen messages.
38255
38256 .vitem &*-x*&
38257 Match only non-frozen messages.
38258
38259 .vitem &*-G*&&~<&'queuename'&>
38260 Match only messages in the given queue.  Without this, the default queue is searched.
38261 .endlist
38262
38263 The following options control the format of the output:
38264
38265 .vlist
38266 .vitem &*-c*&
38267 Display only the count of matching messages.
38268
38269 .vitem &*-l*&
38270 Long format &-- display the full message information as output by Exim. This is
38271 the default.
38272
38273 .vitem &*-i*&
38274 Display message ids only.
38275
38276 .vitem &*-b*&
38277 Brief format &-- one line per message.
38278
38279 .vitem &*-R*&
38280 Display messages in reverse order.
38281
38282 .vitem &*-a*&
38283 Include delivered recipients in queue listing.
38284 .endlist
38285
38286 There is one more option, &%-h%&, which outputs a list of options.
38287
38288
38289
38290 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38291 .cindex "&'exiqsumm'&"
38292 .cindex "queue" "summary"
38293 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38294 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38295 running a command such as
38296 .code
38297 exim -bp | exiqsumm
38298 .endd
38299 The output consists of one line for each domain that has messages waiting for
38300 it, as in the following example:
38301 .code
38302 3   2322   74m   66m  msn.com.example
38303 .endd
38304 Each line lists the number of pending deliveries for a domain, their total
38305 volume, and the length of time that the oldest and the newest messages have
38306 been waiting. Note that the number of pending deliveries is greater than the
38307 number of messages when messages have more than one recipient.
38308
38309 A summary line is output at the end. By default the output is sorted on the
38310 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38311 the output to be sorted by oldest message and by count of messages,
38312 respectively. There are also three options that split the messages for each
38313 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38314 separates frozen messages, and &%-s%& separates messages according to their
38315 sender.
38316
38317 The output of &'exim -bp'& contains the original addresses in the message, so
38318 this also applies to the output from &'exiqsumm'&. No domains from addresses
38319 generated by aliasing or forwarding are included (unless the &%one_time%&
38320 option of the &(redirect)& router has been used to convert them into &"top
38321 level"& addresses).
38322
38323
38324
38325
38326 .section "Extracting specific information from the log (exigrep)" &&&
38327          "SECTextspeinf"
38328 .cindex "&'exigrep'&"
38329 .cindex "log" "extracts; grepping for"
38330 The &'exigrep'& utility is a Perl script that searches one or more main log
38331 files for entries that match a given pattern. When it finds a match, it
38332 extracts all the log entries for the relevant message, not just those that
38333 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38334 given message, or all mail for a given user, or for a given host, for example.
38335 The input files can be in Exim log format or syslog format.
38336 If a matching log line is not associated with a specific message, it is
38337 included in &'exigrep'&'s output without any additional lines. The usage is:
38338 .display
38339 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38340 .endd
38341 If no log filenames are given on the command line, the standard input is read.
38342
38343 The &%-t%& argument specifies a number of seconds. It adds an additional
38344 condition for message selection. Messages that are complete are shown only if
38345 they spent more than <&'n'&> seconds in the queue.
38346
38347 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38348 makes it case-sensitive. This may give a performance improvement when searching
38349 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38350 option; with &%-I%& they do not. In both cases it is possible to change the
38351 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38352
38353 The &%-l%& option means &"literal"&, that is, treat all characters in the
38354 pattern as standing for themselves. Otherwise the pattern must be a Perl
38355 regular expression.
38356
38357 The &%-v%& option inverts the matching condition. That is, a line is selected
38358 if it does &'not'& match the pattern.
38359
38360 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38361 that are generated as a result/response to a message that &'exigrep'& matched
38362 normally.
38363
38364 Example of &%-M%&:
38365 user_a sends a message to user_b, which generates a bounce back to user_b. If
38366 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38367 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38368 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38369 when searching for &"user_a"& will show both messages since the bounce is
38370 &"related"& to or a &"result"& of the first message that was found by the
38371 search term.
38372
38373 If the location of a &'zcat'& command is known from the definition of
38374 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38375 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38376 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38377 autodetection of some well known compression extensions.
38378
38379
38380 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38381 .cindex "&'exipick'&"
38382 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38383 lists messages from the queue according to a variety of criteria. For details
38384 of &'exipick'&'s facilities, run &'exipick'& with
38385 the &%--help%& option.
38386
38387
38388 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38389 .cindex "log" "cycling local files"
38390 .cindex "cycling logs"
38391 .cindex "&'exicyclog'&"
38392 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38393 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38394 you are using log files with datestamps in their names (see section
38395 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38396 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38397 There are two command line options for &'exicyclog'&:
38398 .ilist
38399 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38400 default that is set when Exim is built. The default default is 10.
38401 .next
38402 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38403 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38404 overriding the script's default, which is to find the setting from Exim's
38405 configuration.
38406 .endlist
38407
38408 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38409 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38410 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38411 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38412 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38413 logs are handled similarly.
38414
38415 If the limit is greater than 99, the script uses 3-digit numbers such as
38416 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38417 to one that is greater, or &'vice versa'&, you will have to fix the names of
38418 any existing log files.
38419
38420 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38421 the end are deleted. All files with numbers greater than 01 are compressed,
38422 using a compression command which is configured by the COMPRESS_COMMAND
38423 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38424 root &%crontab%& entry of the form
38425 .code
38426 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38427 .endd
38428 assuming you have used the name &"exim"& for the Exim user. You can run
38429 &'exicyclog'& as root if you wish, but there is no need.
38430
38431
38432
38433 .section "Mail statistics (eximstats)" "SECTmailstat"
38434 .cindex "statistics"
38435 .cindex "&'eximstats'&"
38436 A Perl script called &'eximstats'& is provided for extracting statistical
38437 information from log files. The output is either plain text, or HTML.
38438 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38439 . --- 404 error and everything else points to that.
38440
38441 The &'eximstats'& script has been hacked about quite a bit over time. The
38442 latest version is the result of some extensive revision by Steve Campbell. A
38443 lot of information is given by default, but there are options for suppressing
38444 various parts of it. Following any options, the arguments to the script are a
38445 list of files, which should be main log files. For example:
38446 .code
38447 eximstats -nr /var/spool/exim/log/mainlog.01
38448 .endd
38449 By default, &'eximstats'& extracts information about the number and volume of
38450 messages received from or delivered to various hosts. The information is sorted
38451 both by message count and by volume, and the top fifty hosts in each category
38452 are listed on the standard output. Similar information, based on email
38453 addresses or domains instead of hosts can be requested by means of various
38454 options. For messages delivered and received locally, similar statistics are
38455 also produced per user.
38456
38457 The output also includes total counts and statistics about delivery errors, and
38458 histograms showing the number of messages received and deliveries made in each
38459 hour of the day. A delivery with more than one address in its envelope (for
38460 example, an SMTP transaction with more than one RCPT command) is counted
38461 as a single delivery by &'eximstats'&.
38462
38463 Though normally more deliveries than receipts are reported (as messages may
38464 have multiple recipients), it is possible for &'eximstats'& to report more
38465 messages received than delivered, even though the queue is empty at the start
38466 and end of the period in question. If an incoming message contains no valid
38467 recipients, no deliveries are recorded for it. A bounce message is handled as
38468 an entirely separate message.
38469
38470 &'eximstats'& always outputs a grand total summary giving the volume and number
38471 of messages received and deliveries made, and the number of hosts involved in
38472 each case. It also outputs the number of messages that were delayed (that is,
38473 not completely delivered at the first attempt), and the number that had at
38474 least one address that failed.
38475
38476 The remainder of the output is in sections that can be independently disabled
38477 or modified by various options. It consists of a summary of deliveries by
38478 transport, histograms of messages received and delivered per time interval
38479 (default per hour), information about the time messages spent in the queue,
38480 a list of relayed messages, lists of the top fifty sending hosts, local
38481 senders, destination hosts, and destination local users by count and by volume,
38482 and a list of delivery errors that occurred.
38483
38484 The relay information lists messages that were actually relayed, that is, they
38485 came from a remote host and were directly delivered to some other remote host,
38486 without being processed (for example, for aliasing or forwarding) locally.
38487
38488 There are quite a few options for &'eximstats'& to control exactly what it
38489 outputs. These are documented in the Perl script itself, and can be extracted
38490 by running the command &(perldoc)& on the script. For example:
38491 .code
38492 perldoc /usr/exim/bin/eximstats
38493 .endd
38494
38495 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38496 .cindex "&'exim_checkaccess'&"
38497 .cindex "policy control" "checking access"
38498 .cindex "checking access"
38499 The &%-bh%& command line argument allows you to run a fake SMTP session with
38500 debugging output, in order to check what Exim is doing when it is applying
38501 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38502 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38503 sometimes you just want to answer the question &"Does this address have
38504 access?"& without bothering with any further details.
38505
38506 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38507 two arguments, an IP address and an email address:
38508 .code
38509 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38510 .endd
38511 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38512 given email address would be accepted in a RCPT command in a TCP/IP
38513 connection from the host with the given IP address. The output of the utility
38514 is either the word &"accepted"&, or the SMTP error response, for example:
38515 .code
38516 Rejected:
38517 550 Relay not permitted
38518 .endd
38519 When running this test, the utility uses &`<>`& as the envelope sender address
38520 for the MAIL command, but you can change this by providing additional
38521 options. These are passed directly to the Exim command. For example, to specify
38522 that the test is to be run with the sender address &'himself@there.example'&
38523 you can use:
38524 .code
38525 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38526                  -f himself@there.example
38527 .endd
38528 Note that these additional Exim command line items must be given after the two
38529 mandatory arguments.
38530
38531 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38532 while running its checks. You can run checks that include callouts by using
38533 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38534
38535
38536
38537 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38538 .cindex "DBM" "building dbm files"
38539 .cindex "building DBM files"
38540 .cindex "&'exim_dbmbuild'&"
38541 .cindex "lower casing"
38542 .cindex "binary zero" "in lookup key"
38543 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38544 the format used by the &(lsearch)& lookup (see section
38545 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38546 names as keys and the remainder of the information as data. The lower-casing
38547 can be prevented by calling the program with the &%-nolc%& option.
38548
38549 A terminating zero is included as part of the key string. This is expected by
38550 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38551 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38552 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38553 files.
38554
38555 The program requires two arguments: the name of the input file (which can be a
38556 single hyphen to indicate the standard input), and the name of the output file.
38557 It creates the output under a temporary name, and then renames it if all went
38558 well.
38559
38560 .cindex "USE_DB"
38561 If the native DB interface is in use (USE_DB is set in a compile-time
38562 configuration file &-- this is common in free versions of Unix) the two
38563 filenames must be different, because in this mode the Berkeley DB functions
38564 create a single output file using exactly the name given. For example,
38565 .code
38566 exim_dbmbuild /etc/aliases /etc/aliases.db
38567 .endd
38568 reads the system alias file and creates a DBM version of it in
38569 &_/etc/aliases.db_&.
38570
38571 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38572 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38573 environment, the suffixes are added to the second argument of
38574 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38575 when the Berkeley functions are used in compatibility mode (though this is not
38576 recommended), because in that case it adds a &_.db_& suffix to the filename.
38577
38578 If a duplicate key is encountered, the program outputs a warning, and when it
38579 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38580 option is used. By default, only the first of a set of duplicates is used &--
38581 this makes it compatible with &(lsearch)& lookups. There is an option
38582 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38583 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38584 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38585 return code is 2.
38586
38587
38588
38589
38590 .section "Finding individual retry times (exinext)" "SECTfinindret"
38591 .cindex "retry" "times"
38592 .cindex "&'exinext'&"
38593 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38594 fish specific information out of the retry database. Given a mail domain (or a
38595 complete address), it looks up the hosts for that domain, and outputs any retry
38596 information for the hosts or for the domain. At present, the retry information
38597 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38598 output. For example:
38599 .code
38600 $ exinext piglet@milne.fict.example
38601 kanga.milne.example:192.168.8.1 error 146: Connection refused
38602   first failed: 21-Feb-1996 14:57:34
38603   last tried:   21-Feb-1996 14:57:34
38604   next try at:  21-Feb-1996 15:02:34
38605 roo.milne.example:192.168.8.3 error 146: Connection refused
38606   first failed: 20-Jan-1996 13:12:08
38607   last tried:   21-Feb-1996 11:42:03
38608   next try at:  21-Feb-1996 19:42:03
38609   past final cutoff time
38610 .endd
38611 You can also give &'exinext'& a local part, without a domain, and it
38612 will give any retry information for that local part in your default domain.
38613 A message id can be used to obtain retry information pertaining to a specific
38614 message. This exists only when an attempt to deliver a message to a remote host
38615 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38616 &'exinext'& is not particularly efficient, but then it is not expected to be
38617 run very often.
38618
38619 The &'exinext'& utility calls Exim to find out information such as the location
38620 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38621 passed on to the &'exim'& commands. The first specifies an alternate Exim
38622 configuration file, and the second sets macros for use within the configuration
38623 file. These features are mainly to help in testing, but might also be useful in
38624 environments where more than one configuration file is in use.
38625
38626
38627
38628 .section "Hints database maintenance" "SECThindatmai"
38629 .cindex "hints database" "maintenance"
38630 .cindex "maintaining Exim's hints database"
38631 Three utility programs are provided for maintaining the DBM files that Exim
38632 uses to contain its delivery hint information. Each program requires two
38633 arguments. The first specifies the name of Exim's spool directory, and the
38634 second is the name of the database it is to operate on. These are as follows:
38635
38636 .ilist
38637 &'retry'&: the database of retry information
38638 .next
38639 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38640 for remote hosts
38641 .next
38642 &'callout'&: the callout cache
38643 .next
38644 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38645 .next
38646 &'misc'&: other hints data
38647 .endlist
38648
38649 The &'misc'& database is used for
38650
38651 .ilist
38652 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38653 .next
38654 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38655 &(smtp)& transport)
38656 .next
38657 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38658 in a transport)
38659 .endlist
38660
38661
38662
38663 .section "exim_dumpdb" "SECID261"
38664 .cindex "&'exim_dumpdb'&"
38665 The entire contents of a database are written to the standard output by the
38666 &'exim_dumpdb'& program, which has no options or arguments other than the
38667 spool and database names. For example, to dump the retry database:
38668 .code
38669 exim_dumpdb /var/spool/exim retry
38670 .endd
38671 Two lines of output are produced for each entry:
38672 .code
38673 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38674 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38675 .endd
38676 The first item on the first line is the key of the record. It starts with one
38677 of the letters R, or T, depending on whether it refers to a routing or
38678 transport retry. For a local delivery, the next part is the local address; for
38679 a remote delivery it is the name of the remote host, followed by its failing IP
38680 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38681 transport). If the remote port is not the standard one (port 25), it is added
38682 to the IP address. Then there follows an error code, an additional error code,
38683 and a textual description of the error.
38684
38685 The three times on the second line are the time of first failure, the time of
38686 the last delivery attempt, and the computed time for the next attempt. The line
38687 ends with an asterisk if the cutoff time for the last retry rule has been
38688 exceeded.
38689
38690 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38691 consists of a host name followed by a list of ids for messages that are or were
38692 waiting to be delivered to that host. If there are a very large number for any
38693 one host, continuation records, with a sequence number added to the host name,
38694 may be seen. The data in these records is often out of date, because a message
38695 may be routed to several alternative hosts, and Exim makes no effort to keep
38696 cross-references.
38697
38698
38699
38700 .section "exim_tidydb" "SECID262"
38701 .cindex "&'exim_tidydb'&"
38702 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38703 database. If run with no options, it removes all records that are more than 30
38704 days old. The age is calculated from the date and time that the record was last
38705 updated. Note that, in the case of the retry database, it is &'not'& the time
38706 since the first delivery failure. Information about a host that has been down
38707 for more than 30 days will remain in the database, provided that the record is
38708 updated sufficiently often.
38709
38710 The cutoff date can be altered by means of the &%-t%& option, which must be
38711 followed by a time. For example, to remove all records older than a week from
38712 the retry database:
38713 .code
38714 exim_tidydb -t 7d /var/spool/exim retry
38715 .endd
38716 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38717 message ids. In the former these appear as data in records keyed by host &--
38718 they were messages that were waiting for that host &-- and in the latter they
38719 are the keys for retry information for messages that have suffered certain
38720 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38721 message ids in database records are those of messages that are still on the
38722 queue. Message ids for messages that no longer exist are removed from
38723 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38724 For the &'retry'& database, records whose keys are non-existent message ids are
38725 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38726 whenever it removes information from the database.
38727
38728 Certain records are automatically removed by Exim when they are no longer
38729 needed, but others are not. For example, if all the MX hosts for a domain are
38730 down, a retry record is created for each one. If the primary MX host comes back
38731 first, its record is removed when Exim successfully delivers to it, but the
38732 records for the others remain because Exim has not tried to use those hosts.
38733
38734 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38735 hints databases. You should do this at a quiet time of day, because it requires
38736 a database to be locked (and therefore inaccessible to Exim) while it does its
38737 work. Removing records from a DBM file does not normally make the file smaller,
38738 but all the common DBM libraries are able to re-use the space that is released.
38739 After an initial phase of increasing in size, the databases normally reach a
38740 point at which they no longer get any bigger, as long as they are regularly
38741 tidied.
38742
38743 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38744 databases is likely to keep on increasing.
38745
38746
38747
38748
38749 .section "exim_fixdb" "SECID263"
38750 .cindex "&'exim_fixdb'&"
38751 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38752 Its main use is for testing Exim, but it might also be occasionally useful for
38753 getting round problems in a live system. It has no options, and its interface
38754 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38755 key of a database record can then be entered, and the data for that record is
38756 displayed.
38757
38758 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38759 except the &'retry'& database, that is the only operation that can be carried
38760 out. For the &'retry'& database, each field is output preceded by a number, and
38761 data for individual fields can be changed by typing the field number followed
38762 by new data, for example:
38763 .code
38764 > 4 951102:1000
38765 .endd
38766 resets the time of the next delivery attempt. Time values are given as a
38767 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38768 used as optional separators.
38769
38770
38771
38772
38773 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38774 .cindex "mailbox" "maintenance"
38775 .cindex "&'exim_lock'&"
38776 .cindex "locking mailboxes"
38777 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38778 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38779 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38780 a user agent while investigating a problem. The utility requires the name of
38781 the file as its first argument. If the locking is successful, the second
38782 argument is run as a command (using C's &[system()]& function); if there is no
38783 second argument, the value of the SHELL environment variable is used; if this
38784 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38785 is unlocked and the utility ends. The following options are available:
38786
38787 .vlist
38788 .vitem &%-fcntl%&
38789 Use &[fcntl()]& locking on the open mailbox.
38790
38791 .vitem &%-flock%&
38792 Use &[flock()]& locking on the open mailbox, provided the operating system
38793 supports it.
38794
38795 .vitem &%-interval%&
38796 This must be followed by a number, which is a number of seconds; it sets the
38797 interval to sleep between retries (default 3).
38798
38799 .vitem &%-lockfile%&
38800 Create a lock file before opening the mailbox.
38801
38802 .vitem &%-mbx%&
38803 Lock the mailbox using MBX rules.
38804
38805 .vitem &%-q%&
38806 Suppress verification output.
38807
38808 .vitem &%-retries%&
38809 This must be followed by a number; it sets the number of times to try to get
38810 the lock (default 10).
38811
38812 .vitem &%-restore_time%&
38813 This option causes &%exim_lock%& to restore the modified and read times to the
38814 locked file before exiting. This allows you to access a locked mailbox (for
38815 example, to take a backup copy) without disturbing the times that the user
38816 subsequently sees.
38817
38818 .vitem &%-timeout%&
38819 This must be followed by a number, which is a number of seconds; it sets a
38820 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38821 default), a non-blocking call is used.
38822
38823 .vitem &%-v%&
38824 Generate verbose output.
38825 .endlist
38826
38827 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38828 default is to create a lock file and also to use &[fcntl()]& locking on the
38829 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38830 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38831 requires that the directory containing the file be writeable. Locking by lock
38832 file does not last forever; Exim assumes that a lock file is expired if it is
38833 more than 30 minutes old.
38834
38835 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38836 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38837 to be taken out on the open mailbox, and an exclusive lock on the file
38838 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38839 number of the mailbox file. When the locking is released, if an exclusive lock
38840 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38841
38842 The default output contains verification of the locking that takes place. The
38843 &%-v%& option causes some additional information to be given. The &%-q%& option
38844 suppresses all output except error messages.
38845
38846 A command such as
38847 .code
38848 exim_lock /var/spool/mail/spqr
38849 .endd
38850 runs an interactive shell while the file is locked, whereas
38851 .display
38852 &`exim_lock -q /var/spool/mail/spqr <<End`&
38853 <&'some commands'&>
38854 &`End`&
38855 .endd
38856 runs a specific non-interactive sequence of commands while the file is locked,
38857 suppressing all verification output. A single command can be run by a command
38858 such as
38859 .code
38860 exim_lock -q /var/spool/mail/spqr \
38861   "cp /var/spool/mail/spqr /some/where"
38862 .endd
38863 Note that if a command is supplied, it must be entirely contained within the
38864 second argument &-- hence the quotes.
38865 .ecindex IIDutils
38866
38867
38868 . ////////////////////////////////////////////////////////////////////////////
38869 . ////////////////////////////////////////////////////////////////////////////
38870
38871 .chapter "The Exim monitor" "CHAPeximon"
38872 .scindex IIDeximon "Exim monitor" "description"
38873 .cindex "X-windows"
38874 .cindex "&'eximon'&"
38875 .cindex "Local/eximon.conf"
38876 .cindex "&_exim_monitor/EDITME_&"
38877 The Exim monitor is an application which displays in an X window information
38878 about the state of Exim's queue and what Exim is doing. An admin user can
38879 perform certain operations on messages from this GUI interface; however all
38880 such facilities are also available from the command line, and indeed, the
38881 monitor itself makes use of the command line to perform any actions requested.
38882
38883
38884
38885 .section "Running the monitor" "SECID264"
38886 The monitor is started by running the script called &'eximon'&. This is a shell
38887 script that sets up a number of environment variables, and then runs the
38888 binary called &_eximon.bin_&. The default appearance of the monitor window can
38889 be changed by editing the &_Local/eximon.conf_& file created by editing
38890 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38891 parameters are for.
38892
38893 The parameters that get built into the &'eximon'& script can be overridden for
38894 a particular invocation by setting up environment variables of the same names,
38895 preceded by &`EXIMON_`&. For example, a shell command such as
38896 .code
38897 EXIMON_LOG_DEPTH=400 eximon
38898 .endd
38899 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38900 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38901 overrides the Exim log file configuration. This makes it possible to have
38902 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38903 syslog messages are routed to a file on the local host.
38904
38905 X resources can be used to change the appearance of the window in the normal
38906 way. For example, a resource setting of the form
38907 .code
38908 Eximon*background: gray94
38909 .endd
38910 changes the colour of the background to light grey rather than white. The
38911 stripcharts are drawn with both the data lines and the reference lines in
38912 black. This means that the reference lines are not visible when on top of the
38913 data. However, their colour can be changed by setting a resource called
38914 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38915 For example, if your X server is running Unix, you could set up lighter
38916 reference lines in the stripcharts by obeying
38917 .code
38918 xrdb -merge <<End
38919 Eximon*highlight: gray
38920 End
38921 .endd
38922 .cindex "admin user"
38923 In order to see the contents of messages in the queue, and to operate on them,
38924 &'eximon'& must either be run as root or by an admin user.
38925
38926 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38927 contain X11 resource parameters interpreted by the X11 library.  In addition,
38928 if the first parameter starts with the string "gdb" then it is removed and the
38929 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38930 versioned variants of gdb can be invoked).
38931
38932 The monitor's window is divided into three parts. The first contains one or
38933 more stripcharts and two action buttons, the second contains a &"tail"& of the
38934 main log file, and the third is a display of the queue of messages awaiting
38935 delivery, with two more action buttons. The following sections describe these
38936 different parts of the display.
38937
38938
38939
38940
38941 .section "The stripcharts" "SECID265"
38942 .cindex "stripchart"
38943 The first stripchart is always a count of messages in the queue. Its name can
38944 be configured by setting QUEUE_STRIPCHART_NAME in the
38945 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38946 configuration script by regular expression matches on log file entries, making
38947 it possible to display, for example, counts of messages delivered to certain
38948 hosts or using certain transports. The supplied defaults display counts of
38949 received and delivered messages, and of local and SMTP deliveries. The default
38950 period between stripchart updates is one minute; this can be adjusted by a
38951 parameter in the &_Local/eximon.conf_& file.
38952
38953 The stripchart displays rescale themselves automatically as the value they are
38954 displaying changes. There are always 10 horizontal lines in each chart; the
38955 title string indicates the value of each division when it is greater than one.
38956 For example, &"x2"& means that each division represents a value of 2.
38957
38958 It is also possible to have a stripchart which shows the percentage fullness of
38959 a particular disk partition, which is useful when local deliveries are confined
38960 to a single partition.
38961
38962 .cindex "&%statvfs%& function"
38963 This relies on the availability of the &[statvfs()]& function or equivalent in
38964 the operating system. Most, but not all versions of Unix that support Exim have
38965 this. For this particular stripchart, the top of the chart always represents
38966 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38967 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38968 &_Local/eximon.conf_& file.
38969
38970
38971
38972
38973 .section "Main action buttons" "SECID266"
38974 .cindex "size" "of monitor window"
38975 .cindex "Exim monitor" "window size"
38976 .cindex "window size"
38977 Below the stripcharts there is an action button for quitting the monitor. Next
38978 to this is another button marked &"Size"&. They are placed here so that
38979 shrinking the window to its default minimum size leaves just the queue count
38980 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38981 the window to expand to its maximum size, unless it is already at the maximum,
38982 in which case it is reduced to its minimum.
38983
38984 When expanding to the maximum, if the window cannot be fully seen where it
38985 currently is, it is moved back to where it was the last time it was at full
38986 size. When it is expanding from its minimum size, the old position is
38987 remembered, and next time it is reduced to the minimum it is moved back there.
38988
38989 The idea is that you can keep a reduced window just showing one or two
38990 stripcharts at a convenient place on your screen, easily expand it to show
38991 the full window when required, and just as easily put it back to what it was.
38992 The idea is copied from what the &'twm'& window manager does for its
38993 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38994 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38995
38996 Normally, the monitor starts up with the window at its full size, but it can be
38997 built so that it starts up with the window at its smallest size, by setting
38998 START_SMALL=yes in &_Local/eximon.conf_&.
38999
39000
39001
39002 .section "The log display" "SECID267"
39003 .cindex "log" "tail of; in monitor"
39004 The second section of the window is an area in which a display of the tail of
39005 the main log is maintained.
39006 To save space on the screen, the timestamp on each log line is shortened by
39007 removing the date and, if &%log_timezone%& is set, the timezone.
39008 The log tail is not available when the only destination for logging data is
39009 syslog, unless the syslog lines are routed to a local file whose name is passed
39010 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39011
39012 The log sub-window has a scroll bar at its lefthand side which can be used to
39013 move back to look at earlier text, and the up and down arrow keys also have a
39014 scrolling effect. The amount of log that is kept depends on the setting of
39015 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39016 to use. When this is full, the earlier 50% of data is discarded &-- this is
39017 much more efficient than throwing it away line by line. The sub-window also has
39018 a horizontal scroll bar for accessing the ends of long log lines. This is the
39019 only means of horizontal scrolling; the right and left arrow keys are not
39020 available. Text can be cut from this part of the window using the mouse in the
39021 normal way. The size of this subwindow is controlled by parameters in the
39022 configuration file &_Local/eximon.conf_&.
39023
39024 Searches of the text in the log window can be carried out by means of the ^R
39025 and ^S keystrokes, which default to a reverse and a forward search,
39026 respectively. The search covers only the text that is displayed in the window.
39027 It cannot go further back up the log.
39028
39029 The point from which the search starts is indicated by a caret marker. This is
39030 normally at the end of the text in the window, but can be positioned explicitly
39031 by pointing and clicking with the left mouse button, and is moved automatically
39032 by a successful search. If new text arrives in the window when it is scrolled
39033 back, the caret remains where it is, but if the window is not scrolled back,
39034 the caret is moved to the end of the new text.
39035
39036 Pressing ^R or ^S pops up a window into which the search text can be typed.
39037 There are buttons for selecting forward or reverse searching, for carrying out
39038 the search, and for cancelling. If the &"Search"& button is pressed, the search
39039 happens and the window remains so that further searches can be done. If the
39040 &"Return"& key is pressed, a single search is done and the window is closed. If
39041 ^C is typed the search is cancelled.
39042
39043 The searching facility is implemented using the facilities of the Athena text
39044 widget. By default this pops up a window containing both &"search"& and
39045 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39046 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39047 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39048 provided version of &%TextPop%& when the remaining parts of the text widget
39049 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39050 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39051 on these systems, at the expense of having unwanted items in the search popup
39052 window.
39053
39054
39055
39056 .section "The queue display" "SECID268"
39057 .cindex "queue" "display in monitor"
39058 The bottom section of the monitor window contains a list of all messages that
39059 are in the queue, which includes those currently being received or delivered,
39060 as well as those awaiting delivery. The size of this subwindow is controlled by
39061 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39062 at which it is updated is controlled by another parameter in the same file &--
39063 the default is 5 minutes, since queue scans can be quite expensive. However,
39064 there is an &"Update"& action button just above the display which can be used
39065 to force an update of the queue display at any time.
39066
39067 When a host is down for some time, a lot of pending mail can build up for it,
39068 and this can make it hard to deal with other messages in the queue. To help
39069 with this situation there is a button next to &"Update"& called &"Hide"&. If
39070 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39071 type anything in here and press &"Return"&, the text is added to a chain of
39072 such texts, and if every undelivered address in a message matches at least one
39073 of the texts, the message is not displayed.
39074
39075 If there is an address that does not match any of the texts, all the addresses
39076 are displayed as normal. The matching happens on the ends of addresses so, for
39077 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39078 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39079 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39080 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39081 a hide request is automatically cancelled after one hour.
39082
39083 While the dialogue box is displayed, you can't press any buttons or do anything
39084 else to the monitor window. For this reason, if you want to cut text from the
39085 queue display to use in the dialogue box, you have to do the cutting before
39086 pressing the &"Hide"& button.
39087
39088 The queue display contains, for each unhidden queued message, the length of
39089 time it has been in the queue, the size of the message, the message id, the
39090 message sender, and the first undelivered recipient, all on one line. If it is
39091 a bounce message, the sender is shown as &"<>"&. If there is more than one
39092 recipient to which the message has not yet been delivered, subsequent ones are
39093 listed on additional lines, up to a maximum configured number, following which
39094 an ellipsis is displayed. Recipients that have already received the message are
39095 not shown.
39096
39097 .cindex "frozen messages" "display"
39098 If a message is frozen, an asterisk is displayed at the left-hand side.
39099
39100 The queue display has a vertical scroll bar, and can also be scrolled by means
39101 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39102 The text searching facilities, as described above for the log window, are also
39103 available, but the caret is always moved to the end of the text when the queue
39104 display is updated.
39105
39106
39107
39108 .section "The queue menu" "SECID269"
39109 .cindex "queue" "menu in monitor"
39110 If the &%shift%& key is held down and the left button is clicked when the mouse
39111 pointer is over the text for any message, an action menu pops up, and the first
39112 line of the queue display for the message is highlighted. This does not affect
39113 any selected text.
39114
39115 If you want to use some other event for popping up the menu, you can set the
39116 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39117 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39118 value set in this parameter is a standard X event description. For example, to
39119 run eximon using &%ctrl%& rather than &%shift%& you could use
39120 .code
39121 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39122 .endd
39123 The title of the menu is the message id, and it contains entries which act as
39124 follows:
39125
39126 .ilist
39127 &'message log'&: The contents of the message log for the message are displayed
39128 in a new text window.
39129 .next
39130 &'headers'&: Information from the spool file that contains the envelope
39131 information and headers is displayed in a new text window. See chapter
39132 &<<CHAPspool>>& for a description of the format of spool files.
39133 .next
39134 &'body'&: The contents of the spool file containing the body of the message are
39135 displayed in a new text window. There is a default limit of 20,000 bytes to the
39136 amount of data displayed. This can be changed by setting the BODY_MAX
39137 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39138 .next
39139 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39140 delivery of the message. This causes an automatic thaw if the message is
39141 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39142 a new text window. The delivery is run in a separate process, to avoid holding
39143 up the monitor while the delivery proceeds.
39144 .next
39145 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39146 that the message be frozen.
39147 .next
39148 .cindex "thawing messages"
39149 .cindex "unfreezing messages"
39150 .cindex "frozen messages" "thawing"
39151 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39152 that the message be thawed.
39153 .next
39154 .cindex "delivery" "forcing failure"
39155 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39156 that Exim gives up trying to deliver the message. A bounce message is generated
39157 for any remaining undelivered addresses.
39158 .next
39159 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39160 that the message be deleted from the system without generating a bounce
39161 message.
39162 .next
39163 &'add recipient'&: A dialog box is displayed into which a recipient address can
39164 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39165 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39166 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39167 causes a call to Exim to be made using the &%-Mar%& option to request that an
39168 additional recipient be added to the message, unless the entry box is empty, in
39169 which case no action is taken.
39170 .next
39171 &'mark delivered'&: A dialog box is displayed into which a recipient address
39172 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39173 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39174 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39175 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39176 recipient address as already delivered, unless the entry box is empty, in which
39177 case no action is taken.
39178 .next
39179 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39180 mark all recipient addresses as already delivered.
39181 .next
39182 &'edit sender'&: A dialog box is displayed initialized with the current
39183 sender's address. Pressing RETURN causes a call to Exim to be made using the
39184 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39185 in which case no action is taken. If you want to set an empty sender (as in
39186 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39187 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39188 the address is qualified with that domain.
39189 .endlist
39190
39191 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39192 other cases when a call to Exim is made, if there is any output from Exim (in
39193 particular, if the command fails) a window containing the command and the
39194 output is displayed. Otherwise, the results of the action are normally apparent
39195 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39196 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39197 if no output is generated.
39198
39199 The queue display is automatically updated for actions such as freezing and
39200 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39201 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39202 force an update of the display after one of these actions.
39203
39204 In any text window that is displayed as result of a menu action, the normal
39205 cut-and-paste facility is available, and searching can be carried out using ^R
39206 and ^S, as described above for the log tail window.
39207 .ecindex IIDeximon
39208
39209
39210
39211
39212
39213 . ////////////////////////////////////////////////////////////////////////////
39214 . ////////////////////////////////////////////////////////////////////////////
39215
39216 .chapter "Security considerations" "CHAPsecurity"
39217 .scindex IIDsecurcon "security" "discussion of"
39218 This chapter discusses a number of issues concerned with security, some of
39219 which are also covered in other parts of this manual.
39220
39221 For reasons that this author does not understand, some people have promoted
39222 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39223 existence of this chapter in the documentation. However, the intent of the
39224 chapter is simply to describe the way Exim works in relation to certain
39225 security concerns, not to make any specific claims about the effectiveness of
39226 its security as compared with other MTAs.
39227
39228 What follows is a description of the way Exim is supposed to be. Best efforts
39229 have been made to try to ensure that the code agrees with the theory, but an
39230 absence of bugs can never be guaranteed. Any that are reported will get fixed
39231 as soon as possible.
39232
39233
39234 .section "Building a more &""hardened""& Exim" "SECID286"
39235 .cindex "security" "build-time features"
39236 There are a number of build-time options that can be set in &_Local/Makefile_&
39237 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39238 Exim administrator who does not have the root password, or by someone who has
39239 penetrated the Exim (but not the root) account. These options are as follows:
39240
39241 .ilist
39242 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39243 start of any filenames used with the &%-C%& option. When it is set, these
39244 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39245 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39246 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39247 default setting for &%ALT_CONFIG_PREFIX%&.
39248
39249 If the permitted configuration files are confined to a directory to
39250 which only root has access, this guards against someone who has broken
39251 into the Exim account from running a privileged Exim with an arbitrary
39252 configuration file, and using it to break into other accounts.
39253 .next
39254
39255 If a non-trusted configuration file (i.e. not the default configuration file
39256 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39257 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39258 the next item), then root privilege is retained only if the caller of Exim is
39259 root. This locks out the possibility of testing a configuration using &%-C%&
39260 right through message reception and delivery, even if the caller is root. The
39261 reception works, but by that time, Exim is running as the Exim user, so when
39262 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39263 privilege to be lost. However, root can test reception and delivery using two
39264 separate commands.
39265
39266 .next
39267 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39268 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39269 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39270 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39271 the restrictive side.  Requiring build-time selection of safe macros is onerous
39272 but this option is intended solely as a transition mechanism to permit
39273 previously-working configurations to continue to work after release 4.73.
39274 .next
39275 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39276 is disabled.
39277 .next
39278 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39279 never to be used for any deliveries. This is like the &%never_users%& runtime
39280 option, but it cannot be overridden; the runtime option adds additional users
39281 to the list. The default setting is &"root"&; this prevents a non-root user who
39282 is permitted to modify the runtime file from using Exim as a way to get root.
39283 .endlist
39284
39285
39286
39287 .section "Root privilege" "SECID270"
39288 .cindex "setuid"
39289 .cindex "root privilege"
39290 The Exim binary is normally setuid to root, which means that it gains root
39291 privilege (runs as root) when it starts execution. In some special cases (for
39292 example, when the daemon is not in use and there are no local deliveries), it
39293 may be possible to run Exim setuid to some user other than root. This is
39294 discussed in the next section. However, in most installations, root privilege
39295 is required for two things:
39296
39297 .ilist
39298 To set up a socket connected to the standard SMTP port (25) when initialising
39299 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39300 not required.
39301 .next
39302 To be able to change uid and gid in order to read users' &_.forward_& files and
39303 perform local deliveries as the receiving user or as specified in the
39304 configuration.
39305 .endlist
39306
39307 It is not necessary to be root to do any of the other things Exim does, such as
39308 receiving messages and delivering them externally over SMTP, and it is
39309 obviously more secure if Exim does not run as root except when necessary.
39310 For this reason, a user and group for Exim to use must be defined in
39311 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39312 group"&. Their values can be changed by the runtime configuration, though this
39313 is not recommended. Often a user called &'exim'& is used, but some sites use
39314 &'mail'& or another user name altogether.
39315
39316 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39317 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39318 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39319
39320 After a new Exim process has interpreted its command line options, it changes
39321 uid and gid in the following cases:
39322
39323 .ilist
39324 .oindex "&%-C%&"
39325 .oindex "&%-D%&"
39326 If the &%-C%& option is used to specify an alternate configuration file, or if
39327 the &%-D%& option is used to define macro values for the configuration, and the
39328 calling process is not running as root, the uid and gid are changed to those of
39329 the calling process.
39330 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39331 option may not be used at all.
39332 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39333 can be supplied if the calling process is running as root, the Exim run-time
39334 user or CONFIGURE_OWNER, if defined.
39335 .next
39336 .oindex "&%-be%&"
39337 .oindex "&%-bf%&"
39338 .oindex "&%-bF%&"
39339 If the expansion test option (&%-be%&) or one of the filter testing options
39340 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39341 calling process.
39342 .next
39343 If the process is not a daemon process or a queue runner process or a delivery
39344 process or a process for testing address routing (started with &%-bt%&), the
39345 uid and gid are changed to the Exim user and group. This means that Exim always
39346 runs under its own uid and gid when receiving messages. This also applies when
39347 testing address verification
39348 .oindex "&%-bv%&"
39349 .oindex "&%-bh%&"
39350 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39351 option).
39352 .next
39353 For a daemon, queue runner, delivery, or address testing process, the uid
39354 remains as root at this stage, but the gid is changed to the Exim group.
39355 .endlist
39356
39357 The processes that initially retain root privilege behave as follows:
39358
39359 .ilist
39360 A daemon process changes the gid to the Exim group and the uid to the Exim
39361 user after setting up one or more listening sockets. The &[initgroups()]&
39362 function is called, so that if the Exim user is in any additional groups, they
39363 will be used during message reception.
39364 .next
39365 A queue runner process retains root privilege throughout its execution. Its
39366 job is to fork a controlled sequence of delivery processes.
39367 .next
39368 A delivery process retains root privilege throughout most of its execution,
39369 but any actual deliveries (that is, the transports themselves) are run in
39370 subprocesses which always change to a non-root uid and gid. For local
39371 deliveries this is typically the uid and gid of the owner of the mailbox; for
39372 remote deliveries, the Exim uid and gid are used. Once all the delivery
39373 subprocesses have been run, a delivery process changes to the Exim uid and gid
39374 while doing post-delivery tidying up such as updating the retry database and
39375 generating bounce and warning messages.
39376
39377 While the recipient addresses in a message are being routed, the delivery
39378 process runs as root. However, if a user's filter file has to be processed,
39379 this is done in a subprocess that runs under the individual user's uid and
39380 gid. A system filter is run as root unless &%system_filter_user%& is set.
39381 .next
39382 A process that is testing addresses (the &%-bt%& option) runs as root so that
39383 the routing is done in the same environment as a message delivery.
39384 .endlist
39385
39386
39387
39388
39389 .section "Running Exim without privilege" "SECTrunexiwitpri"
39390 .cindex "privilege, running without"
39391 .cindex "unprivileged running"
39392 .cindex "root privilege" "running without"
39393 Some installations like to run Exim in an unprivileged state for more of its
39394 operation, for added security. Support for this mode of operation is provided
39395 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39396 gid are changed to the Exim user and group at the start of a delivery process
39397 (and also queue runner and address testing processes). This means that address
39398 routing is no longer run as root, and the deliveries themselves cannot change
39399 to any other uid.
39400
39401 .cindex SIGHUP
39402 .cindex "daemon" "restarting"
39403 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39404 that the daemon can still be started in the usual way, and it can respond
39405 correctly to SIGHUP because the re-invocation regains root privilege.
39406
39407 An alternative approach is to make Exim setuid to the Exim user and also setgid
39408 to the Exim group. If you do this, the daemon must be started from a root
39409 process. (Calling Exim from a root process makes it behave in the way it does
39410 when it is setuid root.) However, the daemon cannot restart itself after a
39411 SIGHUP signal because it cannot regain privilege.
39412
39413 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39414 stops Exim from trying to re-invoke itself to do a delivery after a message has
39415 been received. Such a re-invocation is a waste of resources because it has no
39416 effect.
39417
39418 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39419 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39420 to the Exim user seems a clean approach, but there is one complication:
39421
39422 In this style of operation, Exim is running with the real uid and gid set to
39423 those of the calling process, and the effective uid/gid set to Exim's values.
39424 Ideally, any association with the calling process' uid/gid should be dropped,
39425 that is, the real uid/gid should be reset to the effective values so as to
39426 discard any privileges that the caller may have. While some operating systems
39427 have a function that permits this action for a non-root effective uid, quite a
39428 number of them do not. Because of this lack of standardization, Exim does not
39429 address this problem at this time.
39430
39431 For this reason, the recommended approach for &"mostly unprivileged"& running
39432 is to keep the Exim binary setuid to root, and to set
39433 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39434 be used in the most straightforward way.
39435
39436 If you configure Exim not to run delivery processes as root, there are a
39437 number of restrictions on what you can do:
39438
39439 .ilist
39440 You can deliver only as the Exim user/group. You should  explicitly use the
39441 &%user%& and &%group%& options to override routers or local transports that
39442 normally deliver as the recipient. This makes sure that configurations that
39443 work in this mode function the same way in normal mode. Any implicit or
39444 explicit specification of another user causes an error.
39445 .next
39446 Use of &_.forward_& files is severely restricted, such that it is usually
39447 not worthwhile to include them in the configuration.
39448 .next
39449 Users who wish to use &_.forward_& would have to make their home directory and
39450 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39451 and their equivalents in Exim filters, cannot be used. While they could be
39452 enabled in the Exim user's name, that would be insecure and not very useful.
39453 .next
39454 Unless the local user mailboxes are all owned by the Exim user (possible in
39455 some POP3 or IMAP-only environments):
39456
39457 .olist
39458 They must be owned by the Exim group and be writeable by that group. This
39459 implies you must set &%mode%& in the appendfile configuration, as well as the
39460 mode of the mailbox files themselves.
39461 .next
39462 You must set &%no_check_owner%&, since most or all of the files will not be
39463 owned by the Exim user.
39464 .next
39465 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39466 on a newly created mailbox when unprivileged. This also implies that new
39467 mailboxes need to be created manually.
39468 .endlist olist
39469 .endlist ilist
39470
39471
39472 These restrictions severely restrict what can be done in local deliveries.
39473 However, there are no restrictions on remote deliveries. If you are running a
39474 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39475 gives more security at essentially no cost.
39476
39477 If you are using the &%mua_wrapper%& facility (see chapter
39478 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39479
39480
39481
39482
39483 .section "Delivering to local files" "SECID271"
39484 Full details of the checks applied by &(appendfile)& before it writes to a file
39485 are given in chapter &<<CHAPappendfile>>&.
39486
39487
39488
39489 .section "Running local commands" "SECTsecconslocalcmds"
39490 .cindex "security" "local commands"
39491 .cindex "security" "command injection attacks"
39492 There are a number of ways in which an administrator can configure Exim to run
39493 commands based upon received, untrustworthy, data. Further, in some
39494 configurations a user who can control a &_.forward_& file can also arrange to
39495 run commands. Configuration to check includes, but is not limited to:
39496
39497 .ilist
39498 Use of &%use_shell%& in the pipe transport: various forms of shell command
39499 injection may be possible with this option present. It is dangerous and should
39500 be used only with considerable caution. Consider constraints which whitelist
39501 allowed characters in a variable which is to be used in a pipe transport that
39502 has &%use_shell%& enabled.
39503 .next
39504 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39505 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39506 &_.forward_& files in a redirect router. If Exim is running on a central mail
39507 hub to which ordinary users do not have shell access, but home directories are
39508 NFS mounted (for instance) then administrators should review the list of these
39509 forbid options available, and should bear in mind that the options that may
39510 need forbidding can change as new features are added between releases.
39511 .next
39512 The &%${run...}%& expansion item does not use a shell by default, but
39513 administrators can configure use of &_/bin/sh_& as part of the command.
39514 Such invocations should be viewed with prejudicial suspicion.
39515 .next
39516 Administrators who use embedded Perl are advised to explore how Perl's
39517 taint checking might apply to their usage.
39518 .next
39519 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39520 administrators are well advised to view its use with suspicion, in case (for
39521 instance) it allows a local-part to contain embedded Exim directives.
39522 .next
39523 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39524 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39525 each can reference arbitrary lists and files, rather than just being a list
39526 of opaque strings.
39527 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39528 real-world security vulnerabilities caused by its use with untrustworthy data
39529 injected in, for SQL injection attacks.
39530 Consider the use of the &%inlisti%& expansion condition instead.
39531 .endlist
39532
39533
39534
39535
39536 .section "Trust in configuration data" "SECTsecconfdata"
39537 .cindex "security" "data sources"
39538 .cindex "security" "regular expressions"
39539 .cindex "regular expressions" "security"
39540 .cindex "PCRE" "security"
39541 If configuration data for Exim can come from untrustworthy sources, there
39542 are some issues to be aware of:
39543
39544 .ilist
39545 Use of &%${expand...}%& may provide a path for shell injection attacks.
39546 .next
39547 Letting untrusted data provide a regular expression is unwise.
39548 .next
39549 Using &%${match...}%& to apply a fixed regular expression against untrusted
39550 data may result in pathological behaviour within PCRE.  Be aware of what
39551 "backtracking" means and consider options for being more strict with a regular
39552 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39553 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39554 possessive quantifiers or just not using regular expressions against untrusted
39555 data.
39556 .next
39557 It can be important to correctly use &%${quote:...}%&,
39558 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39559 items to ensure that data is correctly constructed.
39560 .next
39561 Some lookups might return multiple results, even though normal usage is only
39562 expected to yield one result.
39563 .endlist
39564
39565
39566
39567
39568 .section "IPv4 source routing" "SECID272"
39569 .cindex "source routing" "in IP packets"
39570 .cindex "IP source routing"
39571 Many operating systems suppress IP source-routed packets in the kernel, but
39572 some cannot be made to do this, so Exim does its own check. It logs incoming
39573 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39574 IPv6. No special checking is currently done.
39575
39576
39577
39578 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39579 Support for these SMTP commands is disabled by default. If required, they can
39580 be enabled by defining suitable ACLs.
39581
39582
39583
39584
39585 .section "Privileged users" "SECID274"
39586 .cindex "trusted users"
39587 .cindex "admin user"
39588 .cindex "privileged user"
39589 .cindex "user" "trusted"
39590 .cindex "user" "admin"
39591 Exim recognizes two sets of users with special privileges. Trusted users are
39592 able to submit new messages to Exim locally, but supply their own sender
39593 addresses and information about a sending host. For other users submitting
39594 local messages, Exim sets up the sender address from the uid, and doesn't
39595 permit a remote host to be specified.
39596
39597 .oindex "&%-f%&"
39598 However, an untrusted user is permitted to use the &%-f%& command line option
39599 in the special form &%-f <>%& to indicate that a delivery failure for the
39600 message should not cause an error report. This affects the message's envelope,
39601 but it does not affect the &'Sender:'& header. Untrusted users may also be
39602 permitted to use specific forms of address with the &%-f%& option by setting
39603 the &%untrusted_set_sender%& option.
39604
39605 Trusted users are used to run processes that receive mail messages from some
39606 other mail domain and pass them on to Exim for delivery either locally, or over
39607 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39608 as any user listed in the &%trusted_users%& configuration option, or under any
39609 group listed in the &%trusted_groups%& option.
39610
39611 Admin users are permitted to do things to the messages on Exim's queue. They
39612 can freeze or thaw messages, cause them to be returned to their senders, remove
39613 them entirely, or modify them in various ways. In addition, admin users can run
39614 the Exim monitor and see all the information it is capable of providing, which
39615 includes the contents of files on the spool.
39616
39617 .oindex "&%-M%&"
39618 .oindex "&%-q%&"
39619 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39620 delivery of messages on its queue is restricted to admin users. This
39621 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39622 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39623 queue is also restricted to admin users. This restriction can be relaxed by
39624 setting &%no_queue_list_requires_admin%&.
39625
39626 Exim recognizes an admin user if the calling process is running as root or as
39627 the Exim user or if any of the groups associated with the calling process is
39628 the Exim group. It is not necessary actually to be running under the Exim
39629 group. However, if admin users who are not root or the Exim user are to access
39630 the contents of files on the spool via the Exim monitor (which runs
39631 unprivileged), Exim must be built to allow group read access to its spool
39632 files.
39633
39634 By default, regular users are trusted to perform basic testing and
39635 introspection commands, as themselves.  This setting can be tightened by
39636 setting the &%commandline_checks_require_admin%& option.
39637 This affects most of the checking options,
39638 such as &%-be%& and anything else &%-b*%&.
39639
39640
39641 .section "Spool files" "SECID275"
39642 .cindex "spool directory" "files"
39643 Exim's spool directory and everything it contains is owned by the Exim user and
39644 set to the Exim group. The mode for spool files is defined in the
39645 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39646 any user who is a member of the Exim group can access these files.
39647
39648
39649
39650 .section "Use of argv[0]" "SECID276"
39651 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39652 of specific strings, Exim assumes certain options. For example, calling Exim
39653 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39654 to calling it with the option &%-bS%&. There are no security implications in
39655 this.
39656
39657
39658
39659 .section "Use of %f formatting" "SECID277"
39660 The only use made of &"%f"& by Exim is in formatting load average values. These
39661 are actually stored in integer variables as 1000 times the load average.
39662 Consequently, their range is limited and so therefore is the length of the
39663 converted output.
39664
39665
39666
39667 .section "Embedded Exim path" "SECID278"
39668 Exim uses its own path name, which is embedded in the code, only when it needs
39669 to re-exec in order to regain root privilege. Therefore, it is not root when it
39670 does so. If some bug allowed the path to get overwritten, it would lead to an
39671 arbitrary program's being run as exim, not as root.
39672
39673
39674
39675 .section "Dynamic module directory" "SECTdynmoddir"
39676 Any dynamically loadable modules must be installed into the directory
39677 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39678 loading it.
39679
39680
39681 .section "Use of sprintf()" "SECID279"
39682 .cindex "&[sprintf()]&"
39683 A large number of occurrences of &"sprintf"& in the code are actually calls to
39684 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39685 The intermediate formatting is done into a large fixed buffer by a function
39686 that runs through the format string itself, and checks the length of each
39687 conversion before performing it, thus preventing buffer overruns.
39688
39689 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39690 the output buffer is known to be sufficiently long to contain the converted
39691 string.
39692
39693
39694
39695 .section "Use of debug_printf() and log_write()" "SECID280"
39696 Arbitrary strings are passed to both these functions, but they do their
39697 formatting by calling the function &'string_vformat()'&, which runs through
39698 the format string itself, and checks the length of each conversion.
39699
39700
39701
39702 .section "Use of strcat() and strcpy()" "SECID281"
39703 These are used only in cases where the output buffer is known to be large
39704 enough to hold the result.
39705 .ecindex IIDsecurcon
39706
39707
39708
39709
39710 . ////////////////////////////////////////////////////////////////////////////
39711 . ////////////////////////////////////////////////////////////////////////////
39712
39713 .chapter "Format of spool files" "CHAPspool"
39714 .scindex IIDforspo1 "format" "spool files"
39715 .scindex IIDforspo2 "spool directory" "format of files"
39716 .scindex IIDforspo3 "spool files" "format of"
39717 .cindex "spool files" "editing"
39718 A message on Exim's queue consists of two files, whose names are the message id
39719 followed by -D and -H, respectively. The data portion of the message is kept in
39720 the -D file on its own. The message's envelope, status, and headers are all
39721 kept in the -H file, whose format is described in this chapter. Each of these
39722 two files contains the final component of its own name as its first line. This
39723 is insurance against disk crashes where the directory is lost but the files
39724 themselves are recoverable.
39725
39726 The file formats may be changed, or new formats added, at any release.
39727 Spool files are not intended as an interface to other programs
39728 and should not be used as such.
39729
39730 Some people are tempted into editing -D files in order to modify messages. You
39731 need to be extremely careful if you do this; it is not recommended and you are
39732 on your own if you do it. Here are some of the pitfalls:
39733
39734 .ilist
39735 You must ensure that Exim does not try to deliver the message while you are
39736 fiddling with it. The safest way is to take out a write lock on the -D file,
39737 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39738 place, the lock will be retained. If you write a new file and rename it, the
39739 lock will be lost at the instant of rename.
39740 .next
39741 .vindex "&$body_linecount$&"
39742 If you change the number of lines in the file, the value of
39743 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39744 cause incomplete transmission of messages or undeliverable messages.
39745 .next
39746 If the message is in MIME format, you must take care not to break it.
39747 .next
39748 If the message is cryptographically signed, any change will invalidate the
39749 signature.
39750 .endlist
39751 All in all, modifying -D files is fraught with danger.
39752
39753 Files whose names end with -J may also be seen in the &_input_& directory (or
39754 its subdirectories when &%split_spool_directory%& is set). These are journal
39755 files, used to record addresses to which the message has been delivered during
39756 the course of a delivery attempt. If there are still undelivered recipients at
39757 the end, the -H file is updated, and the -J file is deleted. If, however, there
39758 is some kind of crash (for example, a power outage) before this happens, the -J
39759 file remains in existence. When Exim next processes the message, it notices the
39760 -J file and uses it to update the -H file before starting the next delivery
39761 attempt.
39762
39763 Files whose names end with -K or .eml may also be seen in the spool.
39764 These are temporaries used for DKIM or malware processing, when that is used.
39765 They should be tidied up by normal operations; any old ones are probably
39766 relics of crashes and can be removed.
39767
39768 .section "Format of the -H file" "SECID282"
39769 .cindex "uid (user id)" "in spool file"
39770 .cindex "gid (group id)" "in spool file"
39771 The second line of the -H file contains the login name for the uid of the
39772 process that called Exim to read the message, followed by the numerical uid and
39773 gid. For a locally generated message, this is normally the user who sent the
39774 message. For a message received over TCP/IP via the daemon, it is
39775 normally the Exim user.
39776
39777 The third line of the file contains the address of the message's sender as
39778 transmitted in the envelope, contained in angle brackets. The sender address is
39779 empty for bounce messages. For incoming SMTP mail, the sender address is given
39780 in the MAIL command. For locally generated mail, the sender address is
39781 created by Exim from the login name of the current user and the configured
39782 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39783 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39784 &"<>"& or an address that matches &%untrusted_set_senders%&.
39785
39786 The fourth line contains two numbers. The first is the time that the message
39787 was received, in the conventional Unix form &-- the number of seconds since the
39788 start of the epoch. The second number is a count of the number of messages
39789 warning of delayed delivery that have been sent to the sender.
39790
39791 There follow a number of lines starting with a hyphen. These can appear in any
39792 order, and are omitted when not relevant:
39793
39794 .vlist
39795 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39796 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39797 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39798 recognized, to provide backward compatibility. In the old format, a line of
39799 this form is present for every ACL variable that is not empty. The number
39800 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39801 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39802 the data string for the variable. The string itself starts at the beginning of
39803 the next line, and is followed by a newline character. It may contain internal
39804 newlines.
39805
39806 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39807 A line of this form is present for every ACL connection variable that is
39808 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39809 The length is the length of the data string for the variable. The string itself
39810 starts at the beginning of the next line, and is followed by a newline
39811 character. It may contain internal newlines.
39812
39813 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39814 A line of this form is present for every ACL message variable that is defined.
39815 Note that there is a space between &%-aclm%& and the rest of the name. The
39816 length is the length of the data string for the variable. The string itself
39817 starts at the beginning of the next line, and is followed by a newline
39818 character. It may contain internal newlines.
39819
39820 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39821 This is present if, when the message was received over SMTP, the value of
39822 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39823
39824 .vitem &%-allow_unqualified_recipient%&
39825 This is present if unqualified recipient addresses are permitted in header
39826 lines (to stop such addresses from being qualified if rewriting occurs at
39827 transport time). Local messages that were input using &%-bnq%& and remote
39828 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39829
39830 .vitem &%-allow_unqualified_sender%&
39831 This is present if unqualified sender addresses are permitted in header lines
39832 (to stop such addresses from being qualified if rewriting occurs at transport
39833 time). Local messages that were input using &%-bnq%& and remote messages from
39834 hosts that match &%sender_unqualified_hosts%& set this flag.
39835
39836 .vitem "&%-auth_id%&&~<&'text'&>"
39837 The id information for a message received on an authenticated SMTP connection
39838 &-- the value of the &$authenticated_id$& variable.
39839
39840 .vitem "&%-auth_sender%&&~<&'address'&>"
39841 The address of an authenticated sender &-- the value of the
39842 &$authenticated_sender$& variable.
39843
39844 .vitem "&%-body_linecount%&&~<&'number'&>"
39845 This records the number of lines in the body of the message, and is
39846 present unless &%-spool_file_wireformat%& is.
39847
39848 .vitem "&%-body_zerocount%&&~<&'number'&>"
39849 This records the number of binary zero bytes in the body of the message, and is
39850 present if the number is greater than zero.
39851
39852 .vitem &%-deliver_firsttime%&
39853 This is written when a new message is first added to the spool. When the spool
39854 file is updated after a deferral, it is omitted.
39855
39856 .vitem "&%-frozen%&&~<&'time'&>"
39857 .cindex "frozen messages" "spool data"
39858 The message is frozen, and the freezing happened at <&'time'&>.
39859
39860 .vitem "&%-helo_name%&&~<&'text'&>"
39861 This records the host name as specified by a remote host in a HELO or EHLO
39862 command.
39863
39864 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39865 This records the IP address of the host from which the message was received and
39866 the remote port number that was used. It is omitted for locally generated
39867 messages.
39868
39869 .vitem "&%-host_auth%&&~<&'text'&>"
39870 If the message was received on an authenticated SMTP connection, this records
39871 the name of the authenticator &-- the value of the
39872 &$sender_host_authenticated$& variable.
39873
39874 .vitem &%-host_lookup_failed%&
39875 This is present if an attempt to look up the sending host's name from its IP
39876 address failed. It corresponds to the &$host_lookup_failed$& variable.
39877
39878 .vitem "&%-host_name%&&~<&'text'&>"
39879 .cindex "reverse DNS lookup"
39880 .cindex "DNS" "reverse lookup"
39881 This records the name of the remote host from which the message was received,
39882 if the host name was looked up from the IP address when the message was being
39883 received. It is not present if no reverse lookup was done.
39884
39885 .vitem "&%-ident%&&~<&'text'&>"
39886 For locally submitted messages, this records the login of the originating user,
39887 unless it was a trusted user and the &%-oMt%& option was used to specify an
39888 ident value. For messages received over TCP/IP, this records the ident string
39889 supplied by the remote host, if any.
39890
39891 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39892 This records the IP address of the local interface and the port number through
39893 which a message was received from a remote host. It is omitted for locally
39894 generated messages.
39895
39896 .vitem &%-local%&
39897 The message is from a local sender.
39898
39899 .vitem &%-localerror%&
39900 The message is a locally-generated bounce message.
39901
39902 .vitem "&%-local_scan%&&~<&'string'&>"
39903 This records the data string that was returned by the &[local_scan()]& function
39904 when the message was received &-- the value of the &$local_scan_data$&
39905 variable. It is omitted if no data was returned.
39906
39907 .vitem &%-manual_thaw%&
39908 The message was frozen but has been thawed manually, that is, by an explicit
39909 Exim command rather than via the auto-thaw process.
39910
39911 .vitem &%-N%&
39912 A testing delivery process was started using the &%-N%& option to suppress any
39913 actual deliveries, but delivery was deferred. At any further delivery attempts,
39914 &%-N%& is assumed.
39915
39916 .vitem &%-received_protocol%&
39917 This records the value of the &$received_protocol$& variable, which contains
39918 the name of the protocol by which the message was received.
39919
39920 .vitem &%-sender_set_untrusted%&
39921 The envelope sender of this message was set by an untrusted local caller (used
39922 to ensure that the caller is displayed in queue listings).
39923
39924 .vitem "&%-spam_score_int%&&~<&'number'&>"
39925 If a message was scanned by SpamAssassin, this is present. It records the value
39926 of &$spam_score_int$&.
39927
39928 .vitem &%-spool_file_wireformat%&
39929 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39930 rather than Unix-format.
39931 The line-ending is CRLF rather than newline.
39932 There is still, however, no leading-dot-stuffing.
39933
39934 .vitem &%-tls_certificate_verified%&
39935 A TLS certificate was received from the client that sent this message, and the
39936 certificate was verified by the server.
39937
39938 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39939 When the message was received over an encrypted connection, this records the
39940 name of the cipher suite that was used.
39941
39942 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39943 When the message was received over an encrypted connection, and a certificate
39944 was received from the client, this records the Distinguished Name from that
39945 certificate.
39946 .endlist
39947
39948 Any of the above may have an extra hyphen prepended, to indicate the the
39949 corresponding data is untrusted.
39950
39951 Following the options there is a list of those addresses to which the message
39952 is not to be delivered. This set of addresses is initialized from the command
39953 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39954 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39955 the address is added to this set. The addresses are kept internally as a
39956 balanced binary tree, and it is a representation of that tree which is written
39957 to the spool file. If an address is expanded via an alias or forward file, the
39958 original address is added to the tree when deliveries to all its child
39959 addresses are complete.
39960
39961 If the tree is empty, there is a single line in the spool file containing just
39962 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39963 Y or N, followed by an address. The address is the value for the node of the
39964 tree, and the letters indicate whether the node has a left branch and/or a
39965 right branch attached to it, respectively. If branches exist, they immediately
39966 follow. Here is an example of a three-node tree:
39967 .code
39968 YY darcy@austen.fict.example
39969 NN alice@wonderland.fict.example
39970 NN editor@thesaurus.ref.example
39971 .endd
39972 After the non-recipients tree, there is a list of the message's recipients.
39973 This is a simple list, preceded by a count. It includes all the original
39974 recipients of the message, including those to whom the message has already been
39975 delivered. In the simplest case, the list contains one address per line. For
39976 example:
39977 .code
39978 4
39979 editor@thesaurus.ref.example
39980 darcy@austen.fict.example
39981 rdo@foundation
39982 alice@wonderland.fict.example
39983 .endd
39984 However, when a child address has been added to the top-level addresses as a
39985 result of the use of the &%one_time%& option on a &(redirect)& router, each
39986 line is of the following form:
39987 .display
39988 <&'top-level address'&> <&'errors_to address'&> &&&
39989   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39990 .endd
39991 The 01 flag bit indicates the presence of the three other fields that follow
39992 the top-level address. Other bits may be used in future to support additional
39993 fields. The <&'parent number'&> is the offset in the recipients list of the
39994 original parent of the &"one time"& address. The first two fields are the
39995 envelope sender that is associated with this address and its length. If the
39996 length is zero, there is no special envelope sender (there are then two space
39997 characters in the line). A non-empty field can arise from a &(redirect)& router
39998 that has an &%errors_to%& setting.
39999
40000
40001 A blank line separates the envelope and status information from the headers
40002 which follow. A header may occupy several lines of the file, and to save effort
40003 when reading it in, each header is preceded by a number and an identifying
40004 character. The number is the number of characters in the header, including any
40005 embedded newlines and the terminating newline. The character is one of the
40006 following:
40007
40008 .table2 50pt
40009 .row <&'blank'&>         "header in which Exim has no special interest"
40010 .row &`B`&               "&'Bcc:'& header"
40011 .row &`C`&               "&'Cc:'& header"
40012 .row &`F`&               "&'From:'& header"
40013 .row &`I`&               "&'Message-id:'& header"
40014 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40015 .row &`R`&               "&'Reply-To:'& header"
40016 .row &`S`&               "&'Sender:'& header"
40017 .row &`T`&               "&'To:'& header"
40018 .row &`*`&               "replaced or deleted header"
40019 .endtable
40020
40021 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40022 purposes. They are not transmitted when the message is delivered. Here is a
40023 typical set of headers:
40024 .code
40025 111P Received: by hobbit.fict.example with local (Exim 4.00)
40026 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40027 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40028 038* X-rewrote-sender: bb@hobbit.fict.example
40029 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40030 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40031 099* To: alice@wonderland.fict.example, rdo@foundation,
40032 darcy@austen.fict.example, editor@thesaurus.ref.example
40033 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40034 darcy@austen.fict.example, editor@thesaurus.ref.example
40035 038  Date: Fri, 11 May 2001 10:28:59 +0100
40036 .endd
40037 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40038 &'To:'& header have been rewritten, the last one because routing expanded the
40039 unqualified domain &'foundation'&.
40040 .ecindex IIDforspo1
40041 .ecindex IIDforspo2
40042 .ecindex IIDforspo3
40043
40044 .section "Format of the -D file" "SECID282a"
40045 The data file is traditionally in Unix-standard format: lines are ended with
40046 an ASCII newline character.
40047 However, when the &%spool_wireformat%& main option is used some -D files
40048 can have an alternate format.
40049 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40050 The -D file lines (not including the first name-component line) are
40051 suitable for direct copying to the wire when transmitting using the
40052 ESMTP CHUNKING option, meaning lower processing overhead.
40053 Lines are terminated with an ASCII CRLF pair.
40054 There is no dot-stuffing (and no dot-termination).
40055
40056 . ////////////////////////////////////////////////////////////////////////////
40057 . ////////////////////////////////////////////////////////////////////////////
40058
40059 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40060          "DKIM, SPF and DMARC Support"
40061
40062 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40063 .cindex "DKIM"
40064
40065 DKIM is a mechanism by which messages sent by some entity can be provably
40066 linked to a domain which that entity controls.  It permits reputation to
40067 be tracked on a per-domain basis, rather than merely upon source IP address.
40068 DKIM is documented in RFC 6376.
40069
40070 As DKIM relies on the message being unchanged in transit, messages handled
40071 by a mailing-list (which traditionally adds to the message) will not match
40072 any original DKIM signature.
40073
40074 DKIM support is compiled into Exim by default if TLS support is present.
40075 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40076
40077 Exim's DKIM implementation allows for
40078 .olist
40079 Signing outgoing messages: This function is implemented in the SMTP transport.
40080 It can co-exist with all other Exim features
40081 (including transport filters)
40082 except cutthrough delivery.
40083 .next
40084 Verifying signatures in incoming messages: This is implemented by an additional
40085 ACL (acl_smtp_dkim), which can be called several times per message, with
40086 different signature contexts.
40087 .endlist
40088
40089 In typical Exim style, the verification implementation does not include any
40090 default "policy". Instead it enables you to build your own policy using
40091 Exim's standard controls.
40092
40093 Please note that verification of DKIM signatures in incoming mail is turned
40094 on by default for logging (in the <= line) purposes.
40095
40096 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40097 When set, for each signature in incoming email,
40098 exim will log a line displaying the most important signature details, and the
40099 signature status. Here is an example (with line-breaks added for clarity):
40100 .code
40101 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40102     d=facebookmail.com s=q1-2009b
40103     c=relaxed/relaxed a=rsa-sha1
40104     i=@facebookmail.com t=1252484542 [verification succeeded]
40105 .endd
40106
40107 You might want to turn off DKIM verification processing entirely for internal
40108 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40109 control modifier. This should typically be done in the RCPT ACL, at points
40110 where you accept mail from relay sources (internal hosts or authenticated
40111 senders).
40112
40113
40114 .section "Signing outgoing messages" "SECDKIMSIGN"
40115 .cindex "DKIM" "signing"
40116
40117 For signing to be usable you must have published a DKIM record in DNS.
40118 Note that RFC 8301 (which does not cover EC keys) says:
40119 .code
40120 rsa-sha1 MUST NOT be used for signing or verifying.
40121
40122 Signers MUST use RSA keys of at least 1024 bits for all keys.
40123 Signers SHOULD use RSA keys of at least 2048 bits.
40124 .endd
40125
40126 Note also that the key content (the 'p=' field)
40127 in the DNS record is different between RSA and EC keys;
40128 for the former it is the base64 of the ASN.1 for the RSA public key
40129 (equivalent to the private-key .pem with the header/trailer stripped)
40130 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40131
40132 Signing is enabled by setting private options on the SMTP transport.
40133 These options take (expandable) strings as arguments.
40134
40135 .option dkim_domain smtp string list&!! unset
40136 The domain(s) you want to sign with.
40137 After expansion, this can be a list.
40138 Each element in turn,
40139 lowercased,
40140 is put into the &%$dkim_domain%& expansion variable
40141 while expanding the remaining signing options.
40142 If it is empty after expansion, DKIM signing is not done,
40143 and no error will result even if &%dkim_strict%& is set.
40144
40145 .option dkim_selector smtp string list&!! unset
40146 This sets the key selector string.
40147 After expansion, which can use &$dkim_domain$&, this can be a list.
40148 Each element in turn is put in the expansion
40149 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40150 option along with &%$dkim_domain%&.
40151 If the option is empty after expansion, DKIM signing is not done for this domain,
40152 and no error will result even if &%dkim_strict%& is set.
40153
40154 .option dkim_private_key smtp string&!! unset
40155 This sets the private key to use.
40156 You can use the &%$dkim_domain%& and
40157 &%$dkim_selector%& expansion variables to determine the private key to use.
40158 The result can either
40159 .ilist
40160 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40161 .next
40162 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40163 be a valid Ed25519 private key (same format as above)
40164 .next
40165 start with a slash, in which case it is treated as a file that contains
40166 the private key
40167 .next
40168 be "0", "false" or the empty string, in which case the message will not
40169 be signed. This case will not result in an error, even if &%dkim_strict%&
40170 is set.
40171 .endlist
40172
40173 To generate keys under OpenSSL:
40174 .code
40175 openssl genrsa -out dkim_rsa.private 2048
40176 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40177 .endd
40178 Take the base-64 lines from the output of the second command, concatenated,
40179 for the DNS TXT record.
40180 See section 3.6 of RFC6376 for the record specification.
40181
40182 Under GnuTLS:
40183 .code
40184 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40185 certtool --load-privkey=dkim_rsa.private --pubkey-info
40186 .endd
40187
40188 Note that RFC 8301 says:
40189 .code
40190 Signers MUST use RSA keys of at least 1024 bits for all keys.
40191 Signers SHOULD use RSA keys of at least 2048 bits.
40192 .endd
40193
40194 EC keys for DKIM are defined by RFC 8463.
40195 They are considerably smaller than RSA keys for equivalent protection.
40196 As they are a recent development, users should consider dual-signing
40197 (by setting a list of selectors, and an expansion for this option)
40198 for some transition period.
40199 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40200 for EC keys.
40201
40202 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40203 .code
40204 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40205 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40206 .endd
40207
40208 To produce the required public key value for a DNS record:
40209 .code
40210 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40211 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40212 .endd
40213
40214 Exim also supports an alternate format
40215 of Ed25519 keys in DNS which was a candidate during development
40216 of the standard, but not adopted.
40217 A future release will probably drop that support.
40218
40219 .option dkim_hash smtp string&!! sha256
40220 Can be set to any one of the supported hash methods, which are:
40221 .ilist
40222 &`sha1`& &-- should not be used, is old and insecure
40223 .next
40224 &`sha256`& &-- the default
40225 .next
40226 &`sha512`& &-- possibly more secure but less well supported
40227 .endlist
40228
40229 Note that RFC 8301 says:
40230 .code
40231 rsa-sha1 MUST NOT be used for signing or verifying.
40232 .endd
40233
40234 .option dkim_identity smtp string&!! unset
40235 If set after expansion, the value is used to set an "i=" tag in
40236 the signing header.  The DKIM standards restrict the permissible
40237 syntax of this optional tag to a mail address, with possibly-empty
40238 local part, an @, and a domain identical to or subdomain of the "d="
40239 tag value.  Note that Exim does not check the value.
40240
40241 .option dkim_canon smtp string&!! unset
40242 This option sets the canonicalization method used when signing a message.
40243 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40244 The option defaults to "relaxed" when unset. Note: the current implementation
40245 only supports signing with the same canonicalization method for both headers and body.
40246
40247 .option dkim_strict smtp string&!! unset
40248 This  option  defines  how  Exim  behaves  when  signing a message that
40249 should be signed fails for some reason.  When the expansion evaluates to
40250 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40251 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40252 variables here.
40253
40254 .option dkim_sign_headers smtp string&!! "see below"
40255 If set, this option must expand to a colon-separated
40256 list of header names.
40257 Headers with these names, or the absence or such a header, will be included
40258 in the message signature.
40259 When unspecified, the header names listed in RFC4871 will be used,
40260 whether or not each header is present in the message.
40261 The default list is available for the expansion in the macro
40262 "_DKIM_SIGN_HEADERS".
40263
40264 If a name is repeated, multiple headers by that name (or the absence thereof)
40265 will be signed.  The textually later headers in the headers part of the
40266 message are signed first, if there are multiples.
40267
40268 A name can be prefixed with either an '=' or a '+' character.
40269 If an '=' prefix is used, all headers that are present with this name
40270 will be signed.
40271 If a '+' prefix if used, all headers that are present with this name
40272 will be signed, and one signature added for a missing header with the
40273 name will be appended.
40274
40275 .option dkim_timestamps smtp integer&!! unset
40276 This option controls the inclusion of timestamp information in the signature.
40277 If not set, no such information will be included.
40278 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40279 for the expiry tag
40280 (eg. 1209600 for two weeks);
40281 both creation (t=) and expiry (x=) tags will be included.
40282
40283 RFC 6376 lists these tags as RECOMMENDED.
40284
40285
40286 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40287 .cindex "DKIM" "verification"
40288
40289 Verification of DKIM signatures in SMTP incoming email is done for all
40290 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40291 .cindex DKIM "selecting signature algorithms"
40292 Individual classes of signature algorithm can be ignored by changing
40293 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40294 The &%dkim_verify_minimal%& option can be set to cease verification
40295 processing for a message once the first passing signature is found.
40296
40297 .cindex authentication "expansion item"
40298 Performing verification sets up information used by the
40299 &%authresults%& expansion item.
40300
40301 For most purposes the default option settings suffice and the remainder
40302 of this section can be ignored.
40303
40304 The results of verification are made available to the
40305 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40306 A missing ACL definition defaults to accept.
40307 By default, the ACL is called once for each
40308 syntactically(!) correct signature in the incoming message.
40309 If any ACL call does not accept, the message is not accepted.
40310 If a cutthrough delivery was in progress for the message, that is
40311 summarily dropped (having wasted the transmission effort).
40312
40313 To evaluate the verification result in the ACL
40314 a large number of expansion variables
40315 containing the signature status and its details are set up during the
40316 runtime of the ACL.
40317
40318 Calling the ACL only for existing signatures is not sufficient to build
40319 more advanced policies. For that reason, the main option
40320 &%dkim_verify_signers%&, and an expansion variable
40321 &%$dkim_signers%& exist.
40322
40323 The main option &%dkim_verify_signers%& can be set to a colon-separated
40324 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40325 called. It is expanded when the message has been received. At this point,
40326 the expansion variable &%$dkim_signers%& already contains a colon-separated
40327 list of signer domains and identities for the message. When
40328 &%dkim_verify_signers%& is not specified in the main configuration,
40329 it defaults as:
40330 .code
40331 dkim_verify_signers = $dkim_signers
40332 .endd
40333 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40334 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40335 call the ACL for known domains or identities. This would be achieved as follows:
40336 .code
40337 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40338 .endd
40339 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40340 and "ebay.com", plus all domains and identities that have signatures in the message.
40341 You can also be more creative in constructing your policy. For example:
40342 .code
40343 dkim_verify_signers = $sender_address_domain:$dkim_signers
40344 .endd
40345
40346 If a domain or identity is listed several times in the (expanded) value of
40347 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40348
40349 Note that if the option is set using untrustworthy data
40350 (such as the From: header)
40351 care should be taken to force lowercase for domains
40352 and for the domain part if identities.
40353 The default setting can be regarded as trustworthy in this respect.
40354
40355 If multiple signatures match a domain (or identity), the ACL is called once
40356 for each matching signature.
40357
40358
40359 Inside the DKIM ACL, the following expansion variables are
40360 available (from most to least important):
40361
40362
40363 .vlist
40364 .vitem &%$dkim_cur_signer%&
40365 The signer that is being evaluated in this ACL run. This can be a domain or
40366 an identity. This is one of the list items from the expanded main option
40367 &%dkim_verify_signers%& (see above).
40368
40369 .vitem &%$dkim_verify_status%&
40370 Within the DKIM ACL,
40371 a string describing the general status of the signature. One of
40372 .ilist
40373 &%none%&: There is no signature in the message for the current domain or
40374 identity (as reflected by &%$dkim_cur_signer%&).
40375 .next
40376 &%invalid%&: The signature could not be verified due to a processing error.
40377 More detail is available in &%$dkim_verify_reason%&.
40378 .next
40379 &%fail%&: Verification of the signature failed.  More detail is
40380 available in &%$dkim_verify_reason%&.
40381 .next
40382 &%pass%&: The signature passed verification. It is valid.
40383 .endlist
40384
40385 This variable can be overwritten using an ACL 'set' modifier.
40386 This might, for instance, be done to enforce a policy restriction on
40387 hash-method or key-size:
40388 .code
40389   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40390        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40391        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40392                                   {< {$dkim_key_length}{1024}}}}
40393        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40394        set dkim_verify_status = fail
40395        set dkim_verify_reason = hash too weak or key too short
40396 .endd
40397
40398 So long as a DKIM ACL is defined (it need do no more than accept),
40399 after all the DKIM ACL runs have completed, the value becomes a
40400 colon-separated list of the values after each run.
40401 This is maintained for the mime, prdr and data ACLs.
40402
40403 .vitem &%$dkim_verify_reason%&
40404 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40405 "fail" or "invalid". One of
40406 .ilist
40407 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40408 key for the domain could not be retrieved. This may be a temporary problem.
40409 .next
40410 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40411 record for the domain is syntactically invalid.
40412 .next
40413 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40414 body hash does not match the one specified in the signature header. This
40415 means that the message body was modified in transit.
40416 .next
40417 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40418 could not be verified. This may mean that headers were modified,
40419 re-written or otherwise changed in a way which is incompatible with
40420 DKIM verification. It may of course also mean that the signature is forged.
40421 .endlist
40422
40423 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40424
40425 .vitem &%$dkim_domain%&
40426 The signing domain. IMPORTANT: This variable is only populated if there is
40427 an actual signature in the message for the current domain or identity (as
40428 reflected by &%$dkim_cur_signer%&).
40429
40430 .vitem &%$dkim_identity%&
40431 The signing identity, if present. IMPORTANT: This variable is only populated
40432 if there is an actual signature in the message for the current domain or
40433 identity (as reflected by &%$dkim_cur_signer%&).
40434
40435 .vitem &%$dkim_selector%&
40436 The key record selector string.
40437
40438 .vitem &%$dkim_algo%&
40439 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40440 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40441 may also be 'ed25519-sha256'.
40442 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40443 for EC keys.
40444
40445 Note that RFC 8301 says:
40446 .code
40447 rsa-sha1 MUST NOT be used for signing or verifying.
40448
40449 DKIM signatures identified as having been signed with historic
40450 algorithms (currently, rsa-sha1) have permanently failed evaluation
40451 .endd
40452
40453 To enforce this you must either have a DKIM ACL which checks this variable
40454 and overwrites the &$dkim_verify_status$& variable as discussed above,
40455 or have set the main option &%dkim_verify_hashes%& to exclude
40456 processing of such signatures.
40457
40458 .vitem &%$dkim_canon_body%&
40459 The body canonicalization method. One of 'relaxed' or 'simple'.
40460
40461 .vitem &%$dkim_canon_headers%&
40462 The header canonicalization method. One of 'relaxed' or 'simple'.
40463
40464 .vitem &%$dkim_copiedheaders%&
40465 A transcript of headers and their values which are included in the signature
40466 (copied from the 'z=' tag of the signature).
40467 Note that RFC6376 requires that verification fail if the From: header is
40468 not included in the signature.  Exim does not enforce this; sites wishing
40469 strict enforcement should code the check explicitly.
40470
40471 .vitem &%$dkim_bodylength%&
40472 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40473 limit was set by the signer, "9999999999999" is returned. This makes sure
40474 that this variable always expands to an integer value.
40475 &*Note:*& The presence of the signature tag specifying a signing body length
40476 is one possible route to spoofing of valid DKIM signatures.
40477 A paranoid implementation might wish to regard signature where this variable
40478 shows less than the "no limit" return as being invalid.
40479
40480 .vitem &%$dkim_created%&
40481 UNIX timestamp reflecting the date and time when the signature was created.
40482 When this was not specified by the signer, "0" is returned.
40483
40484 .vitem &%$dkim_expires%&
40485 UNIX timestamp reflecting the date and time when the signer wants the
40486 signature to be treated as "expired". When this was not specified by the
40487 signer, "9999999999999" is returned. This makes it possible to do useful
40488 integer size comparisons against this value.
40489 Note that Exim does not check this value.
40490
40491 .vitem &%$dkim_headernames%&
40492 A colon-separated list of names of headers included in the signature.
40493
40494 .vitem &%$dkim_key_testing%&
40495 "1" if the key record has the "testing" flag set, "0" if not.
40496
40497 .vitem &%$dkim_key_nosubdomains%&
40498 "1" if the key record forbids subdomaining, "0" otherwise.
40499
40500 .vitem &%$dkim_key_srvtype%&
40501 Service type (tag s=) from the key record. Defaults to "*" if not specified
40502 in the key record.
40503
40504 .vitem &%$dkim_key_granularity%&
40505 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40506 in the key record.
40507
40508 .vitem &%$dkim_key_notes%&
40509 Notes from the key record (tag n=).
40510
40511 .vitem &%$dkim_key_length%&
40512 Number of bits in the key.
40513
40514 Note that RFC 8301 says:
40515 .code
40516 Verifiers MUST NOT consider signatures using RSA keys of
40517 less than 1024 bits as valid signatures.
40518 .endd
40519
40520 To enforce this you must have a DKIM ACL which checks this variable
40521 and overwrites the &$dkim_verify_status$& variable as discussed above.
40522 As EC keys are much smaller, the check should only do this for RSA keys.
40523
40524 .endlist
40525
40526 In addition, two ACL conditions are provided:
40527
40528 .vlist
40529 .vitem &%dkim_signers%&
40530 ACL condition that checks a colon-separated list of domains or identities
40531 for a match against the domain or identity that the ACL is currently verifying
40532 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40533 verb to a group of domains or identities. For example:
40534
40535 .code
40536 # Warn when Mail purportedly from GMail has no gmail signature
40537 warn log_message = GMail sender without gmail.com DKIM signature
40538      sender_domains = gmail.com
40539      dkim_signers = gmail.com
40540      dkim_status = none
40541 .endd
40542
40543 Note that the above does not check for a total lack of DKIM signing;
40544 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40545
40546 .vitem &%dkim_status%&
40547 ACL condition that checks a colon-separated list of possible DKIM verification
40548 results against the actual result of verification. This is typically used
40549 to restrict an ACL verb to a list of verification outcomes, for example:
40550
40551 .code
40552 deny message = Mail from Paypal with invalid/missing signature
40553      sender_domains = paypal.com:paypal.de
40554      dkim_signers = paypal.com:paypal.de
40555      dkim_status = none:invalid:fail
40556 .endd
40557
40558 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40559 see the documentation of the &%$dkim_verify_status%& expansion variable above
40560 for more information of what they mean.
40561 .endlist
40562
40563
40564
40565
40566 .section "SPF (Sender Policy Framework)" SECSPF
40567 .cindex SPF verification
40568
40569 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40570 messages with its domain in the envelope from, documented by RFC 7208.
40571 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40572 the &url(http://openspf.org).
40573 . --- 2019-10-28: still not https, open-spf.org is told to be a
40574 . --- web-archive copy of the now dead openspf.org site
40575 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40576 . --- discussion.
40577
40578 Messages sent by a system not authorised will fail checking of such assertions.
40579 This includes retransmissions done by traditional forwarders.
40580
40581 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40582 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40583 &url(https://www.libspf2.org/).
40584 There is no Exim involvement in the transmission of messages;
40585 publishing certain DNS records is all that is required.
40586
40587 For verification, an ACL condition and an expansion lookup are provided.
40588 .cindex authentication "expansion item"
40589 Performing verification sets up information used by the
40590 &%authresults%& expansion item.
40591
40592
40593 .cindex SPF "ACL condition"
40594 .cindex ACL "spf condition"
40595 The ACL condition "spf" can be used at or after the MAIL ACL.
40596 It takes as an argument a list of strings giving the outcome of the SPF check,
40597 and will succeed for any matching outcome.
40598 Valid strings are:
40599 .vlist
40600 .vitem &%pass%&
40601 The SPF check passed, the sending host is positively verified by SPF.
40602
40603 .vitem &%fail%&
40604 The SPF check failed, the sending host is NOT allowed to send mail for the
40605 domain in the envelope-from address.
40606
40607 .vitem &%softfail%&
40608 The SPF check failed, but the queried domain can't absolutely confirm that this
40609 is a forgery.
40610
40611 .vitem &%none%&
40612 The queried domain does not publish SPF records.
40613
40614 .vitem &%neutral%&
40615 The SPF check returned a "neutral" state.  This means the queried domain has
40616 published a SPF record, but wants to allow outside servers to send mail under
40617 its domain as well.  This should be treated like "none".
40618
40619 .vitem &%permerror%&
40620 This indicates a syntax error in the SPF record of the queried domain.
40621 You may deny messages when this occurs.
40622
40623 .vitem &%temperror%&
40624 This indicates a temporary error during all processing, including Exim's
40625 SPF processing.  You may defer messages when this occurs.
40626 .endlist
40627
40628 You can prefix each string with an exclamation mark to  invert
40629 its meaning,  for example  "!fail" will  match all  results but
40630 "fail".  The  string  list is  evaluated  left-to-right,  in a
40631 short-circuit fashion.
40632
40633 Example:
40634 .code
40635 deny spf = fail
40636      message = $sender_host_address is not allowed to send mail from \
40637                ${if def:sender_address_domain \
40638                     {$sender_address_domain}{$sender_helo_name}}.  \
40639                Please see http://www.open-spf.org/Why?scope=\
40640                ${if def:sender_address_domain {mfrom}{helo}};\
40641                identity=${if def:sender_address_domain \
40642                              {$sender_address}{$sender_helo_name}};\
40643                ip=$sender_host_address
40644 .endd
40645
40646 When the spf condition has run, it sets up several expansion
40647 variables:
40648
40649 .cindex SPF "verification variables"
40650 .vlist
40651 .vitem &$spf_header_comment$&
40652 .vindex &$spf_header_comment$&
40653   This contains a human-readable string describing the outcome
40654   of the SPF check. You can add it to a custom header or use
40655   it for logging purposes.
40656
40657 .vitem &$spf_received$&
40658 .vindex &$spf_received$&
40659   This contains a complete Received-SPF: header that can be
40660   added to the message. Please note that according to the SPF
40661   draft, this header must be added at the top of the header
40662   list. Please see section 10 on how you can do this.
40663
40664   Note: in case of "Best-guess" (see below), the convention is
40665   to put this string in a header called X-SPF-Guess: instead.
40666
40667 .vitem &$spf_result$&
40668 .vindex &$spf_result$&
40669   This contains the outcome of the SPF check in string form,
40670   one of pass, fail, softfail, none, neutral, permerror or
40671   temperror.
40672
40673 .vitem &$spf_result_guessed$&
40674 .vindex &$spf_result_guessed$&
40675   This boolean is true only if a best-guess operation was used
40676   and required in order to obtain a result.
40677
40678 .vitem &$spf_smtp_comment$&
40679 .vindex &$spf_smtp_comment$&
40680   This contains a string that can be used in a SMTP response
40681   to the calling party. Useful for "fail".
40682 .endlist
40683
40684
40685 .cindex SPF "ACL condition"
40686 .cindex ACL "spf_guess condition"
40687 .cindex SPF "best guess"
40688 In addition to SPF, you can also perform checks for so-called
40689 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40690 SPF, but it is supported by the same framework that enables SPF
40691 capability.
40692 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40693 for a description of what it means.
40694 . --- 2019-10-28: still not https:
40695
40696 To access this feature, simply use the spf_guess condition in place
40697 of the spf one.  For example:
40698
40699 .code
40700 deny spf_guess = fail
40701      message = $sender_host_address doesn't look trustworthy to me
40702 .endd
40703
40704 In case you decide to reject messages based on this check, you
40705 should note that although it uses the same framework, "Best-guess"
40706 is not SPF, and therefore you should not mention SPF at all in your
40707 reject message.
40708
40709 When the spf_guess condition has run, it sets up the same expansion
40710 variables as when spf condition is run, described above.
40711
40712 Additionally, since Best-guess is not standardized, you may redefine
40713 what "Best-guess" means to you by redefining the main configuration
40714 &%spf_guess%& option.
40715 For example, the following:
40716
40717 .code
40718 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40719 .endd
40720
40721 would relax host matching rules to a broader network range.
40722
40723
40724 .cindex SPF "lookup expansion"
40725 .cindex lookup spf
40726 A lookup expansion is also available. It takes an email
40727 address as the key and an IP address
40728 (v4 or v6)
40729 as the database:
40730
40731 .code
40732   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40733 .endd
40734
40735 The lookup will return the same result strings as can appear in
40736 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40737
40738
40739
40740
40741
40742 .section DMARC SECDMARC
40743 .cindex DMARC verification
40744
40745 DMARC combines feedback from SPF, DKIM, and header From: in order
40746 to attempt to provide better indicators of the authenticity of an
40747 email.  This document does not explain the fundamentals; you
40748 should read and understand how it works by visiting the website at
40749 &url(http://www.dmarc.org/).
40750
40751 If Exim is built with DMARC support,
40752 the libopendmarc library is used.
40753
40754 For building Exim yourself, obtain the library from
40755 &url(http://sourceforge.net/projects/opendmarc/)
40756 to obtain a copy, or find it in your favorite package
40757 repository.  You will need to attend to the local/Makefile feature
40758 SUPPORT_DMARC and the associated LDFLAGS addition.
40759 This description assumes
40760 that headers will be in /usr/local/include, and that the libraries
40761 are in /usr/local/lib.
40762
40763 . subsection
40764
40765 There are three main-configuration options:
40766 .cindex DMARC "configuration options"
40767
40768 The &%dmarc_tld_file%& option
40769 .oindex &%dmarc_tld_file%&
40770 defines the location of a text file of valid
40771 top level domains the opendmarc library uses
40772 during domain parsing. Maintained by Mozilla,
40773 the most current version can be downloaded
40774 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
40775 See also the util/renew-opendmarc-tlds.sh script.
40776 .new
40777 The default for the option is unset.
40778 If not set, DMARC processing is disabled.
40779 .wen
40780
40781
40782 The &%dmarc_history_file%& option, if set
40783 .oindex &%dmarc_history_file%&
40784 defines the location of a file to log results
40785 of dmarc verification on inbound emails. The
40786 contents are importable by the opendmarc tools
40787 which will manage the data, send out DMARC
40788 reports, and expire the data. Make sure the
40789 directory of this file is writable by the user
40790 exim runs as.
40791 The default is unset.
40792
40793 The &%dmarc_forensic_sender%& option
40794 .oindex &%dmarc_forensic_sender%&
40795 defines an alternate email address to use when sending a
40796 forensic report detailing alignment failures
40797 if a sender domain's dmarc record specifies it
40798 and you have configured Exim to send them.
40799 If set, this is expanded and used for the
40800 From: header line; the address is extracted
40801 from it and used for the envelope from.
40802 If not set (the default), the From: header is expanded from
40803 the dsn_from option, and <> is used for the
40804 envelope from.
40805
40806 . I wish we had subsections...
40807
40808 .cindex DMARC controls
40809 By default, the DMARC processing will run for any remote,
40810 non-authenticated user.  It makes sense to only verify DMARC
40811 status of messages coming from remote, untrusted sources.  You can
40812 use standard conditions such as hosts, senders, etc, to decide that
40813 DMARC verification should *not* be performed for them and disable
40814 DMARC with an ACL control modifier:
40815 .code
40816   control = dmarc_disable_verify
40817 .endd
40818 A DMARC record can also specify a "forensic address", which gives
40819 exim an email address to submit reports about failed alignment.
40820 Exim does not do this by default because in certain conditions it
40821 results in unintended information leakage (what lists a user might
40822 be subscribed to, etc).  You must configure exim to submit forensic
40823 reports to the owner of the domain.  If the DMARC record contains a
40824 forensic address and you specify the control statement below, then
40825 exim will send these forensic emails.  It is also advised that you
40826 configure a &%dmarc_forensic_sender%& because the default sender address
40827 construction might be inadequate.
40828 .code
40829   control = dmarc_enable_forensic
40830 .endd
40831 (AGAIN: You can choose not to send these forensic reports by simply
40832 not putting the dmarc_enable_forensic control line at any point in
40833 your exim config.  If you don't tell exim to send them, it will not
40834 send them.)
40835
40836 There are no options to either control.  Both must appear before
40837 the DATA acl.
40838
40839 . subsection
40840
40841 DMARC checks cam be run on incoming SMTP  messages by using the
40842 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
40843 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
40844 condition.  Putting this condition in the ACLs is required in order
40845 for a DMARC check to actually occur.  All of the variables are set
40846 up before the DATA ACL, but there is no actual DMARC check that
40847 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
40848
40849 The &"dmarc_status"& condition takes a list of strings on its
40850 right-hand side.  These strings describe recommended action based
40851 on the DMARC check.  To understand what the policy recommendations
40852 mean, refer to the DMARC website above.  Valid strings are:
40853 .display
40854 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40855 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40856 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40857 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40858 &'norecord    '& No policy section in the DMARC record for this sender domain.
40859 &'nofrom      '& Unable to determine the domain of the sender.
40860 &'temperror   '& Library error or dns error.
40861 &'off         '& The DMARC check was disabled for this email.
40862 .endd
40863 You can prefix each string with an exclamation mark to invert its
40864 meaning, for example "!accept" will match all results but
40865 "accept".  The string list is evaluated left-to-right in a
40866 short-circuit fashion.  When a string matches the outcome of the
40867 DMARC check, the condition succeeds.  If none of the listed
40868 strings matches the outcome of the DMARC check, the condition
40869 fails.
40870
40871 Of course, you can also use any other lookup method that Exim
40872 supports, including LDAP, Postgres, MySQL, etc, as long as the
40873 result is a list of colon-separated strings.
40874
40875 Performing the check sets up information used by the
40876 &%authresults%& expansion item.
40877
40878 Several expansion variables are set before the DATA ACL is
40879 processed, and you can use them in this ACL.  The following
40880 expansion variables are available:
40881
40882 .vlist
40883 .vitem &$dmarc_status$&
40884 .vindex &$dmarc_status$&
40885 .cindex DMARC result
40886 A one word status indicating what the DMARC library
40887 thinks of the email.  It is a combination of the results of
40888 DMARC record lookup and the SPF/DKIM/DMARC processing results
40889 (if a DMARC record was found).  The actual policy declared
40890 in the DMARC record is in a separate expansion variable.
40891
40892 .vitem &$dmarc_status_text$&
40893 .vindex &$dmarc_status_text$&
40894 Slightly longer, human readable status.
40895
40896 .vitem &$dmarc_used_domain$&
40897 .vindex &$dmarc_used_domain$&
40898 The domain which DMARC used to look up the DMARC policy record.
40899
40900 .vitem &$dmarc_domain_policy$&
40901 .vindex &$dmarc_domain_policy$&
40902 The policy declared in the DMARC record.  Valid values
40903 are "none", "reject" and "quarantine".  It is blank when there
40904 is any error, including no DMARC record.
40905 .endlist
40906
40907 . subsection
40908
40909 By default, Exim's DMARC configuration is intended to be
40910 non-intrusive and conservative.  To facilitate this, Exim will not
40911 create any type of logging files without explicit configuration by
40912 you, the admin.  Nor will Exim send out any emails/reports about
40913 DMARC issues without explicit configuration by you, the admin (other
40914 than typical bounce messages that may come about due to ACL
40915 processing or failure delivery issues).
40916
40917 In order to log statistics suitable to be imported by the opendmarc
40918 tools, you need to:
40919 .ilist
40920 Configure the global option &%dmarc_history_file%&
40921 .next
40922 Configure cron jobs to call the appropriate opendmarc history
40923 import scripts and truncating the dmarc_history_file
40924 .endlist
40925
40926 In order to send forensic reports, you need to:
40927 .ilist
40928 Configure the global option &%dmarc_forensic_sender%&
40929 .next
40930 Configure, somewhere before the DATA ACL, the control option to
40931 enable sending DMARC forensic reports
40932 .endlist
40933
40934 . subsection
40935
40936 Example usage:
40937 .code
40938 (RCPT ACL)
40939   warn    domains        = +local_domains
40940           hosts          = +local_hosts
40941           control        = dmarc_disable_verify
40942
40943   warn    !domains       = +screwed_up_dmarc_records
40944           control        = dmarc_enable_forensic
40945
40946   warn    condition      = (lookup if destined to mailing list)
40947           set acl_m_mailing_list = 1
40948
40949 (DATA ACL)
40950   warn    dmarc_status   = accept : none : off
40951           !authenticated = *
40952           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40953
40954   warn    dmarc_status   = !accept
40955           !authenticated = *
40956           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40957
40958   warn    dmarc_status   = quarantine
40959           !authenticated = *
40960           set $acl_m_quarantine = 1
40961           # Do something in a transport with this flag variable
40962
40963   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40964           condition      = ${if eq{$acl_m_mailing_list}{1}}
40965           message        = Messages from $dmarc_used_domain break mailing lists
40966
40967   deny    dmarc_status   = reject
40968           !authenticated = *
40969           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40970
40971   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40972 .endd
40973
40974
40975
40976
40977
40978 . ////////////////////////////////////////////////////////////////////////////
40979 . ////////////////////////////////////////////////////////////////////////////
40980
40981 .chapter "Proxies" "CHAPproxies" &&&
40982          "Proxy support"
40983 .cindex "proxy support"
40984 .cindex "proxy" "access via"
40985
40986 A proxy is an intermediate system through which communication is passed.
40987 Proxies may provide a security, availability or load-distribution function.
40988
40989
40990 .section "Inbound proxies" SECTproxyInbound
40991 .cindex proxy inbound
40992 .cindex proxy "server side"
40993 .cindex proxy "Proxy protocol"
40994 .cindex "Proxy protocol" proxy
40995
40996 Exim has support for receiving inbound SMTP connections via a proxy
40997 that uses &"Proxy Protocol"& to speak to it.
40998 To include this support, include &"SUPPORT_PROXY=yes"&
40999 in Local/Makefile.
41000
41001 It was built on the HAProxy specification, found at
41002 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41003
41004 The purpose of this facility is so that an application load balancer,
41005 such as HAProxy, can sit in front of several Exim servers
41006 to distribute load.
41007 Exim uses the local protocol communication with the proxy to obtain
41008 the remote SMTP system IP address and port information.
41009 There is no logging if a host passes or
41010 fails Proxy Protocol negotiation, but it can easily be determined and
41011 recorded in an ACL (example is below).
41012
41013 Use of a proxy is enabled by setting the &%hosts_proxy%&
41014 main configuration option to a hostlist; connections from these
41015 hosts will use Proxy Protocol.
41016 Exim supports both version 1 and version 2 of the Proxy Protocol and
41017 automatically determines which version is in use.
41018
41019 The Proxy Protocol header is the first data received on a TCP connection
41020 and is inserted before any TLS-on-connect handshake from the client; Exim
41021 negotiates TLS between Exim-as-server and the remote client, not between
41022 Exim and the proxy server.
41023
41024 The following expansion variables are usable
41025 (&"internal"& and &"external"& here refer to the interfaces
41026 of the proxy):
41027 .display
41028 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41029 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41030 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41031 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41032 &'proxy_session            '& boolean: SMTP connection via proxy
41033 .endd
41034 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41035 there was a protocol error.
41036 The variables &$sender_host_address$& and &$sender_host_port$&
41037 will have values for the actual client system, not the proxy.
41038
41039 Since the real connections are all coming from the proxy, and the
41040 per host connection tracking is done before Proxy Protocol is
41041 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41042 handle all of the parallel volume you expect per inbound proxy.
41043 With the option set so high, you lose the ability
41044 to protect your server from many connections from one IP.
41045 In order to prevent your server from overload, you
41046 need to add a per connection ratelimit to your connect ACL.
41047 A possible solution is:
41048 .display
41049   # Set max number of connections per host
41050   LIMIT   = 5
41051   # Or do some kind of IP lookup in a flat file or database
41052   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41053
41054   defer   message        = Too many connections from this IP right now
41055           ratelimit      = LIMIT / 5s / per_conn / strict
41056 .endd
41057
41058
41059
41060 .section "Outbound proxies" SECTproxySOCKS
41061 .cindex proxy outbound
41062 .cindex proxy "client side"
41063 .cindex proxy SOCKS
41064 .cindex SOCKS proxy
41065 Exim has support for sending outbound SMTP via a proxy
41066 using a protocol called SOCKS5 (defined by RFC1928).
41067 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41068 Local/Makefile.
41069
41070 Use of a proxy is enabled by setting the &%socks_proxy%& option
41071 on an smtp transport.
41072 The option value is expanded and should then be a list
41073 (colon-separated by default) of proxy specifiers.
41074 Each proxy specifier is a list
41075 (space-separated by default) where the initial element
41076 is an IP address and any subsequent elements are options.
41077
41078 Options are a string <name>=<value>.
41079 The list of options is in the following table:
41080 .display
41081 &'auth   '& authentication method
41082 &'name   '& authentication username
41083 &'pass   '& authentication password
41084 &'port   '& tcp port
41085 &'tmo    '& connection timeout
41086 &'pri    '& priority
41087 &'weight '& selection bias
41088 .endd
41089
41090 More details on each of these options follows:
41091
41092 .ilist
41093 .cindex authentication "to proxy"
41094 .cindex proxy authentication
41095 &%auth%&: Either &"none"& (default) or &"name"&.
41096 Using &"name"& selects username/password authentication per RFC 1929
41097 for access to the proxy.
41098 Default is &"none"&.
41099 .next
41100 &%name%&: sets the username for the &"name"& authentication method.
41101 Default is empty.
41102 .next
41103 &%pass%&: sets the password for the &"name"& authentication method.
41104 Default is empty.
41105 .next
41106 &%port%&: the TCP port number to use for the connection to the proxy.
41107 Default is 1080.
41108 .next
41109 &%tmo%&: sets a connection timeout in seconds for this proxy.
41110 Default is 5.
41111 .next
41112 &%pri%&: specifies a priority for the proxy within the list,
41113 higher values being tried first.
41114 The default priority is 1.
41115 .next
41116 &%weight%&: specifies a selection bias.
41117 Within a priority set servers are queried in a random fashion,
41118 weighted by this value.
41119 The default value for selection bias is 1.
41120 .endlist
41121
41122 Proxies from the list are tried according to their priority
41123 and weight settings until one responds.  The timeout for the
41124 overall connection applies to the set of proxied attempts.
41125
41126 .section Logging SECTproxyLog
41127 To log the (local) IP of a proxy in the incoming or delivery logline,
41128 add &"+proxy"& to the &%log_selector%& option.
41129 This will add a component tagged with &"PRX="& to the line.
41130
41131 . ////////////////////////////////////////////////////////////////////////////
41132 . ////////////////////////////////////////////////////////////////////////////
41133
41134 .chapter "Internationalisation" "CHAPi18n" &&&
41135          "Internationalisation""
41136 .cindex internationalisation "email address"
41137 .cindex EAI
41138 .cindex i18n
41139 .cindex utf8 "mail name handling"
41140
41141 Exim has support for Internationalised mail names.
41142 To include this it must be built with SUPPORT_I18N and the libidn library.
41143 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41144
41145 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41146 instead of it) then IDNA2008 is supported; this adds an extra library
41147 requirement, upon libidn2.
41148
41149 .section "MTA operations" SECTi18nMTA
41150 .cindex SMTPUTF8 "ESMTP option"
41151 The main configuration option &%smtputf8_advertise_hosts%& specifies
41152 a host list.  If this matches the sending host and
41153 accept_8bitmime is true (the default) then the ESMTP option
41154 SMTPUTF8 will be advertised.
41155
41156 If the sender specifies the SMTPUTF8 option on a MAIL command
41157 international handling for the message is enabled and
41158 the expansion variable &$message_smtputf8$& will have value TRUE.
41159
41160 The option &%allow_utf8_domains%& is set to true for this
41161 message. All DNS lookups are converted to a-label form
41162 whatever the setting of &%allow_utf8_domains%&
41163 when Exim is built with SUPPORT_I18N.
41164
41165 Both localparts and domain are maintained as the original
41166 UTF-8 form internally; any comparison or regular-expression use will
41167 require appropriate care.  Filenames created, eg. by
41168 the appendfile transport, will have UTF-8 names.
41169
41170 HELO names sent by the smtp transport will have any UTF-8
41171 components expanded to a-label form,
41172 and any certificate name checks will be done using the a-label
41173 form of the name.
41174
41175 .cindex log protocol
41176 .cindex SMTPUTF8 logging
41177 .cindex i18n logging
41178 Log lines and Received-by: header lines will acquire a "utf8"
41179 prefix on the protocol element, eg. utf8esmtp.
41180
41181 The following expansion operators can be used:
41182 .code
41183 ${utf8_domain_to_alabel:str}
41184 ${utf8_domain_from_alabel:str}
41185 ${utf8_localpart_to_alabel:str}
41186 ${utf8_localpart_from_alabel:str}
41187 .endd
41188
41189 .cindex utf8 "address downconversion"
41190 .cindex i18n "utf8 address downconversion"
41191 The RCPT ACL
41192 may use the following modifier:
41193 .display
41194 control = utf8_downconvert
41195 control = utf8_downconvert/<value>
41196 .endd
41197 This sets a flag requiring that addresses are converted to
41198 a-label form before smtp delivery, for use in a
41199 Message Submission Agent context.
41200 If a value is appended it may be:
41201 .display
41202 &`1  `& (default) mandatory downconversion
41203 &`0  `& no downconversion
41204 &`-1 `& if SMTPUTF8 not supported by destination host
41205 .endd
41206
41207 If mua_wrapper is set, the utf8_downconvert control
41208 is initially set to -1.
41209
41210 The smtp transport has an option &%utf8_downconvert%&.
41211 If set it must expand to one of the three values described above,
41212 and it overrides any previously set value.
41213
41214
41215 There is no explicit support for VRFY and EXPN.
41216 Configurations supporting these should inspect
41217 &$smtp_command_argument$& for an SMTPUTF8 argument.
41218
41219 There is no support for LMTP on Unix sockets.
41220 Using the "lmtp" protocol option on an smtp transport,
41221 for LMTP over TCP, should work as expected.
41222
41223 There is no support for DSN unitext handling,
41224 and no provision for converting logging from or to UTF-8.
41225
41226
41227
41228 .section "MDA operations" SECTi18nMDA
41229 To aid in constructing names suitable for IMAP folders
41230 the following expansion operator can be used:
41231 .code
41232 ${imapfolder {<string>} {<sep>} {<specials>}}
41233 .endd
41234
41235 The string is converted from the charset specified by
41236 the "headers charset" command (in a filter file)
41237 or &%headers_charset%& main configuration option (otherwise),
41238 to the
41239 modified UTF-7 encoding specified by RFC 2060,
41240 with the following exception: All occurrences of <sep>
41241 (which has to be a single character)
41242 are replaced with periods ("."), and all periods and slashes that are not
41243 <sep> and are not in the <specials> string are BASE64 encoded.
41244
41245 The third argument can be omitted, defaulting to an empty string.
41246 The second argument can be omitted, defaulting to "/".
41247
41248 This is the encoding used by Courier for Maildir names on disk, and followed
41249 by many other IMAP servers.
41250
41251 Examples:
41252 .display
41253 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41254 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41255 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41256 .endd
41257
41258 Note that the source charset setting is vital, and also that characters
41259 must be representable in UTF-16.
41260
41261
41262 . ////////////////////////////////////////////////////////////////////////////
41263 . ////////////////////////////////////////////////////////////////////////////
41264
41265 .chapter "Events" "CHAPevents" &&&
41266          "Events"
41267 .cindex events
41268
41269 The events mechanism in Exim can be used to intercept processing at a number
41270 of points.  It was originally invented to give a way to do customised logging
41271 actions (for example, to a database) but can also be used to modify some
41272 processing actions.
41273
41274 Most installations will never need to use Events.
41275 The support can be left out of a build by defining DISABLE_EVENT=yes
41276 in &_Local/Makefile_&.
41277
41278 There are two major classes of events: main and transport.
41279 The main configuration option &%event_action%& controls reception events;
41280 a transport option &%event_action%& controls delivery events.
41281
41282 Both options are a string which is expanded when the event fires.
41283 An example might look like:
41284 .cindex logging custom
41285 .code
41286 event_action = ${if eq {msg:delivery}{$event_name} \
41287 {${lookup pgsql {SELECT * FROM record_Delivery( \
41288     '${quote_pgsql:$sender_address_domain}',\
41289     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41290     '${quote_pgsql:$domain}', \
41291     '${quote_pgsql:${lc:$local_part}}', \
41292     '${quote_pgsql:$host_address}', \
41293     '${quote_pgsql:${lc:$host}}', \
41294     '${quote_pgsql:$message_exim_id}')}} \
41295 } {}}
41296 .endd
41297
41298 Events have names which correspond to the point in process at which they fire.
41299 The name is placed in the variable &$event_name$& and the event action
41300 expansion must check this, as it will be called for every possible event type.
41301
41302 .new
41303 The current list of events is:
41304 .wen
41305 .display
41306 &`dane:fail              after    transport  `& per connection
41307 &`msg:complete           after    main       `& per message
41308 &`msg:defer              after    transport  `& per message per delivery try
41309 &`msg:delivery           after    transport  `& per recipient
41310 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41311 &`msg:rcpt:defer         after    transport  `& per recipient
41312 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41313 &`msg:fail:delivery      after    transport  `& per recipient
41314 &`msg:fail:internal      after    main       `& per recipient
41315 &`tcp:connect            before   transport  `& per connection
41316 &`tcp:close              after    transport  `& per connection
41317 &`tls:cert               before   both       `& per certificate in verification chain
41318 &`smtp:connect           after    transport  `& per connection
41319 &`smtp:ehlo              after    transport  `& per connection
41320 .endd
41321 New event types may be added in future.
41322
41323 The event name is a colon-separated list, defining the type of
41324 event in a tree of possibilities.  It may be used as a list
41325 or just matched on as a whole.  There will be no spaces in the name.
41326
41327 The second column in the table above describes whether the event fires
41328 before or after the action is associates with.  Those which fire before
41329 can be used to affect that action (more on this below).
41330
41331 The third column in the table above says what section of the configuration
41332 should define the event action.
41333
41334 An additional variable, &$event_data$&, is filled with information varying
41335 with the event type:
41336 .display
41337 &`dane:fail            `& failure reason
41338 &`msg:defer            `& error string
41339 &`msg:delivery         `& smtp confirmation message
41340 &`msg:fail:internal    `& failure reason
41341 &`msg:fail:delivery    `& smtp error message
41342 &`msg:host:defer       `& error string
41343 &`msg:rcpt:host:defer  `& error string
41344 &`msg:rcpt:defer       `& error string
41345 &`tls:cert             `& verification chain depth
41346 &`smtp:connect         `& smtp banner
41347 &`smtp:ehlo            `& smtp ehlo response
41348 .endd
41349
41350 The :defer events populate one extra variable: &$event_defer_errno$&.
41351
41352 For complex operations an ACL expansion can be used in &%event_action%&
41353 however due to the multiple contexts that Exim operates in during
41354 the course of its processing:
41355 .ilist
41356 variables set in transport events will not be visible outside that
41357 transport call
41358 .next
41359 acl_m variables in a server context are lost on a new connection,
41360 and after smtp helo/ehlo/mail/starttls/rset commands
41361 .endlist
41362 Using an ACL expansion with the logwrite modifier can be
41363 a useful way of writing to the main log.
41364
41365 The expansion of the event_action option should normally
41366 return an empty string.  Should it return anything else the
41367 following will be forced:
41368 .display
41369 &`tcp:connect      `&  do not connect
41370 &`tls:cert         `&  refuse verification
41371 &`smtp:connect     `&  close connection
41372 .endd
41373 All other message types ignore the result string, and
41374 no other use is made of it.
41375
41376 For a tcp:connect event, if the connection is being made to a proxy
41377 then the address and port variables will be that of the proxy and not
41378 the target system.
41379
41380 For tls:cert events, if GnuTLS is in use this will trigger only per
41381 chain element received on the connection.
41382 For OpenSSL it will trigger for every chain element including those
41383 loaded locally.
41384
41385 . ////////////////////////////////////////////////////////////////////////////
41386 . ////////////////////////////////////////////////////////////////////////////
41387
41388 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41389          "Adding drivers or lookups"
41390 .cindex "adding drivers"
41391 .cindex "new drivers, adding"
41392 .cindex "drivers" "adding new"
41393 The following actions have to be taken in order to add a new router, transport,
41394 authenticator, or lookup type to Exim:
41395
41396 .olist
41397 Choose a name for the driver or lookup type that does not conflict with any
41398 existing name; I will use &"newdriver"& in what follows.
41399 .next
41400 Add to &_src/EDITME_& the line:
41401 .display
41402 <&'type'&>&`_NEWDRIVER=yes`&
41403 .endd
41404 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41405 code is not to be included in the binary by default, comment this line out. You
41406 should also add any relevant comments about the driver or lookup type.
41407 .next
41408 Add to &_src/config.h.defaults_& the line:
41409 .code
41410 #define <type>_NEWDRIVER
41411 .endd
41412 .next
41413 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41414 and create a table entry as is done for all the other drivers and lookup types.
41415 .next
41416 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41417 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41418 Add your &`NEWDRIVER`& to that list.
41419 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41420 simple form that most lookups have.
41421 .next
41422 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41423 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41424 driver or lookup type and add it to the definition of OBJ.
41425 .next
41426 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41427 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41428 .next
41429 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41430 &_src_&.
41431 .next
41432 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41433 as for other drivers and lookups.
41434 .endlist
41435
41436 Then all you need to do is write the code! A good way to start is to make a
41437 proforma by copying an existing module of the same type, globally changing all
41438 occurrences of the name, and cutting out most of the code. Note that any
41439 options you create must be listed in alphabetical order, because the tables are
41440 searched using a binary chop procedure.
41441
41442 There is a &_README_& file in each of the sub-directories of &_src_& describing
41443 the interface that is expected.
41444
41445
41446
41447
41448 . ////////////////////////////////////////////////////////////////////////////
41449 . ////////////////////////////////////////////////////////////////////////////
41450
41451 . /////////////////////////////////////////////////////////////////////////////
41452 . These lines are processing instructions for the Simple DocBook Processor that
41453 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41454 . PDFs than using xmlto and fop. They will be ignored by all other XML
41455 . processors.
41456 . /////////////////////////////////////////////////////////////////////////////
41457
41458 .literal xml
41459 <?sdop
41460   format="newpage"
41461   foot_right_recto="&chaptertitle;"
41462   foot_right_verso="&chaptertitle;"
41463 ?>
41464 .literal off
41465
41466 .makeindex "Options index"   "option"
41467 .makeindex "Variables index" "variable"
41468 .makeindex "Concept index"   "concept"
41469
41470
41471 . /////////////////////////////////////////////////////////////////////////////
41472 . /////////////////////////////////////////////////////////////////////////////